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 v2 04/11] doc-diff: support asciidoctor man pages
Date: Fri, 21 May 2021 17:44:45 -0500 [thread overview]
Message-ID: <20210521224452.530852-5-felipe.contreras@gmail.com> (raw)
In-Reply-To: <20210521224452.530852-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 | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/Documentation/doc-diff b/Documentation/doc-diff
index 6b6bb444ac..52cf639f4d 100755
--- a/Documentation/doc-diff
+++ b/Documentation/doc-diff
@@ -17,10 +17,14 @@ 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
+cut-footer cut away footer
"
SUBDIRECTORY_OK=1
. "$(git --exec-path)/git-sh-setup"
@@ -53,6 +57,15 @@ do
--asciidoc)
from_program=-asciidoc
to_program=-asciidoc ;;
+ --cut-footer)
+ cut_footer=-cut-footer ;;
+ --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 +121,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.rc0
next prev parent reply other threads:[~2021-05-21 22:45 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-21 22:44 [PATCH v2 00/11] doc: asciidoctor: direct man page creation and fixes Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 01/11] doc: doc-diff: set docdate manually Felipe Contreras
2021-05-22 4:25 ` Bagas Sanjaya
2021-05-22 21:27 ` Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 02/11] doc-diff: drop --cut-footer switch Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 03/11] doc: use asciidoctor to build man pages directly Felipe Contreras
2021-06-02 20:11 ` Felipe Contreras
2021-05-21 22:44 ` Felipe Contreras [this message]
2021-05-21 22:52 ` [PATCH v2 04/11] doc-diff: support asciidoctor man pages Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 05/11] doc: asciidoctor: add linkgit macros in " Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 06/11] doc: add man pages workaround for asciidoctor Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 07/11] doc: asciidoctor: add hack for xrefs Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 08/11] doc: asciidoctor: add hack to improve links Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 09/11] doc: asciidoctor: add support for baseurl Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 10/11] doc: asciidoctor: cleanup man page hack Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 11/11] doc: asciidoctor: add hack for old versions Felipe Contreras
2021-05-21 22:51 ` [PATCH v2 00/11] doc: asciidoctor: direct man page creation and fixes 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=20210521224452.530852-5-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.