branch: externals/cm-mode
commit ecb35ab717e03336ebbc031c6f171158026e525c
Author: Joost Kremers <[email protected]>
Commit: Joost Kremers <[email protected]>
Modify section on auto-comment in the README.
---
README.md | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index cf3ed89de8..d697463789 100644
--- a/README.md
+++ b/README.md
@@ -27,9 +27,11 @@ The commands to delete or substitute text operate on the
region. The command to
## Automaticaly adding comments ##
-If you set the variable `cm-auto-comment` to a string, this string is
automatically added to every change as a comment. If you explicitly make a
comment with `C-c * c`, this string is inserted at the beginning of the comment
followed by a colon and a space. You can use this to keep track of who makes a
certain change, for example.
+If you want to automatically add a comment to every change you make, for
example to keep track of who made the change, you can set the variable
`cm-auto-comment` to the desired text. (Don't include the comment markup
itself.) Once set, every change is automatically commented. If you explicitly
make a comment with `C-c * c`, the value of `cm-auto-comment` is inserted at
the beginning of the comment followed by a colon and a space.
-The variable `cm-auto-comment` can be set globally through Customize (or with
`setq-default`), or buffer-locally. The latter can be done interactively, with
`C-c * C`, or by using a file-local variable.
+The variable `cm-auto-comment` can be set globally through Customize (or with
`setq-default` in your init file). This sets the global value, but each buffer
can have a buffer-local value as well. You can set a buffer-local value with
`C-c * C`, in which case the value is not permanent: when you kill the buffer
(or reload the file it's visiting), the value is reset to the global value.
+
+Alternatively, you can use a file-local or directory-local variable to set
`cm-auto-comment`. This will make the value permanent for the relevant file(s).
(Note: if you use [Pandoc](http://johnmacfarlane.net/pandoc/), you can specify
file-local variables with html comments, since Pandoc ignores html comments for
any output format.)
## Navigating changes ##
