All of lore.kernel.org
 help / color / mirror / Atom feed
From: Felipe Contreras <felipe.contreras@gmail.com>
To: git@vger.kernel.org
Cc: "Martin Ågren" <martin.agren@gmail.com>,
	"brian m . carlson" <sandals@crustytoothpaste.net>,
	"Jeff King" <peff@peff.net>,
	"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
	"Felipe Contreras" <felipe.contreras@gmail.com>
Subject: [PATCH 00/11] doc: asciidoctor: direct man page creation and fixes
Date: Fri, 14 May 2021 07:14:24 -0500	[thread overview]
Message-ID: <20210514121435.504423-1-felipe.contreras@gmail.com> (raw)

This patch series enables direct man page creation with asciidoctor, but in addition tries to
minimize the difference with asciidoc+docbook.

I fixed as many issues as I could, and now the doc-diff looks very sensible. I could not find any
major issues, however, some minor issues still remain.

On the other hand the asciidoc method has issues as well, so it's not clear which method is superior
at this point; both have advantages and disadvantages.

At the very least the man pages with pure asciidoctor should be quite usable now.

This series builds on top of my cleanups [1]. It's probably not worth the effort to split the two.

[1] https://lore.kernel.org/git/20210514115631.503276-1-felipe.contreras@gmail.com

Felipe Contreras (11):
  doc: allow the user to provide ASCIIDOC_EXTRA
  doc: doc-diff: allow more than one flag
  doc: doc-diff: set docdate manually
  doc: use asciidoctor to build man pages directly
  doc: asciidoctor: add linkgit macros in man pages
  doc: join mansource and manversion
  doc: add man pages workaround for asciidoctor
  doc: asciidoctor: add hack for xrefs
  doc: asciidoctor: add hack to improve links
  doc: asciidoctor: add support for baseurl
  doc: asciidoctor: cleanup man page hack

 Documentation/Makefile                  | 24 ++++++++-----
 Documentation/asciidoctor-extensions.rb | 46 +++++++++++++++++++++++++
 Documentation/doc-diff                  |  8 ++---
 3 files changed, 65 insertions(+), 13 deletions(-)

-- 
2.31.1


             reply	other threads:[~2021-05-14 12:14 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-14 12:14 Felipe Contreras [this message]
2021-05-14 12:14 ` [PATCH 01/11] doc: allow the user to provide ASCIIDOC_EXTRA Felipe Contreras
2021-05-15  9:32   ` Jeff King
2021-05-15  9:39     ` Jeff King
2021-05-15 12:13       ` Felipe Contreras
2021-05-17  8:57         ` Jeff King
2021-05-17 10:53           ` Felipe Contreras
2021-05-17 11:39             ` Jeff King
2021-05-17 16:50               ` Felipe Contreras
2021-05-14 12:14 ` [PATCH 02/11] doc: doc-diff: allow more than one flag Felipe Contreras
2021-05-15  9:37   ` Jeff King
2021-05-15 12:11     ` Felipe Contreras
2021-05-14 12:14 ` [PATCH 03/11] doc: doc-diff: set docdate manually Felipe Contreras
2021-05-14 15:43   ` Martin Ågren
2021-05-14 20:33     ` Felipe Contreras
2021-05-14 12:14 ` [PATCH 04/11] doc: use asciidoctor to build man pages directly Felipe Contreras
2021-05-14 15:38   ` Martin Ågren
2021-05-14 20:26     ` Felipe Contreras
2021-05-14 12:14 ` [PATCH 05/11] doc: asciidoctor: add linkgit macros in man pages Felipe Contreras
2021-05-14 12:14 ` [PATCH 06/11] doc: join mansource and manversion Felipe Contreras
2021-05-14 12:14 ` [PATCH 07/11] doc: add man pages workaround for asciidoctor Felipe Contreras
2021-05-14 12:14 ` [PATCH 08/11] doc: asciidoctor: add hack for xrefs Felipe Contreras
2021-05-14 12:14 ` [PATCH 09/11] doc: asciidoctor: add hack to improve links Felipe Contreras
2021-05-14 12:14 ` [PATCH 10/11] doc: asciidoctor: add support for baseurl Felipe Contreras
2021-05-14 12:14 ` [PATCH 11/11] doc: asciidoctor: cleanup man page hack Felipe Contreras

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=20210514121435.504423-1-felipe.contreras@gmail.com \
    --to=felipe.contreras@gmail.com \
    --cc=avarab@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=martin.agren@gmail.com \
    --cc=peff@peff.net \
    --cc=sandals@crustytoothpaste.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.