From df8baa42fe4eeb5a021ac262caf601f44d2a5746 Mon Sep 17 00:00:00 2001 From: Jonas Fonseca Date: Mon, 3 Oct 2005 19:16:30 +0200 Subject: [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 Signed-off-by: Junio C Hamano --- Documentation/git-var.txt | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) (limited to 'Documentation/git-var.txt') diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt index 31f80a8b30..c1c7172088 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 1121223278 -0600 + $ git-var GIT_AUTHOR_IDENT + Eric W. Biederman 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 -- cgit v1.2.1