summaryrefslogtreecommitdiffstats
path: root/contrib/cvs/doc/HACKING.DOCS
diff options
context:
space:
mode:
authorpeter <peter@FreeBSD.org>2002-12-02 03:13:37 +0000
committerpeter <peter@FreeBSD.org>2002-12-02 03:13:37 +0000
commit3dc96f7243ece1d1f7f87b03334f840415e0db63 (patch)
tree15f00bd8ebd718713d8c0a8707ebebfced99c550 /contrib/cvs/doc/HACKING.DOCS
parentcf46dfb750863d760d19b9858b0a336b158275da (diff)
downloadFreeBSD-src-3dc96f7243ece1d1f7f87b03334f840415e0db63.zip
FreeBSD-src-3dc96f7243ece1d1f7f87b03334f840415e0db63.tar.gz
Import cvs-1.11.2.1 as of 2002/12/01 onto vendor branch. This fixes all
of the bugs that I know of. We've been running a slightly older version of this on freefall/repoman, where it was afflicted by a silly merge error on my part (fixed). Approved by: re
Diffstat (limited to 'contrib/cvs/doc/HACKING.DOCS')
-rw-r--r--contrib/cvs/doc/HACKING.DOCS37
1 files changed, 37 insertions, 0 deletions
diff --git a/contrib/cvs/doc/HACKING.DOCS b/contrib/cvs/doc/HACKING.DOCS
new file mode 100644
index 0000000..079522e
--- /dev/null
+++ b/contrib/cvs/doc/HACKING.DOCS
@@ -0,0 +1,37 @@
+Here's some of the texinfo conventions the CVS documentation uses:
+
+@code{ ... } command usage & command snippets, including
+ command names.
+@var{ ... } variables - text which the user is expected to
+ replace with some meaningful text of their own
+ in actual usage.
+@file{ ... } file names
+@samp{ ... } for most anything else you need quotes around
+ (often still misused for command snippets)
+@example ... @end example example command usage and output, etc.
+@emph{ ... } emphasis - warnings, stress, etc. This will be
+ bracketed by underline characters in info files
+ (_ ... _) and in italics in PDF & probably in
+ postscript & HTML.
+@noindent Suppresses indentation of the following
+ paragraph. This can ocassionally be useful
+ after examples and the like.
+@cindex ... Add a tag to the index.
+@pxref{ ... } Cross reference in parentheses.
+@xref{ ... } Cross reference.
+
+Preformatted text should be marked as such (use @example... there may be other
+ways) since many of the final output formats can use relational fonts otherwise
+and marking it as formatted should restrict it to a fixed wiidth font. Keep
+this sort of text to 80 characters or less per line since larger may not be
+properly viewable for some info users.
+
+There are dictionary lists and function definition markers. Scan cvs.texinfo
+for their usage. There may be table definitions as well but I haven't used
+them.
+
+Use lots of index markers. Scan the index for the current style. Try to reuse
+an existing entry if the meaning is similar.
+
+For more on using texinfo docs, see the `info texinfo' documentation or
+http://www.gnu.org/manual/texinfo/texinfo.html .
OpenPOWER on IntegriCloud