public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: Eric Wong <e@80x24•org>
To: Jeff King <peff@peff•net>
Cc: "brian m. carlson" <sandals@crustytoothpaste•net>,
	git@vger•kernel.org,
	"Johannes Schindelin" <Johannes.Schindelin@gmx•de>,
	"Øyvind A. Holm" <sunny@sunbase•org>
Subject: Re: [PATCH] Documentation: implement linkgit macro for Asciidoctor
Date: Thu, 26 Jan 2017 07:43:04 +0000	[thread overview]
Message-ID: <20170126074304.GA26530@starla> (raw)
In-Reply-To: <20170126034655.fwzow2mgkjj5dpek@sigill.intra.peff.net>

Jeff King <peff@peff•net> wrote:
> On Thu, Jan 26, 2017 at 12:13:44AM +0000, brian m. carlson wrote:
> > +
> > +      def process(parent, target, attrs)
> > +        if parent.document.basebackend? 'html'
> > +          prefix = parent.document.attr('git-relative-html-prefix')
> > +          %(<a href="#{prefix}#{target}.html">#{target}(#{attrs[1]})</a>\n)
> > +        elsif parent.document.basebackend? 'docbook'
> > +          %(<citerefentry>
> > +<refentrytitle>#{target}</refentrytitle><manvolnum>#{attrs[1]}</manvolnum>
> > +</citerefentry>
> > +)

<snip>

> The multi-line string is kind of ugly because of the indentation.
> Apparently Ruby has here-docs that will eat leading whitespace, but the
> syntax was not introduce until Ruby 2.3, which is probably more recent
> than we should count on.

You can use '\' to continue long lines with any Ruby version:

    "<citerefentry>" \
      "<refentrytitle>#{target}</refentrytitle>" \
      "<manvolnum>#{attrs[1]}</manvolnum>" \
    "</citerefentry>"

The above happens during the parse phase, so there's no garbage
or method call overhead compared to the more-frequently seen '+'
or '<<' method calls to combine strings.

> I think you could write:
> 
>           %(<citerefentry>
>             <refentrytitle>#{target}</refentrytitle><manvolnum>#{attrs[1]}</manvolnum>
>             </citerefentry>
> 	  ).gsub(/^\s*/, "")
> 
> I don't know if that's too clever or not.

Ick...

> But either way, I like this better than introducing an extra dependency.

Agreed.

  reply	other threads:[~2017-01-26  7:43 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-01-22  2:41 [PATCH v2 0/7] Macros for Asciidoctor support brian m. carlson
2017-01-22  2:41 ` [PATCH v2 1/7] Documentation: fix warning in cat-texi.perl brian m. carlson
2017-01-22  2:41 ` [PATCH v2 2/7] Documentation: modernize cat-texi.perl brian m. carlson
2017-01-22  2:41 ` [PATCH v2 3/7] Documentation: remove unneeded argument in cat-texi.perl brian m. carlson
2017-01-22  2:41 ` [PATCH v2 4/7] Documentation: sort sources for gitman.texi brian m. carlson
2017-01-22  2:41 ` [PATCH v2 5/7] Documentation: add XSLT to fix DocBook for Texinfo brian m. carlson
2017-01-22  2:41 ` [PATCH v2 6/7] Documentation: move dblatex arguments into variable brian m. carlson
2017-01-22  2:41 ` [PATCH v2 7/7] Makefile: add a knob to enable the use of Asciidoctor brian m. carlson
2017-01-23  2:57   ` Øyvind A. Holm
2017-01-23  4:09     ` brian m. carlson
2017-01-25  2:26       ` Øyvind A. Holm
2017-01-23 18:59 ` [PATCH v2 0/7] Macros for Asciidoctor support Junio C Hamano
2017-01-25 13:28 ` Johannes Schindelin
2017-01-25 21:35   ` Jeff King
2017-01-25 23:19     ` brian m. carlson
2017-01-25 23:30       ` Jeff King
2017-01-25 23:41         ` brian m. carlson
2017-01-26  0:13           ` [PATCH] Documentation: implement linkgit macro for Asciidoctor brian m. carlson
2017-01-26  3:46             ` Jeff King
2017-01-26  7:43               ` Eric Wong [this message]
     [not found]                 ` <xmqq1svp7lcs.fsf@gitster.mtv.corp.google.com>
2017-01-26 19:18                   ` Eric Wong
2017-01-27  0:40                     ` brian m. carlson
2017-01-31 20:20                       ` Junio C Hamano
2017-01-26 11:43             ` Johannes Schindelin

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=20170126074304.GA26530@starla \
    --to=e@80x24$(echo .)org \
    --cc=Johannes.Schindelin@gmx$(echo .)de \
    --cc=git@vger$(echo .)kernel.org \
    --cc=peff@peff$(echo .)net \
    --cc=sandals@crustytoothpaste$(echo .)net \
    --cc=sunny@sunbase$(echo .)org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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