doc/codecomm.txt

   1 *codecomm.txt*  Code comments preparation helper
   2
   3 OVERVIEW                                              *codecomm-overview*
   4
   5 Sometimes you need to comment some software source code and send it via
   6 email. How do you reference to commit, filepath and exact lines in the
   7 code there? This plugin helps you to do that.
   8
   9 CONFIGURATION                                           *codecomm-config*
  10
  11 The only option for the Vim plugin is the placement of temporary file
  12 with aggregated comments. By default it is /tmp/codecomm.txt.
  13 You can override /tmp with $TMPDIR environment variable and the whole
  14 file path with: >
  15     let g:codecomm_txt = "/another/path.txt"
  16     let g:codecomm_ctr = "/another/path.ctr"
  17
  18 PLUGIN USAGE                                             *codecomm-usage*
  19
  20 * Open necessary commit using Fugitive (:Gedit) and file inside it.
  21   If you won't use Fugitive, then commit hash won't be set in the
  22   message, but everything should work the same way anyway
  23 * Visually select a bunch of code lines you want to comment
  24 * Press <Leader>cc or call :{range}CodeComm command
  25 * You will see an additional window with your selection
  26 * Add necessary comment message below ----- >8 ----- line
  27 * Save buffer and exit
  28 * Comment window will be closed, saving your consolidated changes
  29   in g:codecomm_file
  30 * To wipe out all your comments you can call :CodeCommClear
  31 * To edit comments you can call :CodeCommEdit
  32
  33 CODECOMM FILE FORMAT                                     *codecomm-format*
  34 >
  35     -----# 2 [                            ec77b1f6b | src/pyderasn.py ]-----
  36       79 def tag_encode(num, klass=TagClass.universal, form=TagForm.primitive):
  37       80     if num < 31:
  38       81         # [XX|X|.....]
  39       82         return int2byte(klass.value | form.value | num)
  40       83     # [XX|X|11111][1.......][1.......] ... [0.......]
  41       84     return int2byte(klass.value | form.value | 31) + ...
  42       85
  43     ---------------------------------- >8 ----------------------------------
  44     Here goes my comment.
  45
  46 Header contains:
  47
  48 * Comment's number (#2 in example above)
  49 * Optional commit's hash (ec77b1f6b)
  50 * Full path to commented file inside repository
  51
  52 LICENCE                                                *codecomm-license*
  53
  54 Copyright (C) 2017-2024 Sergey Matveev <stargrave@stargrave.org>
  55
  56 This program is free software: you can redistribute it and/or modify
  57 it under the terms of the GNU General Public License as published by
  58 the Free Software Foundation, version 3 of the License.
  59
  60 This program is distributed in the hope that it will be useful,
  61 but WITHOUT ANY WARRANTY; without even the implied warranty of
  62 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  63 GNU General Public License for more details.
  64
  65 You should have received a copy of the GNU General Public License
  66 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  67
  68  vim: filetype=help