From: Junio C Hamano <gitster@pobox.com>
To: Jeff King <peff@peff.net>
Cc: "Johannes Schindelin" <johannes.schindelin@gmx.de>,
git@vger.kernel.org, 마누엘 <nalla@hamal.uberspace.de>
Subject: Re: [PATCH 1/2] asciidoctor: fix user-manual to be built by `asciidoctor`
Date: Sat, 07 Jan 2017 14:03:30 -0800 [thread overview]
Message-ID: <xmqqbmvi34ul.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <20170104080852.bmlmtzxhjx4qt74f@sigill.intra.peff.net> (Jeff King's message of "Wed, 4 Jan 2017 03:08:52 -0500")
Jeff King <peff@peff.net> writes:
> On Mon, Jan 02, 2017 at 05:03:57PM +0100, Johannes Schindelin wrote:
>
>> From: =?UTF-8?q?=EB=A7=88=EB=88=84=EC=97=98?= <nalla@hamal.uberspace.de>
>>
>> The `user-manual.txt` is designed as a `book` but the `Makefile` wants
>> to build it as an `article`. This seems to be a problem when building
>> the documentation with `asciidoctor`. Furthermore the parts *Git
>> Glossary* and *Appendix B* had no subsections which is not allowed when
>> building with `asciidoctor`. So lets add a *dummy* section.
>
> The git-scm.com site uses asciidoctor, too, and I think I have seen some
> oddness with the rendering though. So in general I am in favor of making
> things work under both asciidoc and asciidoctor.
>
> I diffed the results of "make user-manual.html" before and after this
> patch. A lot of "h3" chapter titles get bumped to "h2", which is OK. The
> chapter titles now say "Chapter 1. Repositories and Branches" rather
> than just "Repositories and Branches". Likewise, references now say
>
> Chapter 1, _Repositories and Branches_
>
> rather than:
>
> the section called "Repositories and Branches".
>
> which is probably OK, though the whole thing is short enough that
> calling the sections chapters feels a bit over-important.
Is that a longer way to say that the claim "... is designed as a
book" is false?
> So I dunno. I really do think "article" is conceptually the most
> appropriate style, but I agree that there are some book-like things
> (like appendices).
... Yeah, I should have read forward first before starting to insert
my comments.
next prev parent reply other threads:[~2017-01-07 22:03 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-01-02 16:03 [PATCH 0/2] Fix the documentation to build with asciidoctor Johannes Schindelin
2017-01-02 16:03 ` [PATCH 1/2] asciidoctor: fix user-manual to be built by `asciidoctor` Johannes Schindelin
2017-01-04 8:08 ` Jeff King
2017-01-05 10:05 ` Lars Schneider
2017-01-05 13:49 ` Johannes Schindelin
2017-01-05 16:45 ` Jeff King
2017-01-07 22:00 ` Junio C Hamano
2017-01-07 22:08 ` brian m. carlson
2017-01-10 22:59 ` Junio C Hamano
2017-01-07 22:03 ` Junio C Hamano [this message]
2017-01-08 3:27 ` Jeff King
2017-01-10 23:04 ` Junio C Hamano
2017-01-12 11:15 ` Johannes Schindelin
2017-01-12 19:30 ` Junio C Hamano
2017-01-13 18:31 ` Junio C Hamano
2017-01-02 16:04 ` [PATCH 2/2] giteveryday: unbreak rendering with AsciiDoctor Johannes Schindelin
2017-01-04 8:15 ` Jeff King
2017-01-07 22:05 ` Junio C Hamano
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=xmqqbmvi34ul.fsf@gitster.mtv.corp.google.com \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=johannes.schindelin@gmx.de \
--cc=nalla@hamal.uberspace.de \
--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.
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.