git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: Jean-Noel Avila <jn.avila@free.fr>, git@vger.kernel.org
Subject: [PATCH 8/8] doc: put example URLs and emails inside literal backticks
Date: Wed, 13 May 2015 01:06:21 -0400	[thread overview]
Message-ID: <20150513050621.GH6821@peff.net> (raw)
In-Reply-To: <20150513045650.GA6070@peff.net>

This makes sure that AsciiDoc does not turn them into links.
Regular AsciiDoc does not catch these cases, but AsciiDoctor
does treat them as links.

Signed-off-by: Jeff King <peff@peff.net>
---
Note that this _does_ change the output in AsciiDoc, because we convert
other forms of quotes into backticks. For HTML, that gets us a
typewriter font, and if you have MAN_BOLD_LITERAL, it gets you bold in
the manpages. If we really prefer the emphasis, I think we'd have to
manually escape it.  This seems to work with "\http://" in AsciiDoc, but
that doesn't work for AsciiDoctor.

So we may want to just drop this until we better figure out AsciiDoctor
escaping.

 Documentation/git-http-backend.txt | 4 ++--
 Documentation/git-svn.txt          | 4 ++--
 Documentation/git-tag.txt          | 2 +-
 3 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/git-http-backend.txt b/Documentation/git-http-backend.txt
index d422ba4..3ca18c4 100644
--- a/Documentation/git-http-backend.txt
+++ b/Documentation/git-http-backend.txt
@@ -65,8 +65,8 @@ automatically by the web server.
 
 EXAMPLES
 --------
-All of the following examples map 'http://$hostname/git/foo/bar.git'
-to '/var/www/git/foo/bar.git'.
+All of the following examples map `http://$hostname/git/foo/bar.git`
+to `/var/www/git/foo/bar.git`.
 
 Apache 2.x::
 	Ensure mod_cgi, mod_alias, and mod_env are enabled, set
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 1377008..11d1e2f 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -70,8 +70,8 @@ COMMANDS
 --username=<user>;;
 	For transports that SVN handles authentication for (http,
 	https, and plain svn), specify the username.  For other
-	transports (e.g. svn+ssh://), you must include the username in
-	the URL, e.g. svn+ssh://foo@svn.bar.com/project
+	transports (e.g. `svn+ssh://`), you must include the username in
+	the URL, e.g. `svn+ssh://foo@svn.bar.com/project`
 --prefix=<prefix>;;
 	This allows one to specify a prefix which is prepended
 	to the names of remotes if trunk/branches/tags are
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index f5b267e..034d10d 100644
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -158,7 +158,7 @@ This option is only applicable when listing tags without annotation lines.
 CONFIGURATION
 -------------
 By default, 'git tag' in sign-with-default mode (-s) will use your
-committer identity (of the form "Your Name <\your@email.address>") to
+committer identity (of the form `Your Name <your@email.address>`) to
 find a key.  If you want to use a different default key, you can specify
 it in the repository configuration as follows:
 
-- 
2.4.0.192.g5f8138b

  parent reply	other threads:[~2015-05-13  5:06 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-12 17:23 [PATCH] doc: fix unmatched code fences Jean-Noel Avila
2015-05-12 18:45 ` Junio C Hamano
2015-05-13  2:15   ` Jeff King
2015-05-13  3:43     ` Junio C Hamano
2015-05-13  3:45       ` Jeff King
2015-05-13  4:32         ` Junio C Hamano
2015-05-13  4:36           ` Jeff King
2015-05-13 22:22             ` brian m. carlson
2015-05-13  4:56     ` [PATCH 0/8] asciidoc fixups Jeff King
2015-05-13  4:57       ` [PATCH 1/8] doc: fix misrendering due to `single quote' Jeff King
2015-05-13  4:58       ` [PATCH 2/8] doc: fix unquoted use of "{type}" Jeff King
2015-05-13  4:58       ` [PATCH 3/8] doc: fix hanging "+"-continuation Jeff King
2015-05-13  4:58       ` [PATCH 4/8] doc: fix length of underlined section-title Jeff King
2015-05-13  4:58       ` [PATCH 5/8] doc/add: reformat `--edit` option Jeff King
2015-05-13  5:01       ` [PATCH 6/8] doc: convert \--option to --option Jeff King
2015-05-13  9:48         ` John Keeping
2015-05-14  4:32           ` Jeff King
2015-05-17 18:34             ` Junio C Hamano
2015-05-13  5:02       ` [PATCH 7/8] doc: drop backslash quoting of some curly braces Jeff King
2015-05-13  5:06       ` Jeff King [this message]
2015-05-13  5:09       ` [PATCH 0/8] asciidoc fixups Jeff King
2015-05-13  5:23       ` Junio C Hamano
2015-05-13  5:37         ` Jeff King
2015-05-13  7:43           ` Johannes Schindelin
2015-05-14  4:29             ` Jeff King
2015-05-13 22:41       ` brian m. carlson
2015-05-14  4:25         ` Jeff King
2015-05-14  4:34           ` [PATCH 9/8] doc: convert AsciiDoc {?foo} to ifdef::foo[] Jeff King
2015-05-14  7:43           ` [PATCH 0/8] asciidoc fixups Johannes Schindelin
2015-05-14 17:38             ` Jeff King
2015-05-14 18:20               ` Johannes Schindelin
2015-05-14 21:10                 ` Junio C Hamano
2015-05-14 21:17                   ` Jeff King
2015-05-14 21:40                     ` Junio C Hamano
2015-05-14 21:56                       ` David Turner
2015-05-15  2:52           ` brian m. carlson
2015-05-15  4:01             ` Jeff King

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=20150513050621.GH6821@peff.net \
    --to=peff@peff.net \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jn.avila@free.fr \
    /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 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).