summaryrefslogtreecommitdiff
path: root/Documentation/git-status.txt
diff options
context:
space:
mode:
authorJeff King <peff@peff.net>2007-12-08 09:00:31 (GMT)
committerJunio C Hamano <gitster@pobox.com>2007-12-08 11:33:24 (GMT)
commit2099bca9ed06a4cb7ab0b8ca38bc90df5632ba41 (patch)
treef7aaf6f5248af09f2925d97e10e59ff2029ffd18 /Documentation/git-status.txt
parent46f721c8fee9f1c027f96e2bf987ce6e7d05ab94 (diff)
downloadgit-2099bca9ed06a4cb7ab0b8ca38bc90df5632ba41.zip
git-2099bca9ed06a4cb7ab0b8ca38bc90df5632ba41.tar.gz
git-2099bca9ed06a4cb7ab0b8ca38bc90df5632ba41.tar.bz2
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>
Diffstat (limited to 'Documentation/git-status.txt')
-rw-r--r--Documentation/git-status.txt25
1 files changed, 13 insertions, 12 deletions
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index 645dc85..a1bb9bd 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -12,21 +12,22 @@ SYNOPSIS
DESCRIPTION
-----------
-Examines paths in the working tree that has changes unrecorded
-to the index file, and changes between the index file and the
-current HEAD commit. The former paths are what you _could_
-commit by running 'git add' before running 'git
-commit', and the latter paths are what you _would_ commit by
-running 'git commit'.
-
-If there is no path that is different between the index file and
-the current HEAD commit, the command exits with non-zero
-status.
+Displays paths that have differences between the index file and the
+current HEAD commit, paths that have differences between the working
+tree and the index file, and paths in the working tree that are not
+tracked by git (and are not ignored by gitlink:gitignore[5]). The first
+are what you _would_ commit by running `git commit`; the second and
+third are what you _could_ commit by running `git add` before running
+`git commit`.
The command takes the same set of options as `git-commit`; it
shows what would be committed if the same options are given to
`git-commit`.
+If there is no path that is different between the index file and
+the current HEAD commit (i.e., there is nothing to commit by running
+`git-commit`), the command exits with non-zero status.
+
If any paths have been touched in the working tree (that is,
their modification times have changed) but their contents and
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.
OUTPUT
------
The output from this command is designed to be used as a commit
-template comments, and all the output lines are prefixed with '#'.
+template comment, and all the output lines are prefixed with '#'.
The paths mentioned in the output, unlike many other git commands, are
-made relative to the current directory, if you are working in a
+made relative to the current directory if you are working in a
subdirectory (this is on purpose, to help cutting and pasting). See
the status.relativePaths config option below.