git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2 7/7] Makefile: add a knob to enable the use of Asciidoctor

From
Øyvind A. Holm <sunny@sunbase.org>
Date
Jan 23, 2017, 02:57 UTC
Message-ID
<20170123025712.o52hgkdu26h6lrm2@sunbase.org>
In-Reply-To
<20170122024156.284180-8-sandals@crustytoothpaste.net>
On 2017-01-22 02:41:56, brian m. carlson wrote:
Show 5 quoted lines
> While Git has traditionally built its documentation using AsciiDoc, some
> people wish to use Asciidoctor for speed or other reasons.  Add a
> Makefile knob, USE_ASCIIDOCTOR, that sets various options in order to
> produce acceptable output.  For HTML output, XHTML5 was chosen, since
> the AsciiDoc options also produce XHTML, albeit XHTML 1.1.

I applied and tested the patches on the current master, commit 787f75f0567a ("Sixth batch for 2.12"), and "make doc" with USE_ASCIIDOCTOR fails:

  $ git clean -fxd && make doc USE_ASCIIDOCTOR=1
  Removing Documentation/cmd-list.made
  Removing Documentation/cmds-ancillaryinterrogators.txt
  Removing Documentation/cmds-ancillarymanipulators.txt
  Removing Documentation/cmds-foreignscminterface.txt
  Removing Documentation/cmds-mainporcelain.txt
  Removing Documentation/cmds-plumbinginterrogators.txt
  Removing Documentation/cmds-plumbingmanipulators.txt
  Removing Documentation/cmds-purehelpers.txt
  Removing Documentation/cmds-synchelpers.txt
  Removing Documentation/cmds-synchingrepositories.txt
  Removing Documentation/doc.dep
  Removing Documentation/mergetools-diff.txt
  Removing Documentation/mergetools-list.made
  Removing Documentation/mergetools-merge.txt
  Removing GIT-VERSION-FILE
  GIT_VERSION = 2.11.0.460.g218feb5a0e89
  make -C Documentation all
  make[1]: Entering directory '/home/sunny/src/git/src-other/devel/git/git/Documentation'
      GEN mergetools-list.made
      GEN cmd-list.made
      GEN doc.dep
  make[2]: Entering directory '/home/sunny/src/git/src-other/devel/git/git'
  make[2]: 'GIT-VERSION-FILE' is up to date.
  make[2]: Leaving directory '/home/sunny/src/git/src-other/devel/git/git'
  make[2]: Entering directory '/home/sunny/src/git/src-other/devel/git/git'
  make[2]: 'GIT-VERSION-FILE' is up to date.
  make[2]: Leaving directory '/home/sunny/src/git/src-other/devel/git/git'
      ASCIIDOC git-init-db.html
  Couldn't find a view in @views for document
    Use --trace for backtrace
  Makefile:330: recipe for target 'git-init-db.html' failed
  make[1]: *** [git-init-db.html] Error 1
  make[1]: Leaving directory '/home/sunny/src/git/src-other/devel/git/git/Documentation'
  Makefile:2091: recipe for target 'doc' failed
  make: *** [doc] Error 2
  2017-01-23 03:50:05 sunny@sunbase:~/src/git/src-other/devel/git/git (tp-bmc-asciidoctor)
  $ lsb_release -d
  Description:    Debian GNU/Linux 8.7 (jessie)
  $ asciidoctor --version
  Asciidoctor 0.1.4 [http://asciidoctor.org]

I installed Asciidoctor with a standard "apt-get install asciidoctor", do I need to install more packages?

The build is broken by patch #7 ("Makefile: add a knob to enable the use of Asciidoctor"), the other commits seems to work, though I haven't tested them all individually yet. Standard "make doc" works.

Regards, Øyvind

+-| Øyvind A. Holm <sunny@sunbase.org> - N 60.37604° E 5.33339° |-+
| OpenPGP: 0xFB0CBEE894A506E5 - http://www.sunbase.org/pubkey.asc |
| Fingerprint: A006 05D6 E676 B319 55E2  E77E FB0C BEE8 94A5 06E5 |
+------------| 60bceb4e-e116-11e6-8fac-db5caa6d21d3 |-------------+
Previous: brian m. carlsonNext: brian m. carlson
Message 8 of 24 in “Macros for Asciidoctor support”
  1. 0/7 Macros for Asciidoctor supportbrian m. carlson, Jan 22, 2017
  2. 1/7 Documentation: fix warning in cat-texi.perlbrian m. carlson, Jan 22, 2017
  3. 4/7 Documentation: sort sources for gitman.texibrian m. carlson, Jan 22, 2017
  4. 3/7 Documentation: remove unneeded argument in cat-texi.perlbrian m. carlson, Jan 22, 2017
  5. 2/7 Documentation: modernize cat-texi.perlbrian m. carlson, Jan 22, 2017
  6. 6/7 Documentation: move dblatex arguments into variablebrian m. carlson, Jan 22, 2017
  7. 7/7 Makefile: add a knob to enable the use of Asciidoctorbrian m. carlson, Jan 22, 2017
  8. Øyvind A. HolmJan 23, 2017
  9. brian m. carlsonJan 23, 2017
  10. Øyvind A. HolmJan 25, 2017
  11. 5/7 Documentation: add XSLT to fix DocBook for Texinfobrian m. carlson, Jan 22, 2017
  12. Junio C HamanoJan 23, 2017
  13. Johannes SchindelinJan 25, 2017
  14. Jeff KingJan 25, 2017
  15. brian m. carlsonJan 25, 2017
  16. Jeff KingJan 25, 2017
  17. brian m. carlsonJan 25, 2017
  18. Documentation: implement linkgit macro for Asciidoctorbrian m. carlson, Jan 26, 2017
  19. Jeff KingJan 26, 2017
  20. Eric WongJan 26, 2017
  21. Johannes SchindelinJan 26, 2017
  22. Eric WongJan 26, 2017
  23. brian m. carlsonJan 27, 2017
  24. Junio C HamanoJan 31, 2017

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.