Skip to content

Commit 48aeecd

Browse files
loopsJunio C Hamano
authored andcommitted
Fix up remaining man pages that use asciidoc "callouts".
Unfortunately docbook does not allow a callout to be referenced from inside a callout list description. Rewrite one paragraph in git-reset man page to work around this limitation. Signed-off-by: Sean Estabrooks <[email protected]>
1 parent 2eaf273 commit 48aeecd

File tree

6 files changed

+104
-108
lines changed

6 files changed

+104
-108
lines changed

Documentation/everyday.txt

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -61,25 +61,25 @@ $ git prune
6161
$ git count-objects <2>
6262
$ git repack <3>
6363
$ git prune <4>
64-
64+
------------
65+
+
6566
<1> running without "--full" is usually cheap and assures the
6667
repository health reasonably well.
6768
<2> check how many loose objects there are and how much
6869
diskspace is wasted by not repacking.
6970
<3> without "-a" repacks incrementally. repacking every 4-5MB
7071
of loose objects accumulation may be a good rule of thumb.
7172
<4> after repack, prune removes the duplicate loose objects.
72-
------------
7373

7474
Repack a small project into single pack.::
7575
+
7676
------------
7777
$ git repack -a -d <1>
7878
$ git prune
79-
79+
------------
80+
+
8081
<1> pack all the objects reachable from the refs into one pack
8182
and remove unneeded other packs
82-
------------
8383

8484

8585
Individual Developer (Standalone)[[Individual Developer (Standalone)]]
@@ -129,10 +129,10 @@ $ git-init-db
129129
$ git add . <1>
130130
$ git commit -m 'import of frotz source tree.'
131131
$ git tag v2.43 <2>
132-
132+
------------
133+
+
133134
<1> add everything under the current directory.
134135
<2> make a lightweight, unannotated tag.
135-
------------
136136

137137
Create a topic branch and develop.::
138138
+
@@ -153,7 +153,8 @@ $ git checkout master <9>
153153
$ git pull . alsa-audio <10>
154154
$ git log --since='3 days ago' <11>
155155
$ git log v2.43.. curses/ <12>
156-
156+
------------
157+
+
157158
<1> create a new topic branch.
158159
<2> revert your botched changes in "curses/ux_audio_oss.c".
159160
<3> you need to tell git if you added a new file; removal and
@@ -170,7 +171,6 @@ you originally wrote.
170171
combined and include --max-count=10 (show 10 commits), --until='2005-12-10'.
171172
<12> view only the changes that touch what's in curses/
172173
directory, since v2.43 tag.
173-
------------
174174

175175

176176
Individual Developer (Participant)[[Individual Developer (Participant)]]
@@ -208,7 +208,8 @@ $ git pull git://git.kernel.org/pub/.../jgarzik/libata-dev.git ALL <5>
208208
$ git reset --hard ORIG_HEAD <6>
209209
$ git prune <7>
210210
$ git fetch --tags <8>
211-
211+
------------
212+
+
212213
<1> repeat as needed.
213214
<2> extract patches from your branch for e-mail submission.
214215
<3> "pull" fetches from "origin" by default and merges into the
@@ -221,7 +222,6 @@ area we are interested in.
221222
<7> garbage collect leftover objects from reverted pull.
222223
<8> from time to time, obtain official tags from the "origin"
223224
and store them under .git/refs/tags/.
224-
------------
225225

226226

227227
Push into another repository.::
@@ -239,7 +239,8 @@ satellite$ git push origin <4>
239239
mothership$ cd frotz
240240
mothership$ git checkout master
241241
mothership$ git pull . satellite <5>
242-
242+
------------
243+
+
243244
<1> mothership machine has a frotz repository under your home
244245
directory; clone from it to start a repository on the satellite
245246
machine.
@@ -252,7 +253,6 @@ to local "origin" branch.
252253
mothership machine. You could use this as a back-up method.
253254
<5> on mothership machine, merge the work done on the satellite
254255
machine into the master branch.
255-
------------
256256

257257
Branch off of a specific tag.::
258258
+
@@ -262,12 +262,12 @@ $ edit/compile/test; git commit -a
262262
$ git checkout master
263263
$ git format-patch -k -m --stdout v2.6.14..private2.6.14 |
264264
git am -3 -k <2>
265-
265+
------------
266+
+
266267
<1> create a private branch based on a well known (but somewhat behind)
267268
tag.
268269
<2> forward port all changes in private2.6.14 branch to master branch
269270
without a formal "merging".
270-
------------
271271

272272

273273
Integrator[[Integrator]]
@@ -317,7 +317,8 @@ $ git tag -s -m 'GIT 0.99.9x' v0.99.9x <10>
317317
$ git fetch ko && git show-branch master maint 'tags/ko-*' <11>
318318
$ git push ko <12>
319319
$ git push ko v0.99.9x <13>
320-
320+
------------
321+
+
321322
<1> see what I was in the middle of doing, if any.
322323
<2> see what topic branches I have and think about how ready
323324
they are.
@@ -346,7 +347,6 @@ In the output from "git show-branch", "master" should have
346347
everything "ko-master" has.
347348
<12> push out the bleeding edge.
348349
<13> push the tag out, too.
349-
------------
350350

351351

352352
Repository Administration[[Repository Administration]]
@@ -367,7 +367,6 @@ example of managing a shared central repository.
367367

368368
Examples
369369
~~~~~~~~
370-
371370
Run git-daemon to serve /pub/scm from inetd.::
372371
+
373372
------------
@@ -388,13 +387,13 @@ cindy:x:1002:1002::/home/cindy:/usr/bin/git-shell
388387
david:x:1003:1003::/home/david:/usr/bin/git-shell
389388
$ grep git /etc/shells <2>
390389
/usr/bin/git-shell
391-
390+
------------
391+
+
392392
<1> log-in shell is set to /usr/bin/git-shell, which does not
393393
allow anything but "git push" and "git pull". The users should
394394
get an ssh access to the machine.
395395
<2> in many distributions /etc/shells needs to list what is used
396396
as the login shell.
397-
------------
398397

399398
CVS-style shared repository.::
400399
+
@@ -419,23 +418,23 @@ $ cat info/allowed-users <4>
419418
refs/heads/master alice\|cindy
420419
refs/heads/doc-update bob
421420
refs/tags/v[0-9]* david
422-
421+
------------
422+
+
423423
<1> place the developers into the same git group.
424424
<2> and make the shared repository writable by the group.
425425
<3> use update-hook example by Carl from Documentation/howto/
426426
for branch policy control.
427427
<4> alice and cindy can push into master, only bob can push into doc-update.
428428
david is the release manager and is the only person who can
429429
create and push version tags.
430-
------------
431430

432431
HTTP server to support dumb protocol transfer.::
433432
+
434433
------------
435434
dev$ git update-server-info <1>
436435
dev$ ftp [email protected] <2>
437436
ftp> cp -r .git /home/user/myproject.git
438-
437+
------------
438+
+
439439
<1> make sure your info/refs and objects/info/packs are up-to-date
440440
<2> upload to public HTTP server hosted by your ISP.
441-
------------

Documentation/git-checkout.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -66,19 +66,19 @@ the `Makefile` to two revisions back, deletes hello.c by
6666
mistake, and gets it back from the index.
6767
+
6868
------------
69-
$ git checkout master <1>
70-
$ git checkout master~2 Makefile <2>
69+
$ git checkout master <1>
70+
$ git checkout master~2 Makefile <2>
7171
$ rm -f hello.c
72-
$ git checkout hello.c <3>
73-
72+
$ git checkout hello.c <3>
73+
------------
74+
+
7475
<1> switch branch
7576
<2> take out a file out of other commit
76-
<3> or "git checkout -- hello.c", as in the next example.
77-
------------
77+
<3> restore hello.c from HEAD of current branch
7878
+
79-
If you have an unfortunate branch that is named `hello.c`, the
80-
last step above would be confused as an instruction to switch to
81-
that branch. You should instead write:
79+
If you have an unfortunate branch that is named `hello.c`, this
80+
step would be confused as an instruction to switch to that branch.
81+
You should instead write:
8282
+
8383
------------
8484
$ git checkout -- hello.c

Documentation/git-diff.txt

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -46,40 +46,41 @@ EXAMPLES
4646
Various ways to check your working tree::
4747
+
4848
------------
49-
$ git diff <1>
50-
$ git diff --cached <2>
51-
$ git diff HEAD <3>
52-
49+
$ git diff <1>
50+
$ git diff --cached <2>
51+
$ git diff HEAD <3>
52+
------------
53+
+
5354
<1> changes in the working tree since your last git-update-index.
5455
<2> changes between the index and your last commit; what you
5556
would be committing if you run "git commit" without "-a" option.
5657
<3> changes in the working tree since your last commit; what you
5758
would be committing if you run "git commit -a"
58-
------------
5959

6060
Comparing with arbitrary commits::
6161
+
6262
------------
63-
$ git diff test <1>
64-
$ git diff HEAD -- ./test <2>
65-
$ git diff HEAD^ HEAD <3>
66-
63+
$ git diff test <1>
64+
$ git diff HEAD -- ./test <2>
65+
$ git diff HEAD^ HEAD <3>
66+
------------
67+
+
6768
<1> instead of using the tip of the current branch, compare with the
6869
tip of "test" branch.
6970
<2> instead of comparing with the tip of "test" branch, compare with
7071
the tip of the current branch, but limit the comparison to the
7172
file "test".
7273
<3> compare the version before the last commit and the last commit.
73-
------------
7474

7575

7676
Limiting the diff output::
7777
+
7878
------------
79-
$ git diff --diff-filter=MRC <1>
80-
$ git diff --name-status -r <2>
81-
$ git diff arch/i386 include/asm-i386 <3>
82-
79+
$ git diff --diff-filter=MRC <1>
80+
$ git diff --name-status -r <2>
81+
$ git diff arch/i386 include/asm-i386 <3>
82+
------------
83+
+
8384
<1> show only modification, rename and copy, but not addition
8485
nor deletion.
8586
<2> show only names and the nature of change, but not actual
@@ -88,18 +89,17 @@ which in turn also disables recursive behaviour, so without -r
8889
you would only see the directory name if there is a change in a
8990
file in a subdirectory.
9091
<3> limit diff output to named subtrees.
91-
------------
9292

9393
Munging the diff output::
9494
+
9595
------------
96-
$ git diff --find-copies-harder -B -C <1>
97-
$ git diff -R <2>
98-
96+
$ git diff --find-copies-harder -B -C <1>
97+
$ git diff -R <2>
98+
------------
99+
+
99100
<1> spend extra cycles to find renames, copies and complete
100101
rewrites (very expensive).
101102
<2> output diff in reverse.
102-
------------
103103

104104

105105
Author

Documentation/git-init-db.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,12 @@ Start a new git repository for an existing code base::
6060
+
6161
----------------
6262
$ cd /path/to/my/codebase
63-
$ git-init-db <1>
64-
$ git-add . <2>
65-
63+
$ git-init-db <1>
64+
$ git-add . <2>
65+
----------------
66+
+
6667
<1> prepare /path/to/my/codebase/.git directory
6768
<2> add all existing file to the index
68-
----------------
6969

7070

7171
Author

0 commit comments

Comments
 (0)