From: Felipe Contreras <felipe.contreras@gmail.com>
To: git@vger.kernel.org
Cc: "Martin Ågren" <martin.agren@gmail.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Bagas Sanjaya" <bagasdotme@gmail.com>,
"Jeff King" <peff@peff.net>, "Junio C Hamano" <gitster@pobox.com>,
"brian m . carlson" <sandals@crustytoothpaste.net>,
"Felipe Contreras" <felipe.contreras@gmail.com>
Subject: [PATCH 16/23] doc-diff: support asciidoctor man pages
Date: Mon, 21 Jun 2021 11:31:03 -0500 [thread overview]
Message-ID: <20210621163110.1074145-17-felipe.contreras@gmail.com> (raw)
In-Reply-To: <20210621163110.1074145-1-felipe.contreras@gmail.com>
From: Jeff King <peff@peff.net>
The new option enables both asciidoctor as well as its direct-to-manpage
mode that skips xmlto. This lets you view the rendered difference
between the two pipelines with something like:
./doc-diff --from-asciidoctor --to-asciidoctor-direct HEAD HEAD
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
Documentation/doc-diff | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/Documentation/doc-diff b/Documentation/doc-diff
index 6b6bb444ac..bbfeaa213b 100755
--- a/Documentation/doc-diff
+++ b/Documentation/doc-diff
@@ -17,10 +17,13 @@ f force rebuild; do not rely on cached results
c,clean cleanup temporary working files
from-asciidoc use asciidoc with the 'from'-commit
from-asciidoctor use asciidoctor with the 'from'-commit
+from-asciidoctor-direct use asciidoctor without xmlto for 'from'-commit
asciidoc use asciidoc with both commits
to-asciidoc use asciidoc with the 'to'-commit
to-asciidoctor use asciidoctor with the 'to'-commit
+to-asciidoctor-direct use asciidoctor without xmlto for 'to'-commit
asciidoctor use asciidoctor with both commits
+asciidoctor-direct use asciidoctor without xml for both commits
"
SUBDIRECTORY_OK=1
. "$(git --exec-path)/git-sh-setup"
@@ -53,6 +56,13 @@ do
--asciidoc)
from_program=-asciidoc
to_program=-asciidoc ;;
+ --from-asciidoctor-direct)
+ from_program=-asciidoctor-direct ;;
+ --to-asciidoctor-direct)
+ to_program=-asciidoctor-direct ;;
+ --asciidoctor-direct)
+ from_program=-asciidoctor-direct
+ to_program=-asciidoctor-direct ;;
--)
shift; break ;;
*)
@@ -108,6 +118,10 @@ construct_makemanflags () {
elif test "$1" = "-asciidoctor"
then
echo USE_ASCIIDOCTOR=YesPlease ASCIIDOC_FLAGS='-adocdate="01/01/1970"'
+ elif test "$1" = "-asciidoctor-direct"
+ then
+ echo USE_ASCIIDOCTOR=YesPlease ASCIIDOC_FLAGS='-adocdate="01/01/1970"'
+ echo USE_ASCIIDOCTOR_MANPAGE=YesPlease
fi
}
--
2.32.0
next prev parent reply other threads:[~2021-06-21 16:59 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-21 16:30 [PATCH 00/23] doc: cleanups and asciidoctor direct man pages Felipe Contreras
2021-06-21 16:30 ` [PATCH 01/23] doc: remove GNU troff workaround Felipe Contreras
2021-06-21 16:30 ` [PATCH 02/23] doc: use --stringparam in xmlto Felipe Contreras
2021-06-21 16:30 ` [PATCH 03/23] doc: simplify version passing Felipe Contreras
2021-06-21 16:30 ` [PATCH 04/23] doc: asciidoc: remove unnecessary attribute Felipe Contreras
2021-06-21 16:30 ` [PATCH 05/23] doc: asciidoctor: remove unnecessary require Felipe Contreras
2021-06-21 16:30 ` [PATCH 06/23] doc: asciidoctor: remove cruft Felipe Contreras
2021-06-21 16:30 ` [PATCH 07/23] doc: asciidoctor: reorganize extensions Felipe Contreras
2021-06-21 16:30 ` [PATCH 08/23] doc: asciidoctor: use html-prefix only for html Felipe Contreras
2021-06-21 16:30 ` [PATCH 09/23] doc: asciidoctor: refactor macro registration Felipe Contreras
2021-06-21 16:30 ` [PATCH 10/23] doc: asciidoctor: improve string handling Felipe Contreras
2021-06-21 16:30 ` [PATCH 11/23] doc: asciidoctor: split the format from the code Felipe Contreras
2021-06-21 16:30 ` [PATCH 12/23] doc: asciidoctor: specify name of our group Felipe Contreras
2021-06-21 16:31 ` [PATCH 13/23] doc: doc-diff: set docdate manually Felipe Contreras
2021-06-21 16:31 ` [PATCH 14/23] doc-diff: drop --cut-footer switch Felipe Contreras
2021-06-21 16:31 ` [PATCH 15/23] doc: use asciidoctor to build man pages directly Felipe Contreras
2021-06-22 5:23 ` Bagas Sanjaya
2021-06-23 1:35 ` Felipe Contreras
2021-06-21 16:31 ` Felipe Contreras [this message]
2021-06-21 16:31 ` [PATCH 17/23] doc: asciidoctor: add linkgit macros in man pages Felipe Contreras
2021-06-21 16:31 ` [PATCH 18/23] doc: add man pages workaround for asciidoctor Felipe Contreras
2021-06-21 16:31 ` [PATCH 19/23] doc: asciidoctor: add hack for xrefs Felipe Contreras
2021-06-21 16:31 ` [PATCH 20/23] doc: asciidoctor: add hack to improve links Felipe Contreras
2021-06-21 16:31 ` [PATCH 21/23] doc: asciidoctor: add support for baseurl Felipe Contreras
2021-06-21 16:31 ` [PATCH 22/23] doc: asciidoctor: cleanup man page hack Felipe Contreras
2021-06-21 16:31 ` [PATCH 23/23] doc: asciidoctor: add hack for old versions Felipe Contreras
2021-06-22 5:35 ` [PATCH 00/23] doc: cleanups and asciidoctor direct man pages Bagas Sanjaya
2021-06-23 1:37 ` 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
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=20210621163110.1074145-17-felipe.contreras@gmail.com \
--to=felipe.contreras@gmail.com \
--cc=avarab@gmail.com \
--cc=bagasdotme@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--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.
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).