From: A.R.D <contact@team-ard.com>
Date: Fri, 9 Aug 2013 10:16:47 +0000 (+0200)
Subject: manual: tips: document how to build the manual
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=d2a50dda7d7619b3e061009cc11791052de06cc4;p=buildroot.git

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>
---

diff --git a/docs/manual/make-tips.txt b/docs/manual/make-tips.txt
index b4a9c123da..e87bbf798e 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:
 
 --------------------