Docs: rearrange subcommands for multi-pack-index
We will add new subcommands to the multi-pack-index, and that will make the documentation a bit messier. Clean up the 'verb' descriptions by renaming the concept to 'subcommand' and removing the reference to the object directory. Helped-by: Stefan Beller <sbeller@google.com> Helped-by: Szeder Gábor <szeder.dev@gmail.com> Signed-off-by: Derrick Stolee <dstolee@microsoft.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Derrick Stolee committed
Jun 10, 2019 at 16:35 UTC
81efa161546d8fc9a89f2565d912137df8cc6c89
1 file changed
+5
-5
Documentation/git-multi-pack-index.txt
+5
-5
@@ -9,7 +9,7 @@ git-multi-pack-index - Write and verify multi-pack-indexes
9
SYNOPSIS
10
--------
11
[verse]
12
-'git multi-pack-index' [--object-dir=<dir>] <verb>
12
+'git multi-pack-index' [--object-dir=<dir>] <subcommand>
13
14
DESCRIPTION
15
-----------
@@ -23,13 +23,13 @@ OPTIONS
23
`<dir>/packs/multi-pack-index` for the current MIDX file, and
24
`<dir>/packs` for the pack-files to index.
25
26
+The following subcommands are available:
27
+
28
write::
27
- When given as the verb, write a new MIDX file to
28
- `<dir>/packs/multi-pack-index`.
29
+ Write a new MIDX file.
30
31
verify::
31
- When given as the verb, verify the contents of the MIDX file
32
- at `<dir>/packs/multi-pack-index`.
32
+ Verify the contents of the MIDX file.
33
34
35
EXAMPLES