diff options
| author | Jonas Fonseca <fonseca@diku.dk> | 2005-10-03 19:16:30 +0200 |
|---|---|---|
| committer | Junio C Hamano <junkio@cox.net> | 2005-10-03 13:23:47 -0700 |
| commit | df8baa42fe4eeb5a021ac262caf601f44d2a5746 (patch) | |
| tree | a2e2c531e7e2718451f8357902ba3bdcc6571804 /Documentation/git-sh-setup.txt | |
| parent | 5a82b4fb3e547c4aa14cd417790b3f925713a422 (diff) | |
| download | git-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-sh-setup.txt')
| -rw-r--r-- | Documentation/git-sh-setup.txt | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt index a02a2b051..6ef59acf5 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 ------ |