* [PATCH] git-bugreport.txt: adjust reference to strftime(3)
@ 2020-05-18 19:37 Todd Zullinger
2020-05-18 19:53 ` Junio C Hamano
0 siblings, 1 reply; 3+ messages in thread
From: Todd Zullinger @ 2020-05-18 19:37 UTC (permalink / raw)
To: git; +Cc: Emily Shaffer
The strftime(3) man page is outside of the Git suite. Refererence it as
we do other external man pages and avoid creating a broken link when
generating the HTML documentation.
Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
Hi Emily,
While building 2.27.0-rc0, I noticed a broken link crept into the HTML
docs for git-bugreport. I believe this change matches most of our
existing references to external man pages.
Some are enclosed in backticks, while most are not. My first instinct
was to use backticks. I avoided that to be consistent with the majority
of other references. But I didn't look closely to see if newer
additions use backticks versus older changes do not.
The current "link:strftime[3]" tries to create a link to strftime named
3, which doesn't seem like what we want. :)
Thanks,
Todd
Documentation/git-bugreport.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/git-bugreport.txt b/Documentation/git-bugreport.txt
index 7fe9aef34e..9edad66a63 100644
--- a/Documentation/git-bugreport.txt
+++ b/Documentation/git-bugreport.txt
@@ -46,7 +46,7 @@ OPTIONS
--suffix <format>::
Specify an alternate suffix for the bugreport name, to create a file
named 'git-bugreport-<formatted suffix>'. This should take the form of a
- link:strftime[3] format string; the current local time will be used.
+ strftime(3) format string; the current local time will be used.
GIT
---
--
2.26.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] git-bugreport.txt: adjust reference to strftime(3)
2020-05-18 19:37 [PATCH] git-bugreport.txt: adjust reference to strftime(3) Todd Zullinger
@ 2020-05-18 19:53 ` Junio C Hamano
2020-05-18 20:18 ` Todd Zullinger
0 siblings, 1 reply; 3+ messages in thread
From: Junio C Hamano @ 2020-05-18 19:53 UTC (permalink / raw)
To: Todd Zullinger; +Cc: git, Emily Shaffer
Todd Zullinger <tmz@pobox.com> writes:
> The strftime(3) man page is outside of the Git suite. Refererence it as
> we do other external man pages and avoid creating a broken link when
> generating the HTML documentation.
>
> Signed-off-by: Todd Zullinger <tmz@pobox.com>
> ---
>
> Hi Emily,
>
> While building 2.27.0-rc0, I noticed a broken link crept into the HTML
> docs for git-bugreport. I believe this change matches most of our
> existing references to external man pages.
Thanks. This was noticed elsewhere in a different thread but let's
take this as a patch independent from the other documentation topic.
> diff --git a/Documentation/git-bugreport.txt b/Documentation/git-bugreport.txt
> index 7fe9aef34e..9edad66a63 100644
> --- a/Documentation/git-bugreport.txt
> +++ b/Documentation/git-bugreport.txt
> @@ -46,7 +46,7 @@ OPTIONS
> --suffix <format>::
> Specify an alternate suffix for the bugreport name, to create a file
> named 'git-bugreport-<formatted suffix>'. This should take the form of a
> - link:strftime[3] format string; the current local time will be used.
> + strftime(3) format string; the current local time will be used.
>
> GIT
> ---
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] git-bugreport.txt: adjust reference to strftime(3)
2020-05-18 19:53 ` Junio C Hamano
@ 2020-05-18 20:18 ` Todd Zullinger
0 siblings, 0 replies; 3+ messages in thread
From: Todd Zullinger @ 2020-05-18 20:18 UTC (permalink / raw)
To: Junio C Hamano; +Cc: git, Emily Shaffer
Junio C Hamano wrote:
> Todd Zullinger <tmz@pobox.com> writes:
>
>> The strftime(3) man page is outside of the Git suite. Refererence it as
>> we do other external man pages and avoid creating a broken link when
>> generating the HTML documentation.
>>
[...]
> Thanks. This was noticed elsewhere in a different thread but let's
> take this as a patch independent from the other documentation topic.
Ahh, I have gotten behind on my reading (and only just got
to testing rc0¹). I'm glad this unintended redundancy
worked out well, by chance.
Thank you.
¹ FWIW, this was the only issue I found in building for the
various architectures Fedora supports: aarch64, armv7hl,
ppc64le, x86, x86_64, and, last -- but by far the most
likely to turn up issues -- s390x.
--
Todd
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2020-05-18 20:18 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-05-18 19:37 [PATCH] git-bugreport.txt: adjust reference to strftime(3) Todd Zullinger
2020-05-18 19:53 ` Junio C Hamano
2020-05-18 20:18 ` Todd Zullinger
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).