[PATCH] INSTALL: note on using Asciidoctor to build doc

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Note on using Asciidoctor to build documentation suite, with example
for build documentation in html format.

Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
---
 INSTALL | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/INSTALL b/INSTALL
index 8474ad01bf..3a67f335e0 100644
--- a/INSTALL
+++ b/INSTALL
@@ -239,3 +239,9 @@ Issues of note:
          http://www.oasis-open.org/docbook/xml/4.5/xsl/current \
          /usr/share/sgml/docbook/xml-dtd-4.5 \
      /etc/xml/catalog
+
+ - Alternatively, if you have Asciidoctor installed (requires Ruby),
+   you can pass USE_ASCIIDOCTOR=1 to use it to build documentation.
+   For example, to build documentation in html format:
+
+       $ make USE_ASCIIDOCTOR=1 html
-- 
2.25.1




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux