path: root/Documentation/git-ls-files.txt
diff options
authorJonas Fonseca <>2005-10-03 17:16:30 (GMT)
committerJunio C Hamano <>2005-10-03 20:23:47 (GMT)
commitdf8baa42fe4eeb5a021ac262caf601f44d2a5746 (patch)
treea2e2c531e7e2718451f8357902ba3bdcc6571804 /Documentation/git-ls-files.txt
parent5a82b4fb3e547c4aa14cd417790b3f925713a422 (diff)
[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 <>
Diffstat (limited to 'Documentation/git-ls-files.txt')
1 files changed, 11 insertions, 9 deletions
diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
index 87cc362..940285f 100644
--- a/Documentation/git-ls-files.txt
+++ b/Documentation/git-ls-files.txt
@@ -70,11 +70,11 @@ OPTIONS
Identify the file status with the following tags (followed by
a space) at the start of each line:
- H cached
- M unmerged
- R removed/deleted
- C modifed/changed
- K to be killed
+ H:: cached
+ M:: unmerged
+ R:: removed/deleted
+ C:: modifed/changed
+ K:: to be killed
? other
@@ -110,13 +110,13 @@ flags --others or --ignored are specified.
These exclude patterns come from these places:
- (1) command line flag --exclude=<pattern> specifies a single
+ 1. command line flag --exclude=<pattern> specifies a single
- (2) command line flag --exclude-from=<file> specifies a list of
+ 2. command line flag --exclude-from=<file> specifies a list of
patterns stored in a file.
- (3) command line flag --exclude-per-directory=<name> specifies
+ 3. command line flag --exclude-per-directory=<name> specifies
a name of the file in each directory 'git-ls-files'
examines, and if exists, its contents are used as an
additional list of patterns.
@@ -168,12 +168,13 @@ An exclude pattern is of the following format:
- otherwise, it is a shell glob pattern, suitable for
consumption by fnmatch(3) with FNM_PATHNAME flag. I.e. a
slash in the pattern must match a slash in the pathname.
- "Documentation/*.html" matches "Documentation/git.html" but
+ "Documentation/\*.html" matches "Documentation/git.html" but
not "ppc/ppc.html". As a natural exception, "/*.c" matches
"cat-file.c" but not "mozilla-sha1/sha1.c".
An example:
$ cat .git/ignore
# ignore objects and archives, anywhere in the tree.
@@ -186,6 +187,7 @@ An example:
--exclude='Documentation/*.[0-9]' \
--exclude-from=.git/ignore \
See Also