git-bugreport.txt: adjust reference to strftime(3)
PATCH 1/1 git-bugreport.txt: adjust reference to strftime(3)
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.
---
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(-)
Documentation/git-bugreport.txt +1 -1
@@ -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 ---
Signature · 1 line
2.26.1
Quoted 4 lines · Todd Zullinger
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.
Quoted 8 lines
Signed-off-by Todd Zullinger <[email protected]>---
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.
Quoted 13 lines
Documentation/git-bugreport.txt +1
-1@@ -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 ---
Quoted 6 lines · Junio C Hamano
Quoted 4 lines · Todd Zullinger
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.
[...]
Quoted 2 lines
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.
Signature · 1 line
Todd