Skip to content

Commit ff91dbb

Browse files
committed
Merge branch 'po/maint-docs'
Various documentation fixups. * po/maint-docs: Doc branch: show -vv option and alternative Doc clean: add See Also link Doc add: link gitignore Doc: separate gitignore pattern sources Doc: shallow clone deepens _to_ new depth
2 parents 8ccd4b6 + f0970fa commit ff91dbb

File tree

5 files changed

+28
-15
lines changed

5 files changed

+28
-15
lines changed

Documentation/fetch-options.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
--depth=<depth>::
1111
Deepen the history of a 'shallow' repository created by
1212
`git clone` with `--depth=<depth>` option (see linkgit:git-clone[1])
13-
by the specified number of commits.
13+
to the specified number of commits from the tip of each remote
14+
branch history. Tags for the deepened commits are not fetched.
1415

1516
ifndef::git-pull[]
1617
--dry-run::

Documentation/git-add.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ Configuration
155155
The optional configuration variable `core.excludesfile` indicates a path to a
156156
file containing patterns of file names to exclude from git-add, similar to
157157
$GIT_DIR/info/exclude. Patterns in the exclude file are used in addition to
158-
those in info/exclude. See linkgit:gitrepository-layout[5].
158+
those in info/exclude. See linkgit:gitignore[5].
159159

160160

161161
EXAMPLES

Documentation/git-branch.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,11 +131,13 @@ This option is only applicable in non-verbose mode.
131131
use `git branch --list <pattern>` to list matching branches.
132132

133133
-v::
134+
-vv::
134135
--verbose::
135136
When in list mode,
136137
show sha1 and commit subject line for each head, along with
137138
relationship to upstream branch (if any). If given twice, print
138-
the name of the upstream branch, as well.
139+
the name of the upstream branch, as well (see also `git remote
140+
show <remote>`).
139141

140142
-q::
141143
--quiet::

Documentation/git-clean.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,10 @@ OPTIONS
6363
Remove only files ignored by git. This may be useful to rebuild
6464
everything from scratch, but keep manually created files.
6565

66+
SEE ALSO
67+
--------
68+
linkgit:gitignore[5]
69+
6670
GIT
6771
---
6872
Part of the linkgit:git[1] suite

Documentation/gitignore.txt

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,18 +41,24 @@ precedence, the last matching pattern decides the outcome):
4141
variable 'core.excludesfile'.
4242

4343
Which file to place a pattern in depends on how the pattern is meant to
44-
be used. Patterns which should be version-controlled and distributed to
45-
other repositories via clone (i.e., files that all developers will want
46-
to ignore) should go into a `.gitignore` file. Patterns which are
47-
specific to a particular repository but which do not need to be shared
48-
with other related repositories (e.g., auxiliary files that live inside
49-
the repository but are specific to one user's workflow) should go into
50-
the `$GIT_DIR/info/exclude` file. Patterns which a user wants git to
51-
ignore in all situations (e.g., backup or temporary files generated by
52-
the user's editor of choice) generally go into a file specified by
53-
`core.excludesfile` in the user's `~/.gitconfig`. Its default value is
54-
$XDG_CONFIG_HOME/git/ignore. If $XDG_CONFIG_HOME is either not set or empty,
55-
$HOME/.config/git/ignore is used instead.
44+
be used.
45+
46+
* Patterns which should be version-controlled and distributed to
47+
other repositories via clone (i.e., files that all developers will want
48+
to ignore) should go into a `.gitignore` file.
49+
50+
* Patterns which are
51+
specific to a particular repository but which do not need to be shared
52+
with other related repositories (e.g., auxiliary files that live inside
53+
the repository but are specific to one user's workflow) should go into
54+
the `$GIT_DIR/info/exclude` file.
55+
56+
* Patterns which a user wants git to
57+
ignore in all situations (e.g., backup or temporary files generated by
58+
the user's editor of choice) generally go into a file specified by
59+
`core.excludesfile` in the user's `~/.gitconfig`. Its default value is
60+
$XDG_CONFIG_HOME/git/ignore. If $XDG_CONFIG_HOME is either not set or
61+
empty, $HOME/.config/git/ignore is used instead.
5662

5763
The underlying git plumbing tools, such as
5864
'git ls-files' and 'git read-tree', read

0 commit comments

Comments
 (0)