| Message ID | 4753804d23ba7b1b267b6557077c80f3a8891712.1589739920.git.martin.agren@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Documentation fixes for v2.27.0-rc0 | expand |
On Sun, May 17, 2020 at 2:52 PM Martin Ågren <martin.agren@gmail.com> wrote: > When we say "link:strftime[3]", it ends up rendered as "3[1]" and we > produce a footnote referring to the non-existing > file:///.../git-doc/strftime. Make sure we use gitlink, not link, to get s/gitlink/linkgit/ > the effect we're after. > > Signed-off-by: Martin Ågren <martin.agren@gmail.com>
On Sun, 17 May 2020 at 21:23, Eric Sunshine <sunshine@sunshineco.com> wrote: > > On Sun, May 17, 2020 at 2:52 PM Martin Ågren <martin.agren@gmail.com> wrote: > > When we say "link:strftime[3]", it ends up rendered as "3[1]" and we > > produce a footnote referring to the non-existing > > file:///.../git-doc/strftime. Make sure we use gitlink, not link, to get > > s/gitlink/linkgit/ Oops, thanks! At least the diff is correct. Martin
On Mon, 18 May 2020, Martin Ågren, Eric Sunshine wrote: > On Sun, 17 May 2020 at 21:23, Eric Sunshine <sunshine@sunshineco.com> wrote: >> On Sun, May 17, 2020 at 2:52 PM Martin Ågren <martin.agren@gmail.com> wrote: >>> When we say "link:strftime[3]", it ends up rendered as "3[1]" and we >>> produce a footnote referring to the non-existing >>> file:///.../git-doc/strftime. Make sure we use gitlink, not link, to get >> s/gitlink/linkgit/ > Oops, thanks! At least the diff is correct. > > Martin Not even sure of that: strftime is not an internal manpage, so for html target, we will end up with a hyperlink to an non-existing file strftime.html. So I would keep it as simple text. JN
On Mon, 18 May 2020 at 12:54, Jean-Noël Avila <avila.jn@gmail.com> wrote: > > On Mon, 18 May 2020, Martin Ågren, Eric Sunshine wrote: > > On Sun, 17 May 2020 at 21:23, Eric Sunshine <sunshine@sunshineco.com> wrote: > >> On Sun, May 17, 2020 at 2:52 PM Martin Ågren <martin.agren@gmail.com> wrote: > >>> When we say "link:strftime[3]", it ends up rendered as "3[1]" and we > >>> produce a footnote referring to the non-existing > >>> file:///.../git-doc/strftime. Make sure we use gitlink, not link, to get > >> s/gitlink/linkgit/ > > Oops, thanks! At least the diff is correct. > > Not even sure of that: strftime is not an internal manpage, so for html > target, we will end up with a hyperlink to an non-existing file > strftime.html. So I would keep it as simple text. That's a good point. I don't use the HTML versions myself, so I haven't thought about the *linking* nature much -- I just see the formatting. But you're right. Grepping around, we only seem to use linkgit to refer to our own docs. So this should probably just be "strftime(3)" as you say. Thanks, Martin
diff --git a/Documentation/git-bugreport.txt b/Documentation/git-bugreport.txt index 7fe9aef34e..5ee9988628 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. + linkgit:strftime[3] format string; the current local time will be used. GIT ---
When we say "link:strftime[3]", it ends up rendered as "3[1]" and we produce a footnote referring to the non-existing file:///.../git-doc/strftime. Make sure we use gitlink, not link, to get the effect we're after. Signed-off-by: Martin Ågren <martin.agren@gmail.com> --- Documentation/git-bugreport.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)