@matheusbsbs / matheus-bagliano / commits / 2099bca9ed
Fork 0

git-status: documentation improvements

This patch is the result of reading over git-status with an editorial eye: - fix a few typo/grammatical errors - mention untracked output - present output types in the order they appear from the command Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Jeff King committed Dec 8, 2007 at 04:00 UTC 2099bca9ed06a4cb7ab0b8ca38bc90df5632ba41
1 file changed +13 -12
Documentation/git-status.txt
+13 -12
@@ -12,21 +12,22 @@ SYNOPSIS
12
13 DESCRIPTION
14 -----------
15 -Examines paths in the working tree that has changes unrecorded
16 -to the index file, and changes between the index file and the
17 -current HEAD commit. The former paths are what you _could_
18 -commit by running 'git add' before running 'git
19 -commit', and the latter paths are what you _would_ commit by
20 -running 'git commit'.
21 -
22 -If there is no path that is different between the index file and
23 -the current HEAD commit, the command exits with non-zero
24 -status.
15 +Displays paths that have differences between the index file and the
16 +current HEAD commit, paths that have differences between the working
17 +tree and the index file, and paths in the working tree that are not
18 +tracked by git (and are not ignored by gitlink:gitignore[5]). The first
19 +are what you _would_ commit by running `git commit`; the second and
20 +third are what you _could_ commit by running `git add` before running
21 +`git commit`.
22
23 The command takes the same set of options as `git-commit`; it
24 shows what would be committed if the same options are given to
25 `git-commit`.
26
27 +If there is no path that is different between the index file and
28 +the current HEAD commit (i.e., there is nothing to commit by running
29 +`git-commit`), the command exits with non-zero status.
30 +
31 If any paths have been touched in the working tree (that is,
32 their modification times have changed) but their contents and
33 permissions are identical to those in the index file, the command
@@ -38,10 +39,10 @@ contains many paths that have been touched but not modified.
39 OUTPUT
40 ------
41 The output from this command is designed to be used as a commit
41 -template comments, and all the output lines are prefixed with '#'.
42 +template comment, and all the output lines are prefixed with '#'.
43
44 The paths mentioned in the output, unlike many other git commands, are
44 -made relative to the current directory, if you are working in a
45 +made relative to the current directory if you are working in a
46 subdirectory (this is on purpose, to help cutting and pasting). See
47 the status.relativePaths config option below.
48