Skip to content

Commit eba1416

Browse files
committed
Merge branch 'ah/doc-updates' into maint
Doc updates. * ah/doc-updates: doc: fix formatting in git-update-ref doc: fix indentation of listing blocks in gitweb.conf.txt doc: fix descripion for 'git tag --format' doc: fix inappropriate monospace formatting doc: fix ASCII art tab spacing doc: clarify boundaries of 'git worktree list --porcelain'
2 parents b53df43 + 081d916 commit eba1416

12 files changed

+92
-79
lines changed

Documentation/git-bisect-lk2009.txt

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -633,11 +633,11 @@ and so at step 3) we compute f(X).
633633
Let's take the following graph as an example:
634634

635635
-------------
636-
G-H-I-J
637-
/ \
636+
G-H-I-J
637+
/ \
638638
A-B-C-D-E-F O
639-
\ /
640-
K-L-M-N
639+
\ /
640+
K-L-M-N
641641
-------------
642642

643643
If we compute the following non optimal function on it:
@@ -649,25 +649,25 @@ g(X) = min(number_of_ancestors(X), number_of_descendants(X))
649649
we get:
650650

651651
-------------
652-
4 3 2 1
653-
G-H-I-J
652+
4 3 2 1
653+
G-H-I-J
654654
1 2 3 4 5 6/ \0
655655
A-B-C-D-E-F O
656-
\ /
657-
K-L-M-N
658-
4 3 2 1
656+
\ /
657+
K-L-M-N
658+
4 3 2 1
659659
-------------
660660

661661
but with the algorithm used by git bisect we get:
662662

663663
-------------
664-
7 7 6 5
665-
G-H-I-J
664+
7 7 6 5
665+
G-H-I-J
666666
1 2 3 4 5 6/ \0
667667
A-B-C-D-E-F O
668-
\ /
669-
K-L-M-N
670-
7 7 6 5
668+
\ /
669+
K-L-M-N
670+
7 7 6 5
671671
-------------
672672

673673
So we chose G, H, K or L as the best bisection point, which is better
@@ -773,7 +773,7 @@ forked of the main branch at a commit named "D" like this:
773773
-------------
774774
A-B-C-D-E-F-G <--main
775775
\
776-
H-I-J <--dev
776+
H-I-J <--dev
777777
-------------
778778

779779
The commit "D" is called a "merge base" for branch "main" and "dev"

Documentation/git-checkout.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -311,9 +311,9 @@ branch refers to a specific commit. Let's look at a repo with three
311311
commits, one of them tagged, and with branch 'master' checked out:
312312

313313
------------
314-
HEAD (refers to branch 'master')
315-
|
316-
v
314+
HEAD (refers to branch 'master')
315+
|
316+
v
317317
a---b---c branch 'master' (refers to commit 'c')
318318
^
319319
|
@@ -329,9 +329,9 @@ to commit 'd':
329329
------------
330330
$ edit; git add; git commit
331331

332-
HEAD (refers to branch 'master')
333-
|
334-
v
332+
HEAD (refers to branch 'master')
333+
|
334+
v
335335
a---b---c---d branch 'master' (refers to commit 'd')
336336
^
337337
|
@@ -398,7 +398,7 @@ at what happens when we then checkout master:
398398
------------
399399
$ git checkout master
400400

401-
HEAD (refers to branch 'master')
401+
HEAD (refers to branch 'master')
402402
e---f |
403403
/ v
404404
a---b---c---d branch 'master' (refers to commit 'd')

Documentation/git-merge-base.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -154,13 +154,13 @@ topic origin/master`, the history of remote-tracking branch
154154
`origin/master` may have been rewound and rebuilt, leading to a
155155
history of this shape:
156156

157-
o---B2
157+
o---B2
158158
/
159159
---o---o---B1--o---o---o---B (origin/master)
160160
\
161-
B0
161+
B0
162162
\
163-
D0---D1---D (topic)
163+
D0---D1---D (topic)
164164

165165
where `origin/master` used to point at commits B0, B1, B2 and now it
166166
points at B, and your `topic` branch was started on top of it back

Documentation/git-tag.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,12 @@ This option is only applicable when listing tags without annotation lines.
187187
`--create-reflog`, but currently does not negate the setting of
188188
`core.logAllRefUpdates`.
189189

190+
--format=<format>::
191+
A string that interpolates `%(fieldname)` from a tag ref being shown
192+
and the object it points at. The format is the same as
193+
that of linkgit:git-for-each-ref[1]. When unspecified,
194+
defaults to `%(refname:strip=2)`.
195+
190196
<tagname>::
191197
The name of the tag to create, delete, or describe.
192198
The new tag name must pass all checks defined by
@@ -198,12 +204,6 @@ This option is only applicable when listing tags without annotation lines.
198204
The object that the new tag will refer to, usually a commit.
199205
Defaults to HEAD.
200206

201-
<format>::
202-
A string that interpolates `%(fieldname)` from a tag ref being shown
203-
and the object it points at. The format is the same as
204-
that of linkgit:git-for-each-ref[1]. When unspecified,
205-
defaults to `%(refname:strip=2)`.
206-
207207
CONFIGURATION
208208
-------------
209209
By default, 'git tag' in sign-with-default mode (-s) will use your

Documentation/git-update-ref.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,17 +129,17 @@ a line to the log file "$GIT_DIR/logs/<ref>" (dereferencing all
129129
symbolic refs before creating the log name) describing the change
130130
in ref value. Log lines are formatted as:
131131

132-
. oldsha1 SP newsha1 SP committer LF
133-
+
132+
oldsha1 SP newsha1 SP committer LF
133+
134134
Where "oldsha1" is the 40 character hexadecimal value previously
135135
stored in <ref>, "newsha1" is the 40 character hexadecimal value of
136136
<newvalue> and "committer" is the committer's name, email address
137137
and date in the standard Git committer ident format.
138138

139139
Optionally with -m:
140140

141-
. oldsha1 SP newsha1 SP committer TAB message LF
142-
+
141+
oldsha1 SP newsha1 SP committer TAB message LF
142+
143143
Where all fields are as described above and "message" is the
144144
value supplied to the -m option.
145145

Documentation/git-upload-pack.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ SYNOPSIS
1111
[verse]
1212
'git-upload-pack' [--[no-]strict] [--timeout=<n>] [--stateless-rpc]
1313
[--advertise-refs] <directory>
14+
1415
DESCRIPTION
1516
-----------
1617
Invoked by 'git fetch-pack', learns what

Documentation/git-worktree.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262,8 +262,8 @@ Porcelain Format
262262
The porcelain format has a line per attribute. Attributes are listed with a
263263
label and value separated by a single space. Boolean attributes (like 'bare'
264264
and 'detached') are listed as a label only, and are only present if and only
265-
if the value is true. An empty line indicates the end of a worktree. For
266-
example:
265+
if the value is true. The first attribute of a worktree is always `worktree`,
266+
an empty line indicates the end of the record. For example:
267267

268268
------------
269269
$ git worktree list --porcelain

Documentation/git.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -402,11 +402,11 @@ Git so take care if using a foreign front-end.
402402
of Git object directories which can be used to search for Git
403403
objects. New objects will not be written to these directories.
404404
+
405-
Entries that begin with `"` (double-quote) will be interpreted
406-
as C-style quoted paths, removing leading and trailing
407-
double-quotes and respecting backslash escapes. E.g., the value
408-
`"path-with-\"-and-:-in-it":vanilla-path` has two paths:
409-
`path-with-"-and-:-in-it` and `vanilla-path`.
405+
Entries that begin with `"` (double-quote) will be interpreted
406+
as C-style quoted paths, removing leading and trailing
407+
double-quotes and respecting backslash escapes. E.g., the value
408+
`"path-with-\"-and-:-in-it":vanilla-path` has two paths:
409+
`path-with-"-and-:-in-it` and `vanilla-path`.
410410

411411
`GIT_DIR`::
412412
If the `GIT_DIR` environment variable is set then it

Documentation/gitattributes.txt

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -303,21 +303,21 @@ number of pitfalls:
303303
attribute. If you decide to use the `working-tree-encoding` attribute
304304
in your repository, then it is strongly recommended to ensure that all
305305
clients working with the repository support it.
306-
307-
For example, Microsoft Visual Studio resources files (`*.rc`) or
308-
PowerShell script files (`*.ps1`) are sometimes encoded in UTF-16.
309-
If you declare `*.ps1` as files as UTF-16 and you add `foo.ps1` with
310-
a `working-tree-encoding` enabled Git client, then `foo.ps1` will be
311-
stored as UTF-8 internally. A client without `working-tree-encoding`
312-
support will checkout `foo.ps1` as UTF-8 encoded file. This will
313-
typically cause trouble for the users of this file.
314-
315-
If a Git client, that does not support the `working-tree-encoding`
316-
attribute, adds a new file `bar.ps1`, then `bar.ps1` will be
317-
stored "as-is" internally (in this example probably as UTF-16).
318-
A client with `working-tree-encoding` support will interpret the
319-
internal contents as UTF-8 and try to convert it to UTF-16 on checkout.
320-
That operation will fail and cause an error.
306+
+
307+
For example, Microsoft Visual Studio resources files (`*.rc`) or
308+
PowerShell script files (`*.ps1`) are sometimes encoded in UTF-16.
309+
If you declare `*.ps1` as files as UTF-16 and you add `foo.ps1` with
310+
a `working-tree-encoding` enabled Git client, then `foo.ps1` will be
311+
stored as UTF-8 internally. A client without `working-tree-encoding`
312+
support will checkout `foo.ps1` as UTF-8 encoded file. This will
313+
typically cause trouble for the users of this file.
314+
+
315+
If a Git client, that does not support the `working-tree-encoding`
316+
attribute, adds a new file `bar.ps1`, then `bar.ps1` will be
317+
stored "as-is" internally (in this example probably as UTF-16).
318+
A client with `working-tree-encoding` support will interpret the
319+
internal contents as UTF-8 and try to convert it to UTF-16 on checkout.
320+
That operation will fail and cause an error.
321321

322322
- Reencoding content to non-UTF encodings can cause errors as the
323323
conversion might not be UTF-8 round trip safe. If you suspect your

Documentation/gitmodules.txt

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ submodule.<name>.fetchRecurseSubmodules::
6767
submodule.<name>.ignore::
6868
Defines under what circumstances "git status" and the diff family show
6969
a submodule as modified. The following values are supported:
70-
70+
+
71+
--
7172
all;; The submodule will never be considered modified (but will
7273
nonetheless show up in the output of status and commit when it has
7374
been staged).
@@ -84,12 +85,14 @@ submodule.<name>.ignore::
8485
differences, and modifications to tracked and untracked files are
8586
shown. This is the default option.
8687

87-
If this option is also present in the submodules entry in .git/config
88-
of the superproject, the setting there will override the one found in
89-
.gitmodules.
90-
Both settings can be overridden on the command line by using the
91-
"--ignore-submodule" option. The 'git submodule' commands are not
92-
affected by this setting.
88+
If this option is also present in the submodules entry in .git/config
89+
of the superproject, the setting there will override the one found in
90+
.gitmodules.
91+
92+
Both settings can be overridden on the command line by using the
93+
"--ignore-submodule" option. The 'git submodule' commands are not
94+
affected by this setting.
95+
--
9396

9497
submodule.<name>.shallow::
9598
When set to true, a clone of this submodule will be performed as a

0 commit comments

Comments
 (0)