From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: Todd Zullinger <tmz@pobox.com>
Cc: git@vger.kernel.org, Jeff Hostetler <jeffhost@microsoft.com>
Subject: Re: [PATCH] doc: replace "--" with {litdd} in credential-cache/fsmonitor
Date: Thu, 07 Apr 2022 19:23:26 +0200 [thread overview]
Message-ID: <220407.86h774dcyk.gmgdl@evledraar.gmail.com> (raw)
In-Reply-To: <20220406184122.4126898-1-tmz@pobox.com>
On Wed, Apr 06 2022, Todd Zullinger wrote:
> Asciidoc renders `--` as em-dash. This is not appropriate for command
> names. It also breaks linkgit links to these commands.
Looks good, for the linkgit case let's check it in "make check-docs":
diff --git a/Documentation/lint-gitlink.perl b/Documentation/lint-gitlink.perl
index 1c61dd9512b..2f46b261282 100755
--- a/Documentation/lint-gitlink.perl
+++ b/Documentation/lint-gitlink.perl
@@ -46,6 +46,7 @@ sub report {
my ($target, $page, $section) = ($1, $2, $3);
# De-AsciiDoc
+ my $raw_page = $page;
$page =~ s/{litdd}/--/g;
if (!exists $TXT{$page}) {
@@ -61,6 +62,7 @@ sub report {
report($pos, $line, $target, "wrong section (should be $real_section)");
next;
}
+ report($pos, $line, $target, "should link '--' as '{litdd}')") if $raw_page =~ /--/;
}
# this resets our $. for each file
close ARGV if eof;
next prev parent reply other threads:[~2022-04-07 17:28 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-06 18:41 [PATCH] doc: replace "--" with {litdd} in credential-cache/fsmonitor Todd Zullinger
2022-04-07 13:33 ` Johannes Schindelin
2022-04-07 18:05 ` Todd Zullinger
2022-04-07 17:23 ` Ævar Arnfjörð Bjarmason [this message]
2022-04-07 18:15 ` Todd Zullinger
2022-04-07 18:35 ` Ævar Arnfjörð Bjarmason
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=220407.86h774dcyk.gmgdl@evledraar.gmail.com \
--to=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=jeffhost@microsoft.com \
--cc=tmz@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).