branch: externals/cm-mode
commit f0bba0b459adc79ba0f68ca420e119482e9cbc83
Author: Joost Kremers <[email protected]>
Commit: Joost Kremers <[email protected]>
Add section on accepting and rejecting changes to the README
---
README.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/README.md b/README.md
index 9045fda198..c9f1c4811c 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,15 @@ Activating `cm-mode` provides key{--s--} {++bindings++}to
insert the {~~patterns
The commands to delete, substitute and highlight text all operate on the
region. The commands for inserting and substituting text and for inserting a
comment {{(which includes the command to highlight text)}}{>>really!<<} all put
the cursor at the correct position, so you can start typing right away.
+## Accepting or rejecting changes ##
+
+You can accept or reject a change by putting the cursor inside it and hitting
`C-c * a`. For insertions, 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, though.)
+
+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.)
+
+Not implemented yet is the ability to go through all changes in a buffer and
accept or reject them one by one, nor the ability to accept or reject all
changes all at once.
+
+
## Font lock ##
`cm-mode` also adds the markup patterns defined by CriticMarkup to
`font-lock-keywords` and provides customisable faces to highlight them. The
customisation group is called `criticmarkup`.
@@ -36,4 +45,5 @@ To mitigate this problem, you can use soft wrap (with
`visual-line-mode`). Since
## TODO ##
- Command to accept or reject all changes interactively (`C-c * A`)
+- Commands to accept or reject all changes in one go
- Mouse support
