Swap the porcelain and plumbing commands in the git man page
This makes the documentation less confusing to newcomers. Signed-off-by: Robin Rosenberg <robin.rosenberg@dewire.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
Robin Rosenberg committed
Oct 29, 2006 at 21:09 UTC
b1f33d626501c3e080b324e182f1da76f49b5bf9
1 file changed
+182
-182
Documentation/git.txt
+182
-182
@@ -72,188 +72,6 @@ GIT COMMANDS
72
We divide git into high level ("porcelain") commands and low level
73
("plumbing") commands.
74
75
-Low-level commands (plumbing)
76
------------------------------
77
-
78
-Although git includes its
79
-own porcelain layer, its low-level commands are sufficient to support
80
-development of alternative porcelains. Developers of such porcelains
81
-might start by reading about gitlink:git-update-index[1] and
82
-gitlink:git-read-tree[1].
83
-
84
-We divide the low-level commands into commands that manipulate objects (in
85
-the repository, index, and working tree), commands that interrogate and
86
-compare objects, and commands that move objects and references between
87
-repositories.
88
-
89
-Manipulation commands
90
-~~~~~~~~~~~~~~~~~~~~~
91
-gitlink:git-apply[1]::
92
- Reads a "diff -up1" or git generated patch file and
93
- applies it to the working tree.
94
-
95
-gitlink:git-checkout-index[1]::
96
- Copy files from the index to the working tree.
97
-
98
-gitlink:git-commit-tree[1]::
99
- Creates a new commit object.
100
-
101
-gitlink:git-hash-object[1]::
102
- Computes the object ID from a file.
103
-
104
-gitlink:git-index-pack[1]::
105
- Build pack idx file for an existing packed archive.
106
-
107
-gitlink:git-init-db[1]::
108
- Creates an empty git object database, or reinitialize an
109
- existing one.
110
-
111
-gitlink:git-merge-index[1]::
112
- Runs a merge for files needing merging.
113
-
114
-gitlink:git-mktag[1]::
115
- Creates a tag object.
116
-
117
-gitlink:git-mktree[1]::
118
- Build a tree-object from ls-tree formatted text.
119
-
120
-gitlink:git-pack-objects[1]::
121
- Creates a packed archive of objects.
122
-
123
-gitlink:git-prune-packed[1]::
124
- Remove extra objects that are already in pack files.
125
-
126
-gitlink:git-read-tree[1]::
127
- Reads tree information into the index.
128
-
129
-gitlink:git-repo-config[1]::
130
- Get and set options in .git/config.
131
-
132
-gitlink:git-unpack-objects[1]::
133
- Unpacks objects out of a packed archive.
134
-
135
-gitlink:git-update-index[1]::
136
- Registers files in the working tree to the index.
137
-
138
-gitlink:git-write-tree[1]::
139
- Creates a tree from the index.
140
-
141
-
142
-Interrogation commands
143
-~~~~~~~~~~~~~~~~~~~~~~
144
-
145
-gitlink:git-cat-file[1]::
146
- Provide content or type/size information for repository objects.
147
-
148
-gitlink:git-describe[1]::
149
- Show the most recent tag that is reachable from a commit.
150
-
151
-gitlink:git-diff-index[1]::
152
- Compares content and mode of blobs between the index and repository.
153
-
154
-gitlink:git-diff-files[1]::
155
- Compares files in the working tree and the index.
156
-
157
-gitlink:git-diff-stages[1]::
158
- Compares two "merge stages" in the index.
159
-
160
-gitlink:git-diff-tree[1]::
161
- Compares the content and mode of blobs found via two tree objects.
162
-
163
-gitlink:git-for-each-ref[1]::
164
- Output information on each ref.
165
-
166
-gitlink:git-fsck-objects[1]::
167
- Verifies the connectivity and validity of the objects in the database.
168
-
169
-gitlink:git-ls-files[1]::
170
- Information about files in the index and the working tree.
171
-
172
-gitlink:git-ls-tree[1]::
173
- Displays a tree object in human readable form.
174
-
175
-gitlink:git-merge-base[1]::
176
- Finds as good common ancestors as possible for a merge.
177
-
178
-gitlink:git-name-rev[1]::
179
- Find symbolic names for given revs.
180
-
181
-gitlink:git-pack-redundant[1]::
182
- Find redundant pack files.
183
-
184
-gitlink:git-rev-list[1]::
185
- Lists commit objects in reverse chronological order.
186
-
187
-gitlink:git-show-index[1]::
188
- Displays contents of a pack idx file.
189
-
190
-gitlink:git-tar-tree[1]::
191
- Creates a tar archive of the files in the named tree object.
192
-
193
-gitlink:git-unpack-file[1]::
194
- Creates a temporary file with a blob's contents.
195
-
196
-gitlink:git-var[1]::
197
- Displays a git logical variable.
198
-
199
-gitlink:git-verify-pack[1]::
200
- Validates packed git archive files.
201
-
202
-In general, the interrogate commands do not touch the files in
203
-the working tree.
204
-
205
-
206
-Synching repositories
207
-~~~~~~~~~~~~~~~~~~~~~
208
-
209
-gitlink:git-fetch-pack[1]::
210
- Updates from a remote repository (engine for ssh and
211
- local transport).
212
-
213
-gitlink:git-http-fetch[1]::
214
- Downloads a remote git repository via HTTP by walking
215
- commit chain.
216
-
217
-gitlink:git-local-fetch[1]::
218
- Duplicates another git repository on a local system by
219
- walking commit chain.
220
-
221
-gitlink:git-peek-remote[1]::
222
- Lists references on a remote repository using
223
- upload-pack protocol (engine for ssh and local
224
- transport).
225
-
226
-gitlink:git-receive-pack[1]::
227
- Invoked by 'git-send-pack' to receive what is pushed to it.
228
-
229
-gitlink:git-send-pack[1]::
230
- Pushes to a remote repository, intelligently.
231
-
232
-gitlink:git-http-push[1]::
233
- Push missing objects using HTTP/DAV.
234
-
235
-gitlink:git-shell[1]::
236
- Restricted shell for GIT-only SSH access.
237
-
238
-gitlink:git-ssh-fetch[1]::
239
- Pulls from a remote repository over ssh connection by
240
- walking commit chain.
241
-
242
-gitlink:git-ssh-upload[1]::
243
- Helper "server-side" program used by git-ssh-fetch.
244
-
245
-gitlink:git-update-server-info[1]::
246
- Updates auxiliary information on a dumb server to help
247
- clients discover references and packs on it.
248
-
249
-gitlink:git-upload-archive[1]::
250
- Invoked by 'git-archive' to send a generated archive.
251
-
252
-gitlink:git-upload-pack[1]::
253
- Invoked by 'git-fetch-pack' to push
254
- what are asked for.
255
-
256
-
75
High-level commands (porcelain)
76
-------------------------------
77
@@ -491,6 +309,188 @@ gitlink:git-stripspace[1]::
309
Filter out empty lines.
310
311
312
+Low-level commands (plumbing)
313
+-----------------------------
314
+
315
+Although git includes its
316
+own porcelain layer, its low-level commands are sufficient to support
317
+development of alternative porcelains. Developers of such porcelains
318
+might start by reading about gitlink:git-update-index[1] and
319
+gitlink:git-read-tree[1].
320
+
321
+We divide the low-level commands into commands that manipulate objects (in
322
+the repository, index, and working tree), commands that interrogate and
323
+compare objects, and commands that move objects and references between
324
+repositories.
325
+
326
+Manipulation commands
327
+~~~~~~~~~~~~~~~~~~~~~
328
+gitlink:git-apply[1]::
329
+ Reads a "diff -up1" or git generated patch file and
330
+ applies it to the working tree.
331
+
332
+gitlink:git-checkout-index[1]::
333
+ Copy files from the index to the working tree.
334
+
335
+gitlink:git-commit-tree[1]::
336
+ Creates a new commit object.
337
+
338
+gitlink:git-hash-object[1]::
339
+ Computes the object ID from a file.
340
+
341
+gitlink:git-index-pack[1]::
342
+ Build pack idx file for an existing packed archive.
343
+
344
+gitlink:git-init-db[1]::
345
+ Creates an empty git object database, or reinitialize an
346
+ existing one.
347
+
348
+gitlink:git-merge-index[1]::
349
+ Runs a merge for files needing merging.
350
+
351
+gitlink:git-mktag[1]::
352
+ Creates a tag object.
353
+
354
+gitlink:git-mktree[1]::
355
+ Build a tree-object from ls-tree formatted text.
356
+
357
+gitlink:git-pack-objects[1]::
358
+ Creates a packed archive of objects.
359
+
360
+gitlink:git-prune-packed[1]::
361
+ Remove extra objects that are already in pack files.
362
+
363
+gitlink:git-read-tree[1]::
364
+ Reads tree information into the index.
365
+
366
+gitlink:git-repo-config[1]::
367
+ Get and set options in .git/config.
368
+
369
+gitlink:git-unpack-objects[1]::
370
+ Unpacks objects out of a packed archive.
371
+
372
+gitlink:git-update-index[1]::
373
+ Registers files in the working tree to the index.
374
+
375
+gitlink:git-write-tree[1]::
376
+ Creates a tree from the index.
377
+
378
+
379
+Interrogation commands
380
+~~~~~~~~~~~~~~~~~~~~~~
381
+
382
+gitlink:git-cat-file[1]::
383
+ Provide content or type/size information for repository objects.
384
+
385
+gitlink:git-describe[1]::
386
+ Show the most recent tag that is reachable from a commit.
387
+
388
+gitlink:git-diff-index[1]::
389
+ Compares content and mode of blobs between the index and repository.
390
+
391
+gitlink:git-diff-files[1]::
392
+ Compares files in the working tree and the index.
393
+
394
+gitlink:git-diff-stages[1]::
395
+ Compares two "merge stages" in the index.
396
+
397
+gitlink:git-diff-tree[1]::
398
+ Compares the content and mode of blobs found via two tree objects.
399
+
400
+gitlink:git-for-each-ref[1]::
401
+ Output information on each ref.
402
+
403
+gitlink:git-fsck-objects[1]::
404
+ Verifies the connectivity and validity of the objects in the database.
405
+
406
+gitlink:git-ls-files[1]::
407
+ Information about files in the index and the working tree.
408
+
409
+gitlink:git-ls-tree[1]::
410
+ Displays a tree object in human readable form.
411
+
412
+gitlink:git-merge-base[1]::
413
+ Finds as good common ancestors as possible for a merge.
414
+
415
+gitlink:git-name-rev[1]::
416
+ Find symbolic names for given revs.
417
+
418
+gitlink:git-pack-redundant[1]::
419
+ Find redundant pack files.
420
+
421
+gitlink:git-rev-list[1]::
422
+ Lists commit objects in reverse chronological order.
423
+
424
+gitlink:git-show-index[1]::
425
+ Displays contents of a pack idx file.
426
+
427
+gitlink:git-tar-tree[1]::
428
+ Creates a tar archive of the files in the named tree object.
429
+
430
+gitlink:git-unpack-file[1]::
431
+ Creates a temporary file with a blob's contents.
432
+
433
+gitlink:git-var[1]::
434
+ Displays a git logical variable.
435
+
436
+gitlink:git-verify-pack[1]::
437
+ Validates packed git archive files.
438
+
439
+In general, the interrogate commands do not touch the files in
440
+the working tree.
441
+
442
+
443
+Synching repositories
444
+~~~~~~~~~~~~~~~~~~~~~
445
+
446
+gitlink:git-fetch-pack[1]::
447
+ Updates from a remote repository (engine for ssh and
448
+ local transport).
449
+
450
+gitlink:git-http-fetch[1]::
451
+ Downloads a remote git repository via HTTP by walking
452
+ commit chain.
453
+
454
+gitlink:git-local-fetch[1]::
455
+ Duplicates another git repository on a local system by
456
+ walking commit chain.
457
+
458
+gitlink:git-peek-remote[1]::
459
+ Lists references on a remote repository using
460
+ upload-pack protocol (engine for ssh and local
461
+ transport).
462
+
463
+gitlink:git-receive-pack[1]::
464
+ Invoked by 'git-send-pack' to receive what is pushed to it.
465
+
466
+gitlink:git-send-pack[1]::
467
+ Pushes to a remote repository, intelligently.
468
+
469
+gitlink:git-http-push[1]::
470
+ Push missing objects using HTTP/DAV.
471
+
472
+gitlink:git-shell[1]::
473
+ Restricted shell for GIT-only SSH access.
474
+
475
+gitlink:git-ssh-fetch[1]::
476
+ Pulls from a remote repository over ssh connection by
477
+ walking commit chain.
478
+
479
+gitlink:git-ssh-upload[1]::
480
+ Helper "server-side" program used by git-ssh-fetch.
481
+
482
+gitlink:git-update-server-info[1]::
483
+ Updates auxiliary information on a dumb server to help
484
+ clients discover references and packs on it.
485
+
486
+gitlink:git-upload-archive[1]::
487
+ Invoked by 'git-archive' to send a generated archive.
488
+
489
+gitlink:git-upload-pack[1]::
490
+ Invoked by 'git-fetch-pack' to push
491
+ what are asked for.
492
+
493
+
494
Configuration Mechanism
495
-----------------------
496