Commit d2a50dda authored by A.R.D's avatar A.R.D Committed by Thomas Petazzoni
Browse files

manual: tips: document how to build the manual 



Signed-off-by: default avatarA.R.D. <contact@team-ard.com>
Cc: Willy Lambert <lambert.willy@gmail.com>
Signed-off-by: default avatarSamuel Martin <s.martin49@gmail.com>
Signed-off-by: default avatarThomas Petazzoni <thomas.petazzoni@free-electrons.com>
parent 9cbeb341

docs/manual/make-tips.txt

+17 −0
Original line number Diff line number Diff line
@@ -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:



--------------------