]> git.street.me.uk Git - andy/viking.git/commitdiff
Detail on how to regenerate reference help
authorRob Norris <rw_norris@hotmail.com>
Sun, 7 Oct 2012 11:30:13 +0000 (12:30 +0100)
committerRob Norris <rw_norris@hotmail.com>
Tue, 9 Oct 2012 22:08:52 +0000 (23:08 +0100)
doc/reference/README

index ab5a4af2e27304852e8597f75f7f5f0cfce716d1..171da453da71a2183d067da28329360c2c9069a5 100644 (file)
@@ -7,3 +7,18 @@ Then, cd to doc/reference and launch make command.
 (This directory is not recursively make when launching make from top
 directory. So, this avoid spending time in reference documentation
 computation when not really needed.)
 (This directory is not recursively make when launching make from top
 directory. So, this avoid spending time in reference documentation
 computation when not really needed.)
+
+Unfortunately to regenerate the references running make again does not
+detect any changes to the source files, thus it must be regenerated
+manually:
+
+$ make clean ; make
+
+If you want remove the generated HTML files you need to perform a more
+thorough cleanse:
+
+$ make distclean
+
+Unfortunately this also removes the Makefile, so you have to go through
+the ./configure steps again to regenerate the Makefile.
+