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-diff-index.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-diff-index.txt')
| -rw-r--r-- | Documentation/git-diff-index.txt | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/git-diff-index.txt b/Documentation/git-diff-index.txt index 56ed673ed..8b6a953c0 100644 --- a/Documentation/git-diff-index.txt +++ b/Documentation/git-diff-index.txt @@ -86,8 +86,8 @@ the more useful of the two in that what it does can't be emulated with a "git-write-tree" + "git-diff-tree". Thus that's the default mode. The non-cached version asks the question: - show me the differences between HEAD and the currently checked out - tree - index contents _and_ files that aren't up-to-date + show me the differences between HEAD and the currently checked out + tree - index contents _and_ files that aren't up-to-date which is obviously a very useful question too, since that tells you what you *could* commit. Again, the output matches the "git-diff-tree -r" @@ -107,13 +107,13 @@ not up-to-date and may contain new stuff. The all-zero sha1 means that to get the real diff, you need to look at the object in the working directory directly rather than do an object-to-object diff. -NOTE! As with other commands of this type, "git-diff-index" does not +NOTE: As with other commands of this type, "git-diff-index" does not actually look at the contents of the file at all. So maybe `kernel/sched.c` hasn't actually changed, and it's just that you touched it. In either case, it's a note that you need to "git-upate-cache" it to make the cache be in sync. -NOTE 2! You can have a mixture of files show up as "has been updated" +NOTE: You can have a mixture of files show up as "has been updated" and "is still dirty in the working directory" together. You can always tell which file is in which state, since the "has been updated" ones show a valid sha1, and the "not in sync with the index" ones will |