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/cvs-migration.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/cvs-migration.txt')
-rw-r--r-- | Documentation/cvs-migration.txt | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/cvs-migration.txt b/Documentation/cvs-migration.txt index 390a72392..7c4dbef00 100644 --- a/Documentation/cvs-migration.txt +++ b/Documentation/cvs-migration.txt @@ -229,10 +229,10 @@ does rename or copy would not show in the output, and if the "o-file.c", it would find the commit that changed the statement when it was in "o-file.c". -[ BTW, the current versions of "git-diff-tree -C" is not eager +NOTE: The current versions of "git-diff-tree -C" is not eager enough to find copies, and it will miss the fact that a-file.c was created by copying o-file.c unless o-file.c was somehow - changed in the same commit.] + changed in the same commit. You can use the --pickaxe-all flag in addition to the -S flag. This causes the differences from all the files contained in @@ -243,6 +243,6 @@ that contain this changed "if" statement: nitfol(); }' --pickaxe-all -[ Side note. This option is called "--pickaxe-all" because -S +NOTE: This option is called "--pickaxe-all" because -S option is internally called "pickaxe", a tool for software - archaeologists.] + archaeologists. |