diff options
| author |  Manav Rathi <mnvrth@gmail.com> | 2017-09-25 13:39:00 +0530 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2017-09-25 17:54:36 +0900 |
| commit | 93dbefb389a011c9107a3908fd38e743055be267 (patch) | |
| tree | d25857fead15bb1130e89139849c3593a1eb32e0 /Documentation | |
| parent | Git 2.13.5 (diff) | |
| download | tgif-93dbefb389a011c9107a3908fd38e743055be267.tar.xz | |
docs: improve discoverability of exclude pathspec
The ability to exclude paths with a negative pathspec is not mentioned
in the man pages for git grep and other commands where it might be
useful.
Add an example and a pointer to the pathspec glossary entry in the man
page for git grep to help the user to discover this ability.
Add similar pointers from the git-add and git-status man pages.
Additionally,
- Add a test for the behaviour when multiple exclusions are present.
- Add a test for the ^ alias.
- Improve name of existing test.
- Improve grammar in glossary description of the exclude pathspec.
Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Manav Rathi <mnvrth@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-add.txt | 3 | ||||
| -rw-r--r-- | Documentation/git-grep.txt | 6 | ||||
| -rw-r--r-- | Documentation/git-status.txt | 2 | ||||
| -rw-r--r-- | Documentation/glossary-content.txt | 2 |
4 files changed, 12 insertions, 1 deletions
diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt index 7ed63dce0b..1c3da6d7dd 100644 --- a/Documentation/git-add.txt +++ b/Documentation/git-add.txt @@ -61,6 +61,9 @@ OPTIONS the working tree. Note that older versions of Git used to ignore removed files; use `--no-all` option if you want to add modified or new files but ignore removed ones. ++ +For more details about the <pathspec> syntax, see the 'pathspec' entry +in linkgit:gitglossary[7]. -n:: --dry-run:: diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt index 71f32f3508..56fb55950a 100644 --- a/Documentation/git-grep.txt +++ b/Documentation/git-grep.txt @@ -293,6 +293,9 @@ OPTIONS <pathspec>...:: If given, limit the search to paths matching at least one pattern. Both leading paths match and glob(7) patterns are supported. ++ +For more details about the <pathspec> syntax, see the 'pathspec' entry +in linkgit:gitglossary[7]. Examples -------- @@ -309,6 +312,9 @@ Examples Looks for a line that has `NODE` or `Unexpected` in files that have lines that match both. +`git grep solution -- :^Documentation`:: + Looks for `solution`, excluding files in `Documentation`. + GIT --- Part of the linkgit:git[1] suite diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index d70abc6afe..5440711295 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -108,6 +108,8 @@ configuration variable documented in linkgit:git-config[1]. without options are equivalent to 'always' and 'never' respectively. +<pathspec>...:: + See the 'pathspec' entry in linkgit:gitglossary[7]. OUTPUT ------ diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt index 6e991c2469..39a6931b9c 100644 --- a/Documentation/glossary-content.txt +++ b/Documentation/glossary-content.txt @@ -407,7 +407,7 @@ these forms: exclude;; After a path matches any non-exclude pathspec, it will be run - through all exclude pathspec (magic signature: `!` or its + through all exclude pathspecs (magic signature: `!` or its synonym `^`). If it matches, the path is ignored. When there is no non-exclude pathspec, the exclusion is applied to the result set as if invoked without any pathspec. |