branch: externals/cm-mode
commit 7ead43cd716643dd730f47d76274cb20dce76076
Author: Joost Kremers <[email protected]>
Commit: Joost Kremers <[email protected]>
Update section on follow changes mode in the README.
---
README.md | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 231f80c39d..cb85f536b3 100644
--- a/README.md
+++ b/README.md
@@ -22,14 +22,15 @@ The commands to delete or substitute text operate on the
region. The command to
## Follow changes mode ##
-`cm-mode` also provides a (rudimentary) 'follow changes' mode. When activated,
changes you make to the buffer are automatically marked as insertions or
deletions. Substitutions cannot be made automatically (that is, if you mark a
word, delete it and then type a replacement, it will still be marked as
sequence of deletion+insertion, not as a substitution), but they can still be
made manually with `C-c * s`. You can activate and deactivate follow changes
mode with `C-c * F`. When it's ac [...]
+`cm-mode` also provides a simple 'follow changes' mode. When activated,
changes you make to the buffer are automatically marked as insertions or
deletions. Substitutions cannot be made automatically (that is, if you mark a
word, delete it and then type a replacement, it will still be marked as
sequence of deletion+insertion, not as a substitution), but they can still be
made manually with `C-c * s`. You can activate and deactivate follow changes
mode with `C-c * F`. When it's active, the [...]
+
+Follow changes mode should be considered experimental, so try at your own
risk. If you run into problems, open an issue on Github or send me an email.
-Note that this functionality is in development and not very polished yet.
Multiple deletions in sequence, for example, are not combined, so that deleting
a word with `<backspace>` leaves a string of deletion markups. Deleting a
character with `<del>` also leaves the cursor in the wrong position. Follow
changes mode should also be considered alpha-grade, i.e., it works to the
extent that it works. (If you experience problems with it, please open up an
issue on Github or send me an email.)
## Accepting or rejecting changes ##
-One can interactively accept or reject a change by putting the cursor inside
it and hitting `C-c * i`. For additions, deletions and substitutions, you get a
choice between `a` to accept the change or `r` to reject it. There are two
other choices, `s` to skip this change or `q` to quit. Both leave the change
untouched and if you're just dealing with the change at point, they are
essentially identical. {>>(They have different functions when accepting or
rejecting all changes interactively, [...]
+One can interactively accept or reject a change by putting the cursor inside
it and hitting `C-c * i`. For additions, deletions and substitutions, you get a
choice between `a` to accept the change or `r` to reject it. There are two
other choices, `s` to skip this change or `q` to quit. Both leave the change
untouched and if you're just dealing with the change at point, they are
essentially identical. {>>They have different functions when accepting or
rejecting all changes interactively, [...]
For comments and highlights, the choices are different: `d` to delete the
comment or highlight (whereby the latter of course retains the highlighted
text, but the comment and the markup are removed), or `k` to keep the comment
or highlight. Again `q` quits and is essentially identical to `k`. (Note that
you can also use `s` instead of `k`, in case you get used to skipping changes
that way.)
