Re: [PATCH v4 5/8] worktree: add relative cli/config options to `add` command
- From
Caleb White <cdwhite3@pm.me>
- Date
- Nov 23, 2024, 04:40 UTC
- Message-ID
- <D5TA5KT15GQL.1YOJ4I225DJNG@pm.me>
- In-Reply-To
- <7ddddf98-840d-4d36-b3bb-6d5265a1362f@gmail.com>
On Fri Nov 22, 2024 at 10:44 AM CST, phillip.wood123 wrote:
Show 20 quoted lines
> On 20/11/2024 05:01, Caleb White wrote: >> On Tue Nov 19, 2024 at 9:07 AM CST, Phillip Wood wrote: >> >>>> +--[no-]relative-paths:: >>>> + Overrides the `worktree.useRelativePaths` config option, see >>>> + linkgit:git-config[1]. >>> >>> I think it would be helpful to describe what this option does directly, >>> rather than in terms of a config setting which is documented elsewhere >>> and that may not be set >> >> I originally had a description here, but it was requested by another >> reviewer that I remove the duplicate information and simply reference >> the config option. I don't mind which direction we go, but we need >> some consensus on this. > > Oh right, from a user's point of view describing an option in terms of a > config option that may not be set seems a bit confusing. Looking at the > man page we describe --[no-]guess-remote and then mention the config > option rather than just referring the reader to the config man page.
I agree. I'll add a short description of the option here. Thanks for the feedback!
Best,
Caleb