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-sh-setup.txt | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'Documentation/git-sh-setup.txt') diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt index a02a2b051c..6ef59acf50 100644 --- a/Documentation/git-sh-setup.txt +++ b/Documentation/git-sh-setup.txt @@ -14,11 +14,12 @@ DESCRIPTION Sets up the normal git environment variables and a few helper functions (currently just "die()"), and returns ok if it all looks like a git archive. -So use it something like +So, to make the rest of the git scripts more careful and readable, +use it as follows: - . git-sh-setup || die "Not a git archive" - -to make the rest of the git scripts more careful and readable. +------------------------------------------------- +. git-sh-setup || die "Not a git archive" +------------------------------------------------- Author ------ -- cgit v1.2.3