Skip to content

Commit e66316f

Browse files
committed
Merge branch 'kh/doc-continued-paragraph-fix' into next
Doc mark-up fixes. * kh/doc-continued-paragraph-fix: doc: fix accidental literal blocks
2 parents 0e970d5 + b3ac6e7 commit e66316f

File tree

5 files changed

+64
-48
lines changed

5 files changed

+64
-48
lines changed

Documentation/config/core.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ The built-in file system monitor is currently available only on a
7575
limited set of supported platforms. Currently, this includes Windows
7676
and MacOS.
7777
+
78-
Otherwise, this variable contains the pathname of the "fsmonitor"
79-
hook command.
78+
Otherwise, this variable contains the pathname of the "fsmonitor"
79+
hook command.
8080
+
8181
This hook command is used to identify all files that may have changed
8282
since the requested date/time. This information is used to speed up

Documentation/git-config.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -117,15 +117,15 @@ OPTIONS
117117

118118
--comment <message>::
119119
Append a comment at the end of new or modified lines.
120-
121-
If _<message>_ begins with one or more whitespaces followed
122-
by "#", it is used as-is. If it begins with "#", a space is
123-
prepended before it is used. Otherwise, a string " # " (a
124-
space followed by a hash followed by a space) is prepended
125-
to it. And the resulting string is placed immediately after
126-
the value defined for the variable. The _<message>_ must
127-
not contain linefeed characters (no multi-line comments are
128-
permitted).
120+
+
121+
If _<message>_ begins with one or more whitespaces followed
122+
by "#", it is used as-is. If it begins with "#", a space is
123+
prepended before it is used. Otherwise, a string " # " (a
124+
space followed by a hash followed by a space) is prepended
125+
to it. And the resulting string is placed immediately after
126+
the value defined for the variable. The _<message>_ must
127+
not contain linefeed characters (no multi-line comments are
128+
permitted).
129129

130130
--all::
131131
With `get`, return all values for a multi-valued key.

Documentation/git-rev-parse.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -174,13 +174,13 @@ for another option.
174174

175175
Allow oids to be input from any object format that the current
176176
repository supports.
177-
178-
Specifying "sha1" translates if necessary and returns a sha1 oid.
179-
180-
Specifying "sha256" translates if necessary and returns a sha256 oid.
181-
182-
Specifying "storage" translates if necessary and returns an oid in
183-
encoded in the storage hash algorithm.
177+
+
178+
Specifying "sha1" translates if necessary and returns a sha1 oid.
179+
+
180+
Specifying "sha256" translates if necessary and returns a sha256 oid.
181+
+
182+
Specifying "storage" translates if necessary and returns an oid in
183+
encoded in the storage hash algorithm.
184184

185185
Options for Objects
186186
~~~~~~~~~~~~~~~~~~~

Documentation/git-shortlog.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ OPTIONS
4444
describe each commit. '<format>' can be any string accepted
4545
by the `--format` option of 'git log', such as '* [%h] %s'.
4646
(See the "PRETTY FORMATS" section of linkgit:git-log[1].)
47-
48-
Each pretty-printed commit will be rewrapped before it is shown.
47+
+
48+
Each pretty-printed commit will be rewrapped before it is shown.
4949

5050
--date=<format>::
5151
Show dates formatted according to the given date string. (See

Documentation/git-sparse-checkout.adoc

Lines changed: 44 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -295,34 +295,50 @@ patterns in non-cone mode has a number of shortcomings:
295295
inconsistent.
296296

297297
* It has edge cases where the "right" behavior is unclear. Two examples:
298-
299-
First, two users are in a subdirectory, and the first runs
300-
git sparse-checkout set '/toplevel-dir/*.c'
301-
while the second runs
302-
git sparse-checkout set relative-dir
303-
Should those arguments be transliterated into
304-
current/subdirectory/toplevel-dir/*.c
305-
and
306-
current/subdirectory/relative-dir
307-
before inserting into the sparse-checkout file? The user who typed
308-
the first command is probably aware that arguments to set/add are
309-
supposed to be patterns in non-cone mode, and probably would not be
310-
happy with such a transliteration. However, many gitignore-style
311-
patterns are just paths, which might be what the user who typed the
312-
second command was thinking, and they'd be upset if their argument
313-
wasn't transliterated.
314-
315-
Second, what should bash-completion complete on for set/add commands
316-
for non-cone users? If it suggests paths, is it exacerbating the
317-
problem above? Also, if it suggests paths, what if the user has a
318-
file or directory that begins with either a '!' or '#' or has a '*',
319-
'\', '?', '[', or ']' in its name? And if it suggests paths, will
320-
it complete "/pro" to "/proc" (in the root filesystem) rather than to
321-
"/progress.txt" in the current directory? (Note that users are
322-
likely to want to start paths with a leading '/' in non-cone mode,
323-
for the same reason that .gitignore files often have one.)
324-
Completing on files or directories might give nasty surprises in
325-
all these cases.
298+
+
299+
First, two users are in a subdirectory, and the first runs
300+
+
301+
----
302+
git sparse-checkout set '/toplevel-dir/*.c'
303+
----
304+
+
305+
while the second runs
306+
+
307+
----
308+
git sparse-checkout set relative-dir
309+
----
310+
+
311+
Should those arguments be transliterated into
312+
+
313+
----
314+
current/subdirectory/toplevel-dir/*.c
315+
----
316+
+
317+
and
318+
+
319+
----
320+
current/subdirectory/relative-dir
321+
----
322+
+
323+
before inserting into the sparse-checkout file? The user who typed
324+
the first command is probably aware that arguments to set/add are
325+
supposed to be patterns in non-cone mode, and probably would not be
326+
happy with such a transliteration. However, many gitignore-style
327+
patterns are just paths, which might be what the user who typed the
328+
second command was thinking, and they'd be upset if their argument
329+
wasn't transliterated.
330+
+
331+
Second, what should bash-completion complete on for set/add commands
332+
for non-cone users? If it suggests paths, is it exacerbating the
333+
problem above? Also, if it suggests paths, what if the user has a
334+
file or directory that begins with either a '!' or '#' or has a '*',
335+
'\', '?', '[', or ']' in its name? And if it suggests paths, will
336+
it complete "/pro" to "/proc" (in the root filesystem) rather than to
337+
"/progress.txt" in the current directory? (Note that users are
338+
likely to want to start paths with a leading '/' in non-cone mode,
339+
for the same reason that .gitignore files often have one.)
340+
Completing on files or directories might give nasty surprises in
341+
all these cases.
326342

327343
* The excessive flexibility made other extensions essentially
328344
impractical. `--sparse-index` is likely impossible in non-cone

0 commit comments

Comments
 (0)