git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Jeff King <peff@peff.net>
To: Lars Schneider <larsxschneider@gmail.com>
Cc: git@vger.kernel.org, Matthieu.Moy@grenoble-inp.fr,
	sbeller@google.com, gitster@pobox.com
Subject: Re: [PATCH v3 1/2] Documentation: fix linkgit references
Date: Tue, 3 May 2016 13:58:09 -0400	[thread overview]
Message-ID: <20160503175808.GA29877@sigill.intra.peff.net> (raw)
In-Reply-To: <E4A56B4E-6F2E-44E3-870B-D1D3A71B2869@gmail.com>

On Tue, May 03, 2016 at 10:30:09AM +0200, Lars Schneider wrote:

> > So I think that's a step backwards. I did check the asciidoctor
> > rendering on git-scm.com, though, and it gets the {litdd} case wrong. So
> > I think it does need fixing, but we need a solution that looks correct
> > in both cases. Maybe linkgit:`git-web--browse`[1] would work; it seems
> > OK with my version of asciidoc, but I have a feeling it will run into
> > the same problem with asciidoctor (if it's not respecting {litdd} in
> > that context, it's probably also not respecting backticks).
> I will play with this to find a solution. Would it be an option to
> replace "--" with "-"? Why do we need two dashes if they cause trouble?

We use two dashes to signify "internal" programs that users should not
rely on. So "git-web-browse" would be something we'd expect to support
forever, but "git-web--browse" is an implementation detail of one of our
scripts (that just happens to require an extra program).

So I don't think we want to switch away from that convention just to
make the documentation work.

AFAICT, the {litdd} is working fine with asciidoc; it's only asciidoctor
that is the problem. So the first step may be talking with asciidoctor
folks to see if it's a bug, or if they have a recommended workaround.

-Peff

  parent reply	other threads:[~2016-05-03 17:58 UTC|newest]

Thread overview: 53+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-04-29  9:35 [PATCH v2] travis-ci: build documentation larsxschneider
2016-04-29 12:14 ` Jeff King
2016-04-29 12:21   ` Matthieu Moy
2016-04-29 14:22     ` Lars Schneider
2016-04-29 14:32       ` Jeff King
2016-04-29 17:27     ` Stefan Beller
2016-04-29 17:53       ` Matthieu Moy
2016-04-29 20:44       ` Lars Schneider
2016-04-29 21:05         ` Junio C Hamano
2016-05-02 20:20           ` [PATCH v3 0/2] " larsxschneider
2016-05-02 20:20             ` [PATCH v3 1/2] Documentation: fix linkgit references larsxschneider
2016-05-02 20:34               ` Jeff King
2016-05-03  8:30                 ` Lars Schneider
2016-05-03 15:41                   ` Junio C Hamano
2016-05-03 17:59                     ` Jeff King
2016-05-03 17:58                   ` Jeff King [this message]
2016-05-04  8:38                   ` [PATCH v4 0/2] travis-ci: build documentation larsxschneider
2016-05-04  8:38                     ` [PATCH v4 1/2] Documentation: fix linkgit references larsxschneider
2016-05-04  8:43                       ` Lars Schneider
2016-05-04  8:57                         ` Jeff King
2016-05-04 11:38                         ` Ramsay Jones
2016-05-04 17:28                           ` Junio C Hamano
2016-05-04 17:36                             ` Junio C Hamano
2016-05-04 18:52                             ` Junio C Hamano
2016-05-04 19:25                               ` Jeff King
2016-05-04 19:57                                 ` Junio C Hamano
2016-05-04 20:06                                   ` Jeff King
2016-05-04 21:15                                     ` Junio C Hamano
2016-05-04 21:31                                       ` Jeff King
2016-05-04 21:34                                         ` Junio C Hamano
2016-05-04 21:44                                           ` Jeff King
2016-05-04 21:52                                             ` Junio C Hamano
2016-05-04 22:09                                               ` Jeff King
2016-05-04 22:17                                                 ` Junio C Hamano
2016-05-04 22:27                                                   ` Junio C Hamano
2016-05-04 23:28                                                     ` Junio C Hamano
2016-05-04 23:41                                                       ` Jeff King
2016-05-04 23:53                                                         ` Jeff King
2016-05-04 21:54                                     ` Ævar Arnfjörð Bjarmason
2016-05-04 22:11                                       ` Jeff King
2016-05-04  8:38                     ` [PATCH v4 2/2] travis-ci: build documentation larsxschneider
2016-05-10 17:12                       ` Junio C Hamano
2016-05-13  6:26                         ` Lars Schneider
2016-05-02 20:20             ` [PATCH v3 " larsxschneider
2016-05-02 20:45               ` Junio C Hamano
2016-05-03  8:12                 ` Lars Schneider
2016-05-03 15:43                   ` Junio C Hamano
2016-05-04  8:04                     ` Lars Schneider
2016-05-04  8:18                       ` Eric Wong
2016-05-04  8:19                       ` Junio C Hamano
2016-05-04  9:11                       ` Christian Couder
2016-05-04 11:27                         ` Matthieu Moy
2016-04-29 14:40 ` [PATCH v2] " Matthieu Moy

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

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20160503175808.GA29877@sigill.intra.peff.net \
    --to=peff@peff.net \
    --cc=Matthieu.Moy@grenoble-inp.fr \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=larsxschneider@gmail.com \
    --cc=sbeller@google.com \
    /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.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).