All of lore.kernel.org
 help / color / mirror / Atom feed
From: Todd Zullinger <tmz@pobox.com>
To: git@vger.kernel.org
Cc: Emily Shaffer <emilyshaffer@google.com>
Subject: [PATCH] git-bugreport.txt: adjust reference to strftime(3)
Date: Mon, 18 May 2020 15:37:36 -0400	[thread overview]
Message-ID: <20200518193736.19320-1-tmz@pobox.com> (raw)

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


             reply	other threads:[~2020-05-18 19:37 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-18 19:37 Todd Zullinger [this message]
2020-05-18 19:53 ` [PATCH] git-bugreport.txt: adjust reference to strftime(3) Junio C Hamano
2020-05-18 20:18   ` Todd Zullinger

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=20200518193736.19320-1-tmz@pobox.com \
    --to=tmz@pobox.com \
    --cc=emilyshaffer@google.com \
    --cc=git@vger.kernel.org \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.