Re: [PATCH v1 1/2] api-trace2.txt: print config key-value pair
From: Junio C Hamano <hidden>
Date: 2022-07-25 19:07:16
Ævar Arnfjörð Bjarmason [off-list ref] writes:
On Fri, Jul 22 2022, tenglong.tl wrote: ...quoted
+Print Configs:: + + Dump "interesting" config values to trace2 log. ++ +The environment variable `GIT_TRACE2_CONFIG_PARAMS` and configuration +`trace2.configparams` can be used to output config values which you care +about(see linkgit:git-config[1). For example:I didn't notice this before, but this is an addition to a long section where the examples are ------- delimited, starting with "in this example.." usually. So this "print configs" seems like on odd continuation. Shouldn't this copy the template of "Thread Events::" above. I.e. something like (I have not tried to asciidoc render this): Config (def param) Events:: We can optionally emit configuration events, see `trace2.configParams` in linkgit:git-config[1] for how to enable it. + < your example below would follow this> I.e. re my earlier mention of git-config we it explains GIT_TRACE2_CONFIG_PARAMS, so perhaps it suffices to just link to linkgit:git-config[1] for that. Also a nit: trace2.configParams, not trace2.configparams.
These may be worth fixing, regardless of the "adding scope in the example needs to wait until 2/2" I pointed out separately. Thanks.