Skip to content

Commit add0951

Browse files
committed
Merge remote branch 'remotes/trast-doc/for-next'
* remotes/trast-doc/for-next: Documentation: spell 'git cmd' without dash throughout Documentation: format full commands in typewriter font Documentation: warn prominently against merging with dirty trees Documentation/git-merge: reword references to "remote" and "pull" Conflicts: Documentation/config.txt Documentation/git-config.txt Documentation/git-merge.txt
2 parents 5fc9df0 + 0b444cd commit add0951

File tree

116 files changed

+693
-685
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

116 files changed

+693
-685
lines changed

Documentation/config.txt

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The values following the equals sign in variable assign are all either
6464
a string, an integer, or a boolean. Boolean values may be given as yes/no,
6565
0/1, true/false or on/off. Case is not significant in boolean values, when
6666
converting value to the canonical form using '--bool' type specifier;
67-
'git-config' will ensure that the output is "true" or "false".
67+
'git config' will ensure that the output is "true" or "false".
6868

6969
String values may be entirely or partially enclosed in double quotes.
7070
You need to enclose variable values in double quotes if you want to
@@ -450,8 +450,8 @@ core.pager::
450450

451451
core.whitespace::
452452
A comma separated list of common whitespace problems to
453-
notice. 'git-diff' will use `color.diff.whitespace` to
454-
highlight them, and 'git-apply --whitespace=error' will
453+
notice. 'git diff' will use `color.diff.whitespace` to
454+
highlight them, and 'git apply --whitespace=error' will
455455
consider them as errors. You can prefix `-` to disable
456456
any of them (e.g. `-trailing-space`):
457457
+
@@ -515,7 +515,7 @@ core.sparseCheckout::
515515
linkgit:git-read-tree[1] for more information.
516516

517517
add.ignore-errors::
518-
Tells 'git-add' to continue adding files when some files cannot be
518+
Tells 'git add' to continue adding files when some files cannot be
519519
added due to indexing errors. Equivalent to the '--ignore-errors'
520520
option of linkgit:git-add[1].
521521

@@ -537,19 +537,19 @@ executed from the top-level directory of a repository, which may
537537
not necessarily be the current directory.
538538

539539
apply.ignorewhitespace::
540-
When set to 'change', tells 'git-apply' to ignore changes in
540+
When set to 'change', tells 'git apply' to ignore changes in
541541
whitespace, in the same way as the '--ignore-space-change'
542542
option.
543-
When set to one of: no, none, never, false tells 'git-apply' to
543+
When set to one of: no, none, never, false tells 'git apply' to
544544
respect all whitespace differences.
545545
See linkgit:git-apply[1].
546546

547547
apply.whitespace::
548-
Tells 'git-apply' how to handle whitespaces, in the same way
548+
Tells 'git apply' how to handle whitespaces, in the same way
549549
as the '--whitespace' option. See linkgit:git-apply[1].
550550

551551
branch.autosetupmerge::
552-
Tells 'git-branch' and 'git-checkout' to set up new branches
552+
Tells 'git branch' and 'git checkout' to set up new branches
553553
so that linkgit:git-pull[1] will appropriately merge from the
554554
starting point branch. Note that even if this option is not set,
555555
this behavior can be chosen per-branch using the `--track`
@@ -560,7 +560,7 @@ branch.autosetupmerge::
560560
branch. This option defaults to true.
561561

562562
branch.autosetuprebase::
563-
When a new branch is created with 'git-branch' or 'git-checkout'
563+
When a new branch is created with 'git branch' or 'git checkout'
564564
that tracks another branch, this variable tells git to set
565565
up pull to rebase instead of merge (see "branch.<name>.rebase").
566566
When `never`, rebase is never automatically set to true.
@@ -575,24 +575,24 @@ branch.autosetuprebase::
575575
This option defaults to never.
576576

577577
branch.<name>.remote::
578-
When in branch <name>, it tells 'git-fetch' and 'git-push' which
578+
When in branch <name>, it tells 'git fetch' and 'git push' which
579579
remote to fetch from/push to. It defaults to `origin` if no remote is
580580
configured. `origin` is also used if you are not on any branch.
581581

582582
branch.<name>.merge::
583583
Defines, together with branch.<name>.remote, the upstream branch
584-
for the given branch. It tells 'git-fetch'/'git-pull' which
585-
branch to merge and can also affect 'git-push' (see push.default).
586-
When in branch <name>, it tells 'git-fetch' the default
584+
for the given branch. It tells 'git fetch'/'git pull' which
585+
branch to merge and can also affect 'git push' (see push.default).
586+
When in branch <name>, it tells 'git fetch' the default
587587
refspec to be marked for merging in FETCH_HEAD. The value is
588588
handled like the remote part of a refspec, and must match a
589589
ref which is fetched from the remote given by
590590
"branch.<name>.remote".
591-
The merge information is used by 'git-pull' (which at first calls
592-
'git-fetch') to lookup the default branch for merging. Without
593-
this option, 'git-pull' defaults to merge the first refspec fetched.
591+
The merge information is used by 'git pull' (which at first calls
592+
'git fetch') to lookup the default branch for merging. Without
593+
this option, 'git pull' defaults to merge the first refspec fetched.
594594
Specify multiple values to get an octopus merge.
595-
If you wish to setup 'git-pull' so that it merges into <name> from
595+
If you wish to setup 'git pull' so that it merges into <name> from
596596
another branch in the local repository, you can point
597597
branch.<name>.merge to the desired branch, and use the special setting
598598
`.` (a period) for branch.<name>.remote.
@@ -677,7 +677,7 @@ color.interactive::
677677
colors only when the output is to the terminal. Defaults to false.
678678

679679
color.interactive.<slot>::
680-
Use customized color for 'git-add --interactive'
680+
Use customized color for 'git add --interactive'
681681
output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
682682
four distinct types of normal output from interactive
683683
commands. The values of these variables may be specified as
@@ -727,14 +727,14 @@ commit.template::
727727
specified user's home directory.
728728

729729
diff.autorefreshindex::
730-
When using 'git-diff' to compare with work tree
730+
When using 'git diff' to compare with work tree
731731
files, do not consider stat-only change as changed.
732732
Instead, silently run `git update-index --refresh` to
733733
update the cached stat information for paths whose
734734
contents in the work tree match the contents in the
735735
index. This option defaults to true. Note that this
736-
affects only 'git-diff' Porcelain, and not lower level
737-
'diff' commands such as 'git-diff-files'.
736+
affects only 'git diff' Porcelain, and not lower level
737+
'diff' commands such as 'git diff-files'.
738738

739739
diff.external::
740740
If this config variable is set, diff generation is not
@@ -746,24 +746,24 @@ diff.external::
746746
your files, you might want to use linkgit:gitattributes[5] instead.
747747

748748
diff.mnemonicprefix::
749-
If set, 'git-diff' uses a prefix pair that is different from the
749+
If set, 'git diff' uses a prefix pair that is different from the
750750
standard "a/" and "b/" depending on what is being compared. When
751751
this configuration is in effect, reverse diff output also swaps
752752
the order of the prefixes:
753-
'git-diff';;
753+
`git diff`;;
754754
compares the (i)ndex and the (w)ork tree;
755-
'git-diff HEAD';;
755+
`git diff HEAD`;;
756756
compares a (c)ommit and the (w)ork tree;
757-
'git diff --cached';;
757+
`git diff --cached`;;
758758
compares a (c)ommit and the (i)ndex;
759-
'git-diff HEAD:file1 file2';;
759+
`git diff HEAD:file1 file2`;;
760760
compares an (o)bject and a (w)ork tree entity;
761-
'git diff --no-index a b';;
761+
`git diff --no-index a b`;;
762762
compares two non-git things (1) and (2).
763763

764764
diff.renameLimit::
765765
The number of files to consider when performing the copy/rename
766-
detection; equivalent to the 'git-diff' option '-l'.
766+
detection; equivalent to the 'git diff' option '-l'.
767767

768768
diff.renames::
769769
Tells git to detect renames. If set to any boolean value, it
@@ -849,7 +849,7 @@ format.pretty::
849849
linkgit:git-whatchanged[1].
850850

851851
format.thread::
852-
The default threading style for 'git-format-patch'. Can be
852+
The default threading style for 'git format-patch'. Can be
853853
a boolean value, or `shallow` or `deep`. `shallow` threading
854854
makes every mail a reply to the head of the series,
855855
where the head is chosen from the cover letter, the
@@ -867,7 +867,7 @@ format.signoff::
867867

868868
gc.aggressiveWindow::
869869
The window size parameter used in the delta compression
870-
algorithm used by 'git-gc --aggressive'. This defaults
870+
algorithm used by 'git gc --aggressive'. This defaults
871871
to 10.
872872

873873
gc.auto::
@@ -887,33 +887,33 @@ gc.packrefs::
887887
Running `git pack-refs` in a repository renders it
888888
unclonable by Git versions prior to 1.5.1.2 over dumb
889889
transports such as HTTP. This variable determines whether
890-
'git gc' runs `git pack-refs`. This can be set to "nobare"
890+
'git gc' runs `git pack-refs`. This can be set to `nobare`
891891
to enable it within all non-bare repos or it can be set to a
892892
boolean value. The default is `true`.
893893

894894
gc.pruneexpire::
895-
When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
895+
When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
896896
Override the grace period with this config variable. The value
897897
"now" may be used to disable this grace period and always prune
898898
unreachable objects immediately.
899899

900900
gc.reflogexpire::
901-
'git-reflog expire' removes reflog entries older than
901+
'git reflog expire' removes reflog entries older than
902902
this time; defaults to 90 days.
903903

904904
gc.reflogexpireunreachable::
905-
'git-reflog expire' removes reflog entries older than
905+
'git reflog expire' removes reflog entries older than
906906
this time and are not reachable from the current tip;
907907
defaults to 30 days.
908908

909909
gc.rerereresolved::
910910
Records of conflicted merge you resolved earlier are
911-
kept for this many days when 'git-rerere gc' is run.
911+
kept for this many days when 'git rerere gc' is run.
912912
The default is 60 days. See linkgit:git-rerere[1].
913913

914914
gc.rerereunresolved::
915915
Records of conflicted merge you have not resolved are
916-
kept for this many days when 'git-rerere gc' is run.
916+
kept for this many days when 'git rerere gc' is run.
917917
The default is 15 days. See linkgit:git-rerere[1].
918918

919919
gitcvs.commitmsgannotation::
@@ -1021,7 +1021,7 @@ gui.spellingdictionary::
10211021
off.
10221022

10231023
gui.fastcopyblame::
1024-
If true, 'git gui blame' uses '-C' instead of '-C -C' for original
1024+
If true, 'git gui blame' uses `-C` instead of `-C -C` for original
10251025
location detection. It makes blame significantly faster on huge
10261026
repositories at the expense of less thorough copy detection.
10271027

@@ -1180,7 +1180,7 @@ i18n.commitEncoding::
11801180

11811181
i18n.logOutputEncoding::
11821182
Character encoding the commit messages are converted to when
1183-
running 'git-log' and friends.
1183+
running 'git log' and friends.
11841184

11851185
imap::
11861186
The configuration variables in the 'imap' section are described
@@ -1214,7 +1214,7 @@ interactive.singlekey::
12141214

12151215
log.date::
12161216
Set default date-time mode for the log command. Setting log.date
1217-
value is similar to using 'git-log'\'s --date option. The value is one of the
1217+
value is similar to using 'git log'\'s --date option. The value is one of the
12181218
following alternatives: {relative,local,default,iso,rfc,short}.
12191219
See linkgit:git-log[1].
12201220

Documentation/fetch-options.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ endif::git-pull[]
1919

2020
-f::
2121
--force::
22-
When 'git-fetch' is used with `<rbranch>:<lbranch>`
22+
When 'git fetch' is used with `<rbranch>:<lbranch>`
2323
refspec, it refuses to update the local branch
2424
`<lbranch>` unless the remote branch `<rbranch>` it
2525
fetches is a descendant of `<lbranch>`. This option
@@ -61,16 +61,16 @@ endif::git-pull[]
6161

6262
-u::
6363
--update-head-ok::
64-
By default 'git-fetch' refuses to update the head which
64+
By default 'git fetch' refuses to update the head which
6565
corresponds to the current branch. This flag disables the
66-
check. This is purely for the internal use for 'git-pull'
67-
to communicate with 'git-fetch', and unless you are
66+
check. This is purely for the internal use for 'git pull'
67+
to communicate with 'git fetch', and unless you are
6868
implementing your own Porcelain you are not supposed to
6969
use it.
7070

7171
--upload-pack <upload-pack>::
7272
When given, and the repository to fetch from is handled
73-
by 'git-fetch-pack', '--exec=<upload-pack>' is passed to
73+
by 'git fetch-pack', '--exec=<upload-pack>' is passed to
7474
the command to specify non-default path for the command
7575
run on the other end.
7676

Documentation/git-add.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The `git add` command will not add ignored files by default. If any
3939
ignored files were explicitly specified on the command line, `git add`
4040
will fail with a list of ignored files. Ignored files reached by
4141
directory recursion or filename globbing performed by Git (quote your
42-
globs before the shell) will be silently ignored. The `add` command can
42+
globs before the shell) will be silently ignored. The 'git add' command can
4343
be used to add ignored files with the `-f` (force) option.
4444

4545
Please see linkgit:git-commit[1] for alternative ways to add content to a

Documentation/git-am.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ OPTIONS
3737

3838
-k::
3939
--keep::
40-
Pass `-k` flag to 'git-mailinfo' (see linkgit:git-mailinfo[1]).
40+
Pass `-k` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
4141

4242
-c::
4343
--scissors::
@@ -53,7 +53,7 @@ OPTIONS
5353

5454
-u::
5555
--utf8::
56-
Pass `-u` flag to 'git-mailinfo' (see linkgit:git-mailinfo[1]).
56+
Pass `-u` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
5757
The proposed commit log message taken from the e-mail
5858
is re-coded into UTF-8 encoding (configuration variable
5959
`i18n.commitencoding` can be used to specify project's
@@ -63,7 +63,7 @@ This was optional in prior versions of git, but now it is the
6363
default. You can use `--no-utf8` to override this.
6464

6565
--no-utf8::
66-
Pass `-n` flag to 'git-mailinfo' (see
66+
Pass `-n` flag to 'git mailinfo' (see
6767
linkgit:git-mailinfo[1]).
6868

6969
-3::
@@ -81,7 +81,7 @@ default. You can use `--no-utf8` to override this.
8181
-p<n>::
8282
--directory=<dir>::
8383
--reject::
84-
These flags are passed to the 'git-apply' (see linkgit:git-apply[1])
84+
These flags are passed to the 'git apply' (see linkgit:git-apply[1])
8585
program that applies
8686
the patch.
8787

@@ -121,7 +121,7 @@ default. You can use `--no-utf8` to override this.
121121
to the screen before exiting. This overrides the
122122
standard message informing you to use `--resolved`
123123
or `--skip` to handle the failure. This is solely
124-
for internal use between 'git-rebase' and 'git-am'.
124+
for internal use between 'git rebase' and 'git am'.
125125

126126
--abort::
127127
Restore the original branch and abort the patching operation.

Documentation/git-apply.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ OPTIONS
6969
without using the working tree. This implies `--index`.
7070

7171
--build-fake-ancestor=<file>::
72-
Newer 'git-diff' output has embedded 'index information'
72+
Newer 'git diff' output has embedded 'index information'
7373
for each blob to help identify the original version that
7474
the patch applies to. When this flag is given, and if
7575
the original versions of the blobs are available locally,
@@ -83,7 +83,7 @@ the information is read from the current index instead.
8383
Apply the patch in reverse.
8484

8585
--reject::
86-
For atomicity, 'git-apply' by default fails the whole patch and
86+
For atomicity, 'git apply' by default fails the whole patch and
8787
does not touch the working tree when some of the hunks
8888
do not apply. This option makes it apply
8989
the parts of the patch that are applicable, and leave the
@@ -109,7 +109,7 @@ any of those replacements occurred.
109109
ever ignored.
110110

111111
--unidiff-zero::
112-
By default, 'git-apply' expects that the patch being
112+
By default, 'git apply' expects that the patch being
113113
applied is a unified diff with at least one line of context.
114114
This provides good safety measures, but breaks down when
115115
applying a diff generated with `--unified=0`. To bypass these
@@ -120,7 +120,7 @@ discouraged.
120120

121121
--apply::
122122
If you use any of the options marked "Turns off
123-
'apply'" above, 'git-apply' reads and outputs the
123+
'apply'" above, 'git apply' reads and outputs the
124124
requested information without actually applying the
125125
patch. Give this flag after those flags to also apply
126126
the patch.
@@ -229,7 +229,7 @@ apply.whitespace::
229229

230230
Submodules
231231
----------
232-
If the patch contains any changes to submodules then 'git-apply'
232+
If the patch contains any changes to submodules then 'git apply'
233233
treats these changes as follows.
234234

235235
If `--index` is specified (explicitly or implicitly), then the submodule

Documentation/git-archimport.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,17 @@ branches that have different roots, it will refuse to run. In that case,
2929
edit your <archive/branch> parameters to define clearly the scope of the
3030
import.
3131

32-
'git-archimport' uses `tla` extensively in the background to access the
32+
'git archimport' uses `tla` extensively in the background to access the
3333
Arch repository.
3434
Make sure you have a recent version of `tla` available in the path. `tla` must
35-
know about the repositories you pass to 'git-archimport'.
35+
know about the repositories you pass to 'git archimport'.
3636

37-
For the initial import, 'git-archimport' expects to find itself in an empty
37+
For the initial import, 'git archimport' expects to find itself in an empty
3838
directory. To follow the development of a project that uses Arch, rerun
39-
'git-archimport' with the same parameters as the initial import to perform
39+
'git archimport' with the same parameters as the initial import to perform
4040
incremental imports.
4141

42-
While 'git-archimport' will try to create sensible branch names for the
42+
While 'git archimport' will try to create sensible branch names for the
4343
archives that it imports, it is also possible to specify git branch names
4444
manually. To do so, write a git branch name after each <archive/branch>
4545
parameter, separated by a colon. This way, you can shorten the Arch
@@ -84,7 +84,7 @@ OPTIONS
8484

8585
-o::
8686
Use this for compatibility with old-style branch names used by
87-
earlier versions of 'git-archimport'. Old-style branch names
87+
earlier versions of 'git archimport'. Old-style branch names
8888
were category--branch, whereas new-style branch names are
8989
archive,category--branch--version. In both cases, names given
9090
on the command-line will override the automatically-generated

0 commit comments

Comments
 (0)