Skip to content

Commit 87a8e53

Browse files
committed
Merge branch 'ja/doc-block-delimiter-markup-fix'
Doc markup updates. * ja/doc-block-delimiter-markup-fix: doc: add a blank line around block delimiters
2 parents 52241c9 + 227c4f3 commit 87a8e53

17 files changed

+73
-11
lines changed

Documentation/MyFirstContribution.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -367,6 +367,7 @@ But as we drill down, we can find that `status_init_config()` wraps a call
367367
to `git_config()`. Let's modify the code we wrote in the previous commit.
368368

369369
Be sure to include the header to allow you to use `struct wt_status`:
370+
370371
----
371372
#include "wt-status.h"
372373
----

Documentation/MyFirstObjectWalk.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,7 @@ static void final_rev_info_setup(struct rev_info *rev)
287287
====
288288
Instead of using the shorthand `add_head_to_pending()`, you could do
289289
something like this:
290+
290291
----
291292
struct setup_revision_opt opt;
292293
@@ -295,6 +296,7 @@ something like this:
295296
opt.revarg_opt = REVARG_COMMITTISH;
296297
setup_revisions(argc, argv, rev, &opt);
297298
----
299+
298300
Using a `setup_revision_opt` gives you finer control over your walk's starting
299301
point.
300302
====

Documentation/ToolsForGit.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ This is adapted from Linux's suggestion in its CodingStyle document:
3434

3535
- To follow the rules in CodingGuidelines, it's useful to put the following in
3636
GIT_CHECKOUT/.dir-locals.el, assuming you use cperl-mode:
37+
3738
----
3839
;; note the first part is useful for C editing, too
3940
((nil . ((indent-tabs-mode . t)

Documentation/git-bisect.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -495,6 +495,7 @@ $ git bisect old HEAD~10 # the tenth commit from now is marked as old
495495
------------
496496
+
497497
or:
498+
+
498499
------------
499500
$ git bisect start --term-old broken --term-new fixed
500501
$ git bisect fixed

Documentation/git-cat-file.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -322,10 +322,10 @@ of `%(objectsize)` bytes), followed by a newline.
322322

323323
For example, `--batch` without a custom format would produce:
324324

325-
------------
325+
-----------
326326
<oid> SP <type> SP <size> LF
327327
<contents> LF
328-
------------
328+
-----------
329329

330330
Whereas `--batch-check='%(objectname) %(objecttype)'` would produce:
331331

Documentation/git-check-attr.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,19 +76,22 @@ EXAMPLES
7676
--------
7777

7878
In the examples, the following '.gitattributes' file is used:
79+
7980
---------------
8081
*.java diff=java -crlf myAttr
8182
NoMyAttr.java !myAttr
8283
README caveat=unspecified
8384
---------------
8485

8586
* Listing a single attribute:
87+
+
8688
---------------
8789
$ git check-attr diff org/example/MyClass.java
8890
org/example/MyClass.java: diff: java
8991
---------------
9092
9193
* Listing multiple attributes for a file:
94+
+
9295
---------------
9396
$ git check-attr crlf diff myAttr -- org/example/MyClass.java
9497
org/example/MyClass.java: crlf: unset
@@ -97,20 +100,23 @@ org/example/MyClass.java: myAttr: set
97100
---------------
98101
99102
* Listing all attributes for a file:
103+
+
100104
---------------
101105
$ git check-attr --all -- org/example/MyClass.java
102106
org/example/MyClass.java: diff: java
103107
org/example/MyClass.java: myAttr: set
104108
---------------
105109
106110
* Listing an attribute for multiple files:
111+
+
107112
---------------
108113
$ git check-attr myAttr -- org/example/MyClass.java org/example/NoMyAttr.java
109114
org/example/MyClass.java: myAttr: set
110115
org/example/NoMyAttr.java: myAttr: unspecified
111116
---------------
112117
113118
* Not all values are equally unambiguous:
119+
+
114120
---------------
115121
$ git check-attr caveat README
116122
README: caveat: unspecified

Documentation/git-column.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ EXAMPLES
5050
--------
5151

5252
Format data by columns:
53+
+
5354
------------
5455
$ seq 1 24 | git column --mode=column --padding=5
5556
1 4 7 10 13 16 19 22
@@ -58,6 +59,7 @@ $ seq 1 24 | git column --mode=column --padding=5
5859
------------
5960

6061
Format data by rows:
62+
+
6163
------------
6264
$ seq 1 21 | git column --mode=row --padding=5
6365
1 2 3 4 5 6 7
@@ -66,6 +68,7 @@ $ seq 1 21 | git column --mode=row --padding=5
6668
------------
6769

6870
List some tags in a table with unequal column widths:
71+
+
6972
------------
7073
$ git tag --list 'v2.4.*' --column=row,dense
7174
v2.4.0 v2.4.0-rc0 v2.4.0-rc1 v2.4.0-rc2 v2.4.0-rc3

Documentation/git-cvsserver.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,9 +125,11 @@ creation in your platform (e.g. mkpasswd in Linux, encrypt in OpenBSD or
125125
pwhash in NetBSD) and paste it in the right location.
126126
127127
Then provide your password via the pserver method, for example:
128+
128129
------
129130
cvs -d:pserver:someuser:somepassword@server:/path/repo.git co <HEAD_name>
130131
------
132+
131133
No special setup is needed for SSH access, other than having Git tools
132134
in the PATH. If you have clients that do not accept the CVS_SERVER
133135
environment variable, you can rename 'git-cvsserver' to `cvs`.
@@ -138,6 +140,7 @@ CVS_SERVER directly in CVSROOT like
138140
------
139141
cvs -d ":ext;CVS_SERVER=git cvsserver:user@server/path/repo.git" co <HEAD_name>
140142
------
143+
141144
This has the advantage that it will be saved in your 'CVS/Root' files and
142145
you don't need to worry about always setting the correct environment
143146
variable. SSH users restricted to 'git-shell' don't need to override the default
@@ -168,6 +171,7 @@ All configuration variables can also be overridden for a specific method of
168171
access. Valid method names are "ext" (for SSH access) and "pserver". The
169172
following example configuration would disable pserver access while still
170173
allowing access over SSH.
174+
171175
------
172176
[gitcvs]
173177
enabled=0

Documentation/git-for-each-ref.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -441,6 +441,7 @@ Ref: %(*refname)
441441

442442
A simple example showing the use of shell eval on the output,
443443
demonstrating the use of --shell. List the prefixes of all heads:
444+
444445
------------
445446
#!/bin/sh
446447
@@ -455,6 +456,7 @@ done
455456

456457
A bit more elaborate report on tags, demonstrating that the format
457458
may be an entire script:
459+
458460
------------
459461
#!/bin/sh
460462

Documentation/git-p4.adoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ This:
8080
8181
To reproduce the entire p4 history in Git, use the '@all' modifier on
8282
the depot path:
83+
8384
------------
8485
$ git p4 clone //depot/path/project@all
8586
------------
@@ -89,19 +90,23 @@ Sync
8990
~~~~
9091
As development continues in the p4 repository, those changes can
9192
be included in the Git repository using:
93+
9294
------------
9395
$ git p4 sync
9496
------------
97+
9598
This command finds new changes in p4 and imports them as Git commits.
9699

97100
P4 repositories can be added to an existing Git repository using
98101
'git p4 sync' too:
102+
99103
------------
100104
$ mkdir repo-git
101105
$ cd repo-git
102106
$ git init
103107
$ git p4 sync //path/in/your/perforce/depot
104108
------------
109+
105110
This imports the specified depot into
106111
'refs/remotes/p4/master' in an existing Git repository. The
107112
`--branch` option can be used to specify a different branch to
@@ -125,6 +130,7 @@ and merge them with local uncommitted changes. Often, the p4 repository
125130
is the ultimate location for all code, thus a rebase workflow makes
126131
sense. This command does 'git p4 sync' followed by 'git rebase' to move
127132
local commits on top of updated p4 changes.
133+
128134
------------
129135
$ git p4 rebase
130136
------------
@@ -140,16 +146,19 @@ will be created and populated if it does not already exist.
140146

141147
To submit all changes that are in the current Git branch but not in
142148
the 'p4/master' branch, use:
149+
143150
------------
144151
$ git p4 submit
145152
------------
146153

147154
To specify a branch other than the current one, use:
155+
148156
------------
149157
$ git p4 submit topicbranch
150158
------------
151159

152160
To specify a single commit or a range of commits, use:
161+
153162
------------
154163
$ git p4 submit --commit <sha1>
155164
$ git p4 submit --commit <sha1..sha1>
@@ -510,20 +519,24 @@ when cloning or syncing to have 'git p4' automatically find
510519
subdirectories in p4, and to generate these as branches in Git.
511520
512521
For example, if the P4 repository structure is:
522+
513523
----
514524
//depot/main/...
515525
//depot/branch1/...
516526
----
517527
518528
And "p4 branch -o branch1" shows a View line that looks like:
529+
519530
----
520531
//depot/main/... //depot/branch1/...
521532
----
522533
523534
Then this 'git p4 clone' command:
535+
524536
----
525537
git p4 clone --detect-branches //depot@all
526538
----
539+
527540
produces a separate branch in 'refs/remotes/p4/' for //depot/main,
528541
called 'master', and one for //depot/branch1 called 'depot/branch1'.
529542
@@ -536,6 +549,7 @@ simple p4 branch specification, where the "source" and "destination" are
536549
the path elements in the p4 repository. The example above relied on the
537550
presence of the p4 branch. Without p4 branches, the same result will
538551
occur with:
552+
539553
----
540554
git init depot
541555
cd depot

Documentation/git-rebase.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1107,10 +1107,12 @@ In that case, the fix is easy because 'git rebase' knows to skip
11071107
changes that are already present in the new upstream (unless
11081108
`--reapply-cherry-picks` is given). So if you say
11091109
(assuming you're on 'topic')
1110+
11101111
------------
11111112
$ git rebase subsystem
11121113
------------
11131114
you will end up with the fixed history
1115+
11141116
------------
11151117
o---o---o---o---o---o---o---o master
11161118
\
@@ -1145,6 +1147,7 @@ of the old 'subsystem', for example:
11451147

11461148
You can then transplant the old `subsystem..topic` to the new tip by
11471149
saying (for the reflog case, and assuming you are on 'topic' already):
1150+
11481151
------------
11491152
$ git rebase --onto subsystem subsystem@{1}
11501153
------------

Documentation/gitattributes.adoc

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -531,13 +531,14 @@ must not send any response before it received the content and the
531531
final flush packet. Also note that the "value" of a "key=value" pair
532532
can contain the "=" character whereas the key would never contain
533533
that character.
534-
------------------------
534+
535+
-----------------------
535536
packet: git> command=smudge
536537
packet: git> pathname=path/testfile.dat
537538
packet: git> 0000
538539
packet: git> CONTENT
539540
packet: git> 0000
540-
------------------------
541+
-----------------------
541542

542543
The filter is expected to respond with a list of "key=value" pairs
543544
terminated with a flush packet. If the filter does not experience
@@ -559,6 +560,7 @@ packet: git< 0000 # empty list, keep "status=success" unchanged!
559560

560561
If the result content is empty then the filter is expected to respond
561562
with a "success" status and a flush packet to signal the empty content.
563+
562564
------------------------
563565
packet: git< status=success
564566
packet: git< 0000
@@ -568,14 +570,16 @@ packet: git< 0000 # empty list, keep "status=success" unchanged!
568570

569571
In case the filter cannot or does not want to process the content,
570572
it is expected to respond with an "error" status.
571-
------------------------
573+
574+
-----------------------
572575
packet: git< status=error
573576
packet: git< 0000
574-
------------------------
577+
-----------------------
575578

576579
If the filter experiences an error during processing, then it can
577580
send the status "error" after the content was (partially or
578581
completely) sent.
582+
579583
------------------------
580584
packet: git< status=success
581585
packet: git< 0000
@@ -589,10 +593,11 @@ In case the filter cannot or does not want to process the content
589593
as well as any future content for the lifetime of the Git process,
590594
then it is expected to respond with an "abort" status at any point
591595
in the protocol.
592-
------------------------
596+
597+
-----------------------
593598
packet: git< status=abort
594599
packet: git< 0000
595-
------------------------
600+
-----------------------
596601

597602
Git neither stops nor restarts the filter process in case the
598603
"error"/"abort" status is set. However, Git sets its exit code
@@ -613,7 +618,8 @@ flag "can-delay" after the filter command and pathname. This flag
613618
denotes that the filter can delay filtering the current blob (e.g. to
614619
compensate network latencies) by responding with no content but with
615620
the status "delayed" and a flush packet.
616-
------------------------
621+
622+
-----------------------
617623
packet: git> command=smudge
618624
packet: git> pathname=path/testfile.dat
619625
packet: git> can-delay=1
@@ -622,7 +628,7 @@ packet: git> CONTENT
622628
packet: git> 0000
623629
packet: git< status=delayed
624630
packet: git< 0000
625-
------------------------
631+
-----------------------
626632

627633
If the filter supports the "delay" capability then it must support the
628634
"list_available_blobs" command. If Git sends this command, then the
@@ -647,10 +653,12 @@ packet: git< status=success
647653
packet: git< 0000
648654
------------------------
649655

656+
650657
After Git received the pathnames, it will request the corresponding
651658
blobs again. These requests contain a pathname and an empty content
652659
section. The filter is expected to respond with the smudged content
653660
in the usual way as explained above.
661+
654662
------------------------
655663
packet: git> command=smudge
656664
packet: git> pathname=path/testfile.dat

Documentation/gitcli.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,13 +209,13 @@ $ git foo -o Arg
209209
210210
However, this is *NOT* allowed for switches with an optional value, where the
211211
'stuck' form must be used:
212+
212213
----------------------------
213214
$ git describe --abbrev HEAD # correct
214215
$ git describe --abbrev=10 HEAD # correct
215216
$ git describe --abbrev 10 HEAD # NOT WHAT YOU MEANT
216217
----------------------------
217218
218-
219219
NOTES ON FREQUENTLY CONFUSED OPTIONS
220220
------------------------------------
221221

0 commit comments

Comments
 (0)