aboutsummaryrefslogtreecommitdiff
path: root/Documentation/git-var.txt
diff options
context:
space:
mode:
authorJonas Fonseca <fonseca@diku.dk>2005-10-03 19:16:30 +0200
committerJunio C Hamano <junkio@cox.net>2005-10-03 13:23:47 -0700
commitdf8baa42fe4eeb5a021ac262caf601f44d2a5746 (patch)
treea2e2c531e7e2718451f8357902ba3bdcc6571804 /Documentation/git-var.txt
parent5a82b4fb3e547c4aa14cd417790b3f925713a422 (diff)
downloadgit-df8baa42fe4eeb5a021ac262caf601f44d2a5746.tar.gz
git-df8baa42fe4eeb5a021ac262caf601f44d2a5746.tar.xz
[PATCH] Random documentation fixes
The fixes focuses on improving the HTML output. Most noteworthy: - Fix the Makefile to also make various *.html files depend on included files. - Consistently use 'NOTE: ...' instead of '[ ... ]' for additional info. - Fix ending '::' for description lists in OPTION section etc. - Fix paragraphs in description lists ending up as preformated text. - Always use listingblocks (preformatted text wrapped in lines with -----) for examples that span empty lines, so they are put in only one HTML block. - Use '1.' instead of '(1)' for numbered lists. - Fix linking to other GIT docs. - git-rev-list.txt: put option descriptions in an OPTION section. Signed-off-by: Jonas Fonseca <fonseca@diku.dk> Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/git-var.txt')
-rw-r--r--Documentation/git-var.txt14
1 files changed, 8 insertions, 6 deletions
diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt
index 31f80a8b3..c1c717208 100644
--- a/Documentation/git-var.txt
+++ b/Documentation/git-var.txt
@@ -15,21 +15,23 @@ DESCRIPTION
-----------
Prints a git logical variable.
--l causes the logical variables to be listed.
+OPTIONS
+-------
+-l::
+ Cause the logical variables to be listed.
EXAMPLE
--------
-$git-var GIT_AUTHOR_IDENT
-
-Eric W. Biederman <ebiederm@lnxi.com> 1121223278 -0600
+ $ git-var GIT_AUTHOR_IDENT
+ Eric W. Biederman <ebiederm@lnxi.com> 1121223278 -0600
VARIABLES
----------
-GIT_AUTHOR_IDENT
+GIT_AUTHOR_IDENT::
The author of a piece of code.
-GIT_COMMITTER_IDENT
+GIT_COMMITTER_IDENT::
The person who put a piece of code into git.
Diagnostics