From: Todd Zullinger <tmz@pobox.com>
To: Jeff King <peff@peff.net>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] doc: substitute ETC_GIT(CONFIG|ATTRIBUTES) in generated docs
Date: Wed, 27 Jun 2018 12:44:43 -0400 [thread overview]
Message-ID: <20180627164443.GK20217@zaya.teonanacatl.net> (raw)
In-Reply-To: <20180627150352.GJ20217@zaya.teonanacatl.net>
I wrote:
> Jeff King wrote:
>> (Related, there's a build target in the local Makefile for using
>> asciidoctor; does it need updated, too?)
>
> I didn't test asciidoctor specficially, but it also respects
> the ASCIIDOC_EXTRA parameters, so I think it will work just
> as well. I'll try to confirm that later today.
Testing confirmed that asciidoctor works fine with this as
well.
Somewhat tangentially, I looked at using asciidoctor for the
Fedora packages last year and one issue that kept me from
using it then was the '[FIXME: source]' it includes in the
footer of the manpage. When I dug into it at the time, it
appeared this was due to no <refmiscinfo> declaration
(similarly missing for manual, and version). It wasn't
clear whether it was possible to include a custom header
template in plain asciidoctor. I got the impression that it
would require using a custom backend, which in turn required
the rubygem 'tilt' for processing.
I spent about an hour poking around with it and decided that
I'd put off building with asciidoctor until that was fixed.
I felt that displaying '[FIXME: source]' wass worse than
simply not including the version.
It's always possible that I was doing something wrong in my
use of asciidoctor (I just set USE_ASCIIDOCTOR). Or maybe
the Fedora packages are missing some dependency which I
missed.
It might also be that we need some adjustments similar to
https://patchwork.kernel.org/patch/10360207/ to get the
mansource attribute passed on to asciidoctor. I only just
ran across that patch and haven't had a chance to test
sometime similar in the git manpage build. That looks
promising though.
--
Todd
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Why is it that we rejoice at a birth and grieve at a funeral? It is
because we are not the person involved.
-- Mark Twain
next prev parent reply other threads:[~2018-06-27 16:44 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-06-27 4:56 [PATCH] doc: substitute ETC_GIT(CONFIG|ATTRIBUTES) in generated docs Todd Zullinger
2018-06-27 14:14 ` Jeff King
2018-06-27 15:03 ` Todd Zullinger
2018-06-27 16:44 ` Todd Zullinger [this message]
2018-06-28 14:27 ` Jeff King
2018-06-28 14:15 ` Jeff King
2018-06-28 16:36 ` Todd Zullinger
2018-06-28 18:16 ` Jeff King
2018-06-27 16:45 ` Junio C Hamano
2018-06-27 20:58 ` Todd Zullinger
2018-06-28 14:28 ` 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
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=20180627164443.GK20217@zaya.teonanacatl.net \
--to=tmz@pobox.com \
--cc=git@vger.kernel.org \
--cc=peff@peff.net \
/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).