From 0ba956d331e4c14fb1600a62044492c6c27af71a Mon Sep 17 00:00:00 2001 From: Johannes Schindelin Date: Tue, 22 May 2007 01:12:17 +0100 Subject: git-status: respect core.excludesFile git-add reads this variable, and honours the contents of that file if that exists. Match this behaviour in git-status, too. Noticed by Evan Carroll on IRC. Signed-off-by: Johannes Schindelin Signed-off-by: Junio C Hamano --- Documentation/git-status.txt | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'Documentation/git-status.txt') diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index e9e193f008..d7015387b5 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -42,6 +42,11 @@ mean the same thing and the latter is kept for backward compatibility) and `color.status.` configuration variables to colorize its output. +As for gitlink:git-add[1], the configuration variable +'core.excludesfile' can indicate a path to a file containing patterns +of file names to exclude, in addition to patterns given in +'info/exclude' and '.gitignore'. + Author ------ -- cgit v1.2.3 From cedb8d5d33e6496cfc70493db841b3db886e8658 Mon Sep 17 00:00:00 2001 From: Josh Triplett Date: Sat, 2 Jun 2007 10:08:54 -0700 Subject: Create a new manpage for the gitignore format, and reference it elsewhere Only git-ls-files(1) describes the gitignore format in detail, and it does so with reference to git-ls-files options. Most users don't use the plumbing command git-ls-files directly, and shouldn't have to look in its manpage for information on the gitignore format. Create a new manpage gitignore(5) (Documentation/gitignore.txt), and factor out the gitignore documentation into that file, changing it to refer to .gitignore and $GIT_DIR/info/exclude as used by porcelain commands. Reference gitignore(5) from other relevant manpages and documentation. Remove now-redundant information on exclude patterns from git-ls-files(1), leaving only information on how git-ls-files options specify exclude patterns and what precedence they have. Signed-off-by: Josh Triplett Signed-off-by: Junio C Hamano --- Documentation/git-status.txt | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) (limited to 'Documentation/git-status.txt') diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index d7015387b5..1fd1af102a 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -42,11 +42,9 @@ mean the same thing and the latter is kept for backward compatibility) and `color.status.` configuration variables to colorize its output. -As for gitlink:git-add[1], the configuration variable -'core.excludesfile' can indicate a path to a file containing patterns -of file names to exclude, in addition to patterns given in -'info/exclude' and '.gitignore'. - +See Also +-------- +gitlink:gitignore[5] Author ------ -- cgit v1.2.3 From a6080a0a44d5ead84db3dabbbc80e82df838533d Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Thu, 7 Jun 2007 00:04:01 -0700 Subject: War on whitespace This uses "git-apply --whitespace=strip" to fix whitespace errors that have crept in to our source files over time. There are a few files that need to have trailing whitespaces (most notably, test vectors). The results still passes the test, and build result in Documentation/ area is unchanged. Signed-off-by: Junio C Hamano --- Documentation/git-status.txt | 1 - 1 file changed, 1 deletion(-) (limited to 'Documentation/git-status.txt') diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index 1fd1af102a..6f16eb0328 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -58,4 +58,3 @@ Documentation by David Greaves, Junio C Hamano and the git-list Date: Mon, 6 Aug 2007 22:57:47 -0700 Subject: Add a note about the index being updated by git-status in some cases Signed-off-by: Steven Grimm Signed-off-by: Junio C Hamano --- Documentation/git-status.txt | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'Documentation/git-status.txt') diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index 6f16eb0328..8fd0fc6236 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -27,6 +27,13 @@ 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 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 +updates the index file. Running `git-status` can thus speed up +subsequent operations such as `git-diff` if the working tree +contains many paths that have been touched but not modified. + OUTPUT ------ -- cgit v1.2.3 From c7860507f0b8974359616d7047f76f1723843156 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Thu, 6 Dec 2007 09:15:39 -0800 Subject: git-status documentation: mention subdirectory behaviour Consistently with all other diff oriented commands, we have given paths relative to the work tree root in git-status output for a long time. This documents the recent behaviour change, as people's eyes (and worse yet, scripts, although scripts should not parse "git status" output) may depend on the old behaviour. In the longer run, giving a --full-name option to git-diff Porcelain similar to what ls-files has, and change the default for git-diff Porcelain to show relative paths may be a good thing to do, in order to hide the oddballness of this git-status behaviour, but that would have a rather large impact to established expectation by existing users. Signed-off-by: Junio C Hamano --- Documentation/git-status.txt | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'Documentation/git-status.txt') diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index 8fd0fc6236..b0cb6bc8b7 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -40,6 +40,10 @@ OUTPUT The output from this command is designed to be used as a commit template comments, 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 +subdirectory (this is on purpose, to help cutting and pasting). + CONFIGURATION ------------- -- cgit v1.2.3 From 46f721c8fee9f1c027f96e2bf987ce6e7d05ab94 Mon Sep 17 00:00:00 2001 From: Jeff King Date: Fri, 7 Dec 2007 16:26:07 -0500 Subject: add status.relativePaths config variable The output of git-status was recently changed to output relative paths. Setting this variable to false restores the old behavior for any old-timers that prefer it. Signed-off-by: Jeff King Signed-off-by: Junio C Hamano --- Documentation/git-status.txt | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'Documentation/git-status.txt') diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index b0cb6bc8b7..645dc85ceb 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -42,7 +42,8 @@ template comments, 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 -subdirectory (this is on purpose, to help cutting and pasting). +subdirectory (this is on purpose, to help cutting and pasting). See +the status.relativePaths config option below. CONFIGURATION @@ -53,6 +54,10 @@ mean the same thing and the latter is kept for backward compatibility) and `color.status.` configuration variables to colorize its output. +If the config variable `status.relativePaths` is set to false, then all +paths shown are relative to the repository root, not to the current +directory. + See Also -------- gitlink:gitignore[5] -- cgit v1.2.3 From 2099bca9ed06a4cb7ab0b8ca38bc90df5632ba41 Mon Sep 17 00:00:00 2001 From: Jeff King Date: Sat, 8 Dec 2007 04:00:31 -0500 Subject: 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 Signed-off-by: Junio C Hamano --- Documentation/git-status.txt | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) (limited to 'Documentation/git-status.txt') diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index 645dc85ceb..a1bb9bd829 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. -- cgit v1.2.3 From cc2d6b88f99cb9e00102a509f6069168ff84f08e Mon Sep 17 00:00:00 2001 From: Jeff King Date: Sun, 9 Dec 2007 03:21:34 -0500 Subject: don't mention index refreshing side effect in git-status docs The tip about speeding up subsequent operations is now obsolete; since aecbf914, git-diff now squelches empty diffs and performs an automatic refresh. Signed-off-by: Jeff King Signed-off-by: Junio C Hamano --- Documentation/git-status.txt | 7 ------- 1 file changed, 7 deletions(-) (limited to 'Documentation/git-status.txt') diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index a1bb9bd829..5c5a480ec4 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -28,13 +28,6 @@ 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 -updates the index file. Running `git-status` can thus speed up -subsequent operations such as `git-diff` if the working tree -contains many paths that have been touched but not modified. - OUTPUT ------ -- cgit v1.2.3 From 5162e69732d13dd079919a389a6ace8878aad716 Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Sat, 29 Dec 2007 00:20:38 -0600 Subject: Documentation: rename gitlink macro to linkgit Between AsciiDoc 8.2.2 and 8.2.3, the following change was made to the stock Asciidoc configuration: @@ -149,7 +153,10 @@ # Inline macros. # Backslash prefix required for escape processing. # (?s) re flag for line spanning. -(?su)[\\]?(?P\w(\w|-)*?):(?P\S*?)(\[(?P.*?)\])= + +# Explicit so they can be nested. +(?su)[\\]?(?P(http|https|ftp|file|mailto|callto|image|link)):(?P\S*?)(\[(?P.*?)\])= + # Anchor: [[[id]]]. Bibliographic anchor. (?su)[\\]?\[\[\[(?P[\w][\w-]*?)\]\]\]=anchor3 # Anchor: [[id,xreflabel]] This default regex now matches explicit values, and unfortunately in this case gitlink was being matched by just 'link', causing the wrong inline macro template to be applied. By renaming the macro, we can avoid being matched by the wrong regex. Signed-off-by: Dan McGee Signed-off-by: Junio C Hamano --- Documentation/git-status.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'Documentation/git-status.txt') diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index 5c5a480ec4..3ea269aa7a 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -15,7 +15,7 @@ DESCRIPTION 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 +tracked by git (and are not ignored by linkgit: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`. @@ -54,7 +54,7 @@ directory. See Also -------- -gitlink:gitignore[5] +linkgit:gitignore[5] Author ------ @@ -67,4 +67,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list Date: Sat, 12 Apr 2008 23:05:32 +0800 Subject: builtin-status: submodule summary support This commit teaches 'git commit/status' show a new 'Modified submodules' section, which is an output from: git submodule summary --cached --for-status --summary-limit just before the 'Untracked files' section. The is given by the config variable status.submodulesummary to limit the submodule summary size. status.submodulesummary is a bool/int variable with value: - false or 0 by default to disable the summary, or - positive number to limit the summary size, or - true or negative number to unlimit the summary size. Also mention status.submodulesummary in the documentation. Signed-off-by: Ping Yin Signed-off-by: Junio C Hamano --- Documentation/git-status.txt | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'Documentation/git-status.txt') diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index 3ea269aa7a..ea4376a17f 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -52,6 +52,11 @@ If the config variable `status.relativePaths` is set to false, then all paths shown are relative to the repository root, not to the current directory. +If `status.submodulesummary` is set to a non zero number or true (identical +to -1 or an unlimited number), the submodule summary will be enabled and a +summary of commits for modified submodules will be shown (see --summary-limit +option of linkgit:git-submodule[1]). + See Also -------- linkgit:gitignore[5] -- cgit v1.2.3 From 56ae8df5c7b05ee8982c9447fa31116104dc568f Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 28 May 2008 16:55:27 -0700 Subject: Manual subsection to refer to other pages is SEE ALSO Consistently say so in all caps as it is customary to do so. Signed-off-by: Junio C Hamano --- Documentation/git-status.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-status.txt') diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index ea4376a17f..057e2a167e 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -57,7 +57,7 @@ to -1 or an unlimited number), the submodule summary will be enabled and a summary of commits for modified submodules will be shown (see --summary-limit option of linkgit:git-submodule[1]). -See Also +SEE ALSO -------- linkgit:gitignore[5] -- cgit v1.2.3 From 9e1f0a85c68323830ea117092c55192b17aa3ac8 Mon Sep 17 00:00:00 2001 From: Christian Couder Date: Fri, 6 Jun 2008 09:07:32 +0200 Subject: documentation: move git(7) to git(1) As the "git" man page describes the "git" command at the end-user level, it seems better to move it to man section 1. Signed-off-by: Christian Couder Signed-off-by: Junio C Hamano --- Documentation/git-status.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-status.txt') diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index 057e2a167e..fef62b16df 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -72,4 +72,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list Date: Mon, 30 Jun 2008 01:09:04 -0500 Subject: Documentation: be consistent about "git-" versus "git " Since the git-* commands are not installed in $(bindir), using "git-command " in examples in the documentation is not a good idea. On the other hand, it is nice to be able to refer to each command using one hyphenated word. (There is no escaping it, anyway: man page names cannot have spaces in them.) This patch retains the dash in naming an operation, command, program, process, or action. Complete command lines that can be entered at a shell (i.e., without options omitted) are made to use the dashless form. The changes consist only of replacing some spaces with hyphens and vice versa. After a "s/ /-/g", the unpatched and patched versions are identical. Signed-off-by: Jonathan Nieder Signed-off-by: Junio C Hamano --- Documentation/git-status.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'Documentation/git-status.txt') diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index fef62b16df..c9d4a046c7 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -8,7 +8,7 @@ git-status - Show the working tree status SYNOPSIS -------- -'git-status' ... +'git status' ... DESCRIPTION ----------- @@ -17,7 +17,7 @@ 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 linkgit: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 +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 @@ -26,7 +26,7 @@ shows what would be committed if the same options are given to 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. +`git commit`), the command exits with non-zero status. OUTPUT -- cgit v1.2.3 From ba020ef5eb5fca3d757bd580ff117adaf81ca079 Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Thu, 3 Jul 2008 00:41:41 -0500 Subject: manpages: italicize git command names (which were in teletype font) The names of git commands are not meant to be entered at the commandline; they are just names. So we render them in italics, as is usual for command names in manpages. Using doit () { perl -e 'for (<>) { s/\`(git-[^\`.]*)\`/'\''\1'\''/g; print }' } for i in git*.txt config.txt diff*.txt blame*.txt fetch*.txt i18n.txt \ merge*.txt pretty*.txt pull*.txt rev*.txt urls*.txt do doit <"$i" >"$i+" && mv "$i+" "$i" done git diff . Signed-off-by: Jonathan Nieder Signed-off-by: Junio C Hamano --- Documentation/git-status.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'Documentation/git-status.txt') diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index c9d4a046c7..57b7498239 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -17,12 +17,12 @@ 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 linkgit: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 +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 +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`. +'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 -- cgit v1.2.3 From 59eb68aa2b4e52aa1d098e0d76c5130864ceff2e Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Mon, 21 Jul 2008 12:14:42 -0700 Subject: Update my e-mail address The old cox.net address is still getting mails from gitters. Signed-off-by: Junio C Hamano --- Documentation/git-status.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-status.txt') diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index 57b7498239..84f60f3407 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -64,7 +64,7 @@ linkgit:gitignore[5] Author ------ Written by Linus Torvalds and -Junio C Hamano . +Junio C Hamano . Documentation -------------- -- cgit v1.2.3