On Sat, Dec 5, 2020 at 2:39 AM Ævar Arnfjörð Bjarmason <avarab@xxxxxxxxx> wrote: > > Change the documentation for the various %(trailers) options so it > isn't repeating part of the documentation for "only" about how boolean > values are handled. Instead let's split the description of that into > general documentation at the top. Great! > It then suffices to refer to it by listing the options as > "opt[=bool]". I'm also changing it to "[=bool]" from "[=val]". Nice! I wonder if "[=<bool>]" or "[=<BOOL>]" might be even better as we use "=<K>" for key and "=<SEP>" for separator. > It took > me a couple of readings to realize that while to realize that these > options were referring back to the "only" option's treatment of > boolean values. Let's try to make this more explicit. Yeah, it's definitely an improvement. > --- a/Documentation/pretty-formats.txt > +++ b/Documentation/pretty-formats.txt > @@ -252,7 +252,14 @@ endif::git-rev-list[] > interpreted by > linkgit:git-interpret-trailers[1]. The > `trailers` string may be followed by a colon > - and zero or more comma-separated options: > + and zero or more comma-separated options. > ++ > +The boolean options accept an optional value. The values `true`, Maybe: s/an optional value./an optional value `[=<BOOL>]`./ > +`false`, `on`, `off` etc. are all accepted. See the "boolean" > +sub-section in "EXAMPLES" in linkgit:git-config[1]. If a boolean > +option is given with no value it's enabled. s/value it's enabled/value, it's enabled/ > +If any option is provided multiple times the last occurance wins. It might be better to have this sentence before the above paragraph about boolean options, as it's more general. Thanks, Christian.
