X-Git-Url: http://www.git.stargrave.org/?p=codecomm.git;a=blobdiff_plain;f=doc%2Fcodecomm.txt;h=6fadb8554d63e4be44a328a670d40691525c13c1;hp=78427f7ff9b34bec77620f1b3f5ed0d6654c542d;hb=HEAD;hpb=b39798f8579bb2abd625bc5eed87d71fea1bc169

diff --git a/doc/codecomm.txt b/doc/codecomm.txt
index 78427f7..4fbb2c0 100644
--- a/doc/codecomm.txt
+++ b/doc/codecomm.txt
@@ -9,23 +9,26 @@ code there? This plugin helps you to do that.
 CONFIGURATION                                           *codecomm-config*
 
 The only option for the Vim plugin is the placement of temporary file
-with aggregated comments. By default it is /tmp/codecomm.txt. You can
-override it in your .vimrc: >
-    let g:codecomm_file = "/another/path.txt"
+with aggregated comments. By default it is /tmp/codecomm.txt.
+You can override /tmp with $TMPDIR environment variable and the whole
+file path with: >
+    let g:codecomm_txt = "/another/path.txt"
+    let g:codecomm_ctr = "/another/path.ctr"
 
 PLUGIN USAGE                                             *codecomm-usage*
 
-* Open necessary commit using Fugitive (:Gedit) and file inside it
+* Open necessary commit using Fugitive (:Gedit) and file inside it.
+  If you won't use Fugitive, then commit hash won't be set in the
+  message, but everything should work the same way anyway
 * Visually select a bunch of code lines you want to comment
-* Press <Leader>cc (usually "\cc") or call :CodeComm command
-  specifying the range
-* You will see an additional window with your code
+* Press <Leader>cc or call :{range}CodeComm command
+* You will see an additional window with your selection
 * Add necessary comment message below ----- >8 ----- line
-* Either press <CR> in normal mode, or save buffer and exit
+* Save buffer and exit
 * Comment window will be closed, saving your consolidated changes
-  in temporary file
-* To wipe out all your comments either call :CodeCommClear or remove
-  that temporary file)
+  in g:codecomm_file
+* To wipe out all your comments you can call :CodeCommClear
+* To edit comments you can call :CodeCommEdit
 
 CODECOMM FILE FORMAT                                     *codecomm-format*
 >
@@ -40,20 +43,19 @@ CODECOMM FILE FORMAT                                     *codecomm-format*
     ---------------------------------- >8 ----------------------------------
     Here goes my comment.
 
-Header line contains:
+Header contains:
 
-* Comment's serial number (#2 in example above)
+* Comment's number (#2 in example above)
 * Optional commit's hash (ec77b1f6b)
 * Full path to commented file inside repository
 
 LICENCE                                                *codecomm-license*
 
-Copyright (C) 2017-2018 Sergey Matveev <stargrave@stargrave.org>
+Copyright (C) 2017-2024 Sergey Matveev <stargrave@stargrave.org>
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-any later version.
+the Free Software Foundation, version 3 of the License.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -63,4 +65,4 @@ GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
- vim:filetype=help
+ vim: filetype=help