git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 2/2] git-worktree.txt: add missing `-v` to synopsis for `worktree list`

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Dec 3, 2021, 14:57 UTC
Message-ID
<211203.865ys5soqk.gmgdl@evledraar.gmail.com>
In-Reply-To
<CAPig+cR7f1koM7d2GoHMcDhZkQe3=XJD2RVuMajXSpcwZiyGtQ@mail.gmail.com>
On Fri, Dec 03 2021, Eric Sunshine wrote:
Show 24 quoted lines
> On Fri, Dec 3, 2021 at 4:15 AM Ævar Arnfjörð Bjarmason <avarab@gmail.com> wrote:
>> On Thu, Dec 02 2021, Eric Sunshine wrote:
>> > -'git worktree list' [--porcelain]
>> > +'git worktree list' [-v | --porcelain]
>>
>> Aside: I've been thinking of hacking something up to just change all
>> these "[verse]" bits in the *.txt source to:
>>
>>     [verse]
>>     $(git worktree -h)
>>
>> And then have the doc build process pick that up, run 'git $name -h', do
>> some light search/replacement (e.g. "$cmd" to "'$cmd'") and build the
>> docs like that.
>>
>> Seems far preferrable to dual-maintaining all of these forever.
>>
>> But in the meantime this small fix is obviously correct.
>
> One caution that springs to mind is that there may be external tooling
> which processes these documentation files directly, and such a change
> might break them. (The one which popped to mind immediately was the
> git-scm.{org,com} website, though I don't know what their tooling
> looks like.)

True, I hadn't looked into how that worked before, but behold! https://github.com/git/git-scm.com/blob/main/lib/tasks/index.rake

It seems to be a re-implementation of a non-trivial part of the doc building process.

In any case, if we do end up generating more of the documentation ourselves presumably any such concerns will be brought up then.

Previous: Eric SunshineNext: Jeff King
Message 8 of 14 in “worktree: fix incorrectly-ordered messages on Windows”
  1. 0/2 worktree: fix incorrectly-ordered messages on WindowsEric Sunshine, Dec 3, 2021
  2. 1/2 worktree: send "chatty" messages to stderrEric Sunshine, Dec 3, 2021
  3. Ævar Arnfjörð BjarmasonDec 3, 2021
  4. Eric SunshineDec 3, 2021
  5. 2/2 git-worktree.txt: add missing `-v` to synopsis for `worktree list`Eric Sunshine, Dec 3, 2021
  6. Ævar Arnfjörð BjarmasonDec 3, 2021
  7. Eric SunshineDec 3, 2021
  8. Ævar Arnfjörð BjarmasonDec 3, 2021
  9. Jeff KingDec 3, 2021
  10. Junio C HamanoDec 5, 2021
  11. Eric SunshineDec 6, 2021
  12. Ævar Arnfjörð BjarmasonDec 6, 2021
  13. Junio C HamanoDec 6, 2021
  14. Rafael SilvaDec 11, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.