| Message ID | 20200518193736.19320-1-tmz@pobox.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | git-bugreport.txt: adjust reference to strftime(3) | expand |
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 > ---
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.
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 ---
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(-)