summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorA.R.D <contact@team-ard.com>2013-08-09 10:16:47 (GMT)
committer Thomas Petazzoni <thomas.petazzoni@free-electrons.com>2013-08-10 08:24:33 (GMT)
commitd2a50dda7d7619b3e061009cc11791052de06cc4 (patch)
tree821964e64ded7d338dc8ec12924702df6f52959d
parent9cbeb341060f0598ba2617006f22cf33b5e943e6 (diff)
downloadbuildroot-d2a50dda7d7619b3e061009cc11791052de06cc4.tar.gz
buildroot-d2a50dda7d7619b3e061009cc11791052de06cc4.tar.bz2
manual: tips: document how to build the manual
Signed-off-by: A.R.D. <contact@team-ard.com> Cc: Willy Lambert <lambert.willy@gmail.com> Signed-off-by: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
-rw-r--r--docs/manual/make-tips.txt17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/manual/make-tips.txt b/docs/manual/make-tips.txt
index b4a9c12..e87bbf7 100644
--- a/docs/manual/make-tips.txt
+++ b/docs/manual/make-tips.txt
@@ -54,6 +54,23 @@ and target trees, the images and the toolchain):
$ make clean
--------------------
+.Generating the manual:
+
+The present manual sources are located in the 'docs/manual' directory.
+To generate the manual:
+
+---------------------------------
+ $ make manual-clean
+ $ make manual
+---------------------------------
+
+The manual outputs will be generated in 'output/docs/manual'.
+
+.Notes
+- +asciidoc+ is required to build the documentation (see:
+ xref:requirement-optional[]).
+- There is a known issue that you can't build it under Debian Squeeze.
+
To delete all build products as well as the configuration:
--------------------