Thread (3 messages) 3 messages, 3 authors, 2025-08-05

Re: [PATCH v7 0/3] Introduce git-last-modified(1) command

From: Jean-Noël AVILA <hidden>
Date: 2025-08-05 17:20:09

On Tuesday, 5 August 2025 18:55:14 CEST Toon Claes wrote:
Junio C Hamano [off-list ref] writes:
quoted
I am happy with the updates, but am wondering if documentation
update along the lines of attached patch is also needed.
Ah (annoyed grunt), I should have added backticks. Yes. I missed those,
sorry about that.
quoted
I am not sure about the last two, i.e. things that are not dash+option
appearing as enumeration labels, though (and Cc'ing Jean-Noël to ask
for help).
Well, this gave me a nice opportunity to test Jean-Noël proposed docs
linter[1].

    $ make check-docs
    [snip
    git-last-modified.adoc:25: '-r::' synopsis style and definition list 
item not
backquoted git-last-modified.adoc:26: '--recursive::' synopsis style and
definition list item not backquoted git-last-modified.adoc:30: '-t::' 
synopsis
style and definition list item not backquoted git-last-modified.adoc:31:
'--show-trees::' synopsis style and definition list item not backquoted

It seems only dashed options should be backquoted.

[1]: https://lore.kernel.org/git/pull.1945.git.
1754399033.gitgitgadget@gmail.com/

Well, the check fails to catch all the missing cases: The last two terms 
should also be formatted. For the <revision-range>, you can either enclose it 
with underscores (as a placeholder) or with backticks (which the formatter 
formats like a placeholder). For the last one, backticks are definitely needed 
to differentiate the formatting between the placeholder and the syntax marks.

As for my patch series, this can definitely be checked. will reroll.

Thanks

Jean-Noël


Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help