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

[PATCH v2 1/4] travis-ci: build documentation with AsciiDoc and Asciidoctor

From
Lars Schneider <larsxschneider@gmail.com>
Date
Apr 26, 2017, 19:15 UTC
Message-ID
<20170426191545.27552-2-larsxschneider@gmail.com>
In-Reply-To
<20170426191545.27552-1-larsxschneider@gmail.com>

ec3366e introduced a knob to enable the use of Asciidoctor in addition to AsciiDoc. Build the documentation on TravisCI with this knob to reduce the likeliness of breaking Asciidoctor support in the future.

Signed-off-by: Lars Schneider <larsxschneider@gmail.com>
---
 .travis.yml              |  2 +-
 ci/test-documentation.sh | 10 +++++++++-
 2 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/.travis.yml b/.travis.yml
index 591cc57b80..c26f3bf789 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -69,7 +69,7 @@ matrix:
           - asciidoc
           - xmlto
       before_install:
-      before_script:
+      before_script: gem install asciidoctor
       script: ci/test-documentation.sh
       after_failure:
 
diff --git a/ci/test-documentation.sh b/ci/test-documentation.sh
index 579d540d32..bf23b2caea 100755
--- a/ci/test-documentation.sh
+++ b/ci/test-documentation.sh
@@ -7,8 +7,16 @@ set -e
 
 make check-builtins
 make check-docs
-make doc
 
+# Build docs with AsciiDoc
+make doc
 test -s Documentation/git.html
 test -s Documentation/git.xml
 test -s Documentation/git.1
+grep '<meta name="generator" content="AsciiDoc ' Documentation/git.html
+
+# Build docs with AsciiDoctor
+make clean
+make USE_ASCIIDOCTOR=1 doc
+test -s Documentation/git.html
+grep '<meta name="generator" content="Asciidoctor ' Documentation/git.html
-- 
2.12.2
Previous: Lars SchneiderNext: Lars Schneider
Message 2 of 6 in “travis-ci: build docs with asciidoctor”
  1. 0/4 travis-ci: build docs with asciidoctorLars Schneider, Apr 26, 2017
  2. 1/4 travis-ci: build documentation with AsciiDoc and AsciidoctorLars Schneider, Apr 26, 2017
  3. 2/4 travis-ci: parallelize documentation buildLars Schneider, Apr 26, 2017
  4. 3/4 travis-ci: check AsciiDoc/AsciiDoctor stderr outputLars Schneider, Apr 26, 2017
  5. Junio C HamanoApr 27, 2017
  6. 4/4 travis-ci: unset compiler for jobs that do not need oneLars Schneider, Apr 26, 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.