]> Sergey Matveev's repositories - gerrvim.git/blob - doc/gerrvim.txt
Initial revision
[gerrvim.git] / doc / gerrvim.txt
1 *gerrvim.txt*  Gerrit review's comments preparation helper
2
3 CONFIGURATION                                    *gerrvim-configuration*
4
5 The only option is the placement of temporary file with aggregated
6 comments. By default it is /tmp/gerrvim.txt. You can override it
7 in your .vimrc: >
8     let g:gerrvim_file = "/another/path.txt"
9
10 USAGE                                                          *gerrvim*
11
12 * Open necessary commit using Fugitive (:Gedit) and file inside it
13 * Visually select a bunch of code lines you want to comment
14 * Press <Leader>cc (usually "\cc") or call :Gerrvim command
15   specifying the range
16 * You will see an additional small window with your code
17 * Add necessary comment message below -----END----- line
18 * Either press <CR> in normal mode, or save buffer and exit
19 * Comment window will be closed, saving your consolidated changes
20   in temporary file
21 * To wipe out all your comments type :GerrvimClear (or remove that
22   temporary file)
23
24 Copied original text (that is between BEGIN and END line) won't be
25 published in Gerrit. It exists just for your convenience.
26
27 LICENCE                                                *gerrvim-license*
28
29 Copyright (C) 2015 Sergey Matveev <stargrave@stargrave.org>
30
31 This program is free software: you can redistribute it and/or modify
32 it under the terms of the GNU General Public License as published by
33 the Free Software Foundation, either version 3 of the License, or
34 any later version.
35
36 This program is distributed in the hope that it will be useful,
37 but WITHOUT ANY WARRANTY; without even the implied warranty of
38 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
39 GNU General Public License for more details.
40
41 You should have received a copy of the GNU General Public License
42 along with this program.  If not, see <http://www.gnu.org/licenses/>.
43
44  vim:filetype=help