Re: [PATCH 1/5] multi-pack-index: prepare for 'expire' verb

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 12/10/2018 8:59 PM, SZEDER Gábor wrote:
On Mon, Dec 10, 2018 at 05:35:28PM -0800, Stefan Beller wrote:
On Mon, Dec 10, 2018 at 10:06 AM Derrick Stolee via GitGitGadget
<gitgitgadget@xxxxxxxxx> wrote:
+expire::
+       When given as the verb,
Can it be given in another way? Or rather "if the verb is expire",
then ...
(I just checked the current man page, and both write and verify use
this pattern as well. I find it strange as this first part of the sentence
conveys little information, but is repeated 3 times now (once for
each verb)).

Maybe we can restructure the man page to have it more like

     The following verbs are available:
     +write::
     +    create a new MIDX file, writing to <dir>/packs/multi-pack-index.
     +
     +verify::
     +    verify the contents ...
I think a s/verb/subcommand/ would help a lot, too, because that's
what we call it everywhere else.

Thanks, both. V2 will include a new patch that reformats the doc to use these suggestions, then extend it for the new subcommand.

-Stolee




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux