diff options
author | Ævar Arnfjörð Bjarmason <avarab@gmail.com> | 2022-10-13 18:39:09 +0300 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2022-10-13 19:32:56 +0300 |
commit | a0c3244796e22c54f247b0685067b7d204c62f0f (patch) | |
tree | 644fbbf5eaba2de95377c5df7cf2589b7615b6cf /shallow.c | |
parent | 23a9235d523f3e8e7dd9becee23a15559b4e5a32 (diff) |
doc SYNOPSIS & -h: use "-" to separate words in labels, not "_"
Change "builtin/credential-cache--daemon.c" to use "<socket-path>" not
"<socket_path>" in a placeholder label, almost all of our
documentation uses this form.
This is now consistent with the "If a placeholder has multiple words,
they are separated by dashes" guideline added in
9c9b4f2f8b7 (standardize usage info string format, 2015-01-13), let's
add a now-passing test to assert that that's the case.
To do this we need to introduce a very sed-powered parser to extract
the SYNOPSIS from the *.txt, and handle not all commands with "-h"
having a corresponding *.txt (e.g. "bisect--helper"). We'll still want
to handle syntax edge cases in the *.txt in subsequent commits for
other checks, but let's do that then.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'shallow.c')
0 files changed, 0 insertions, 0 deletions