|
From: <sv...@va...> - 2011-10-19 22:01:10
|
Author: florian Date: 2011-10-19 22:56:25 +0100 (Wed, 19 Oct 2011) New Revision: 12170 Log: Add some verbiage about "make dist". Modified: trunk/README_DEVELOPERS Modified: trunk/README_DEVELOPERS =================================================================== --- trunk/README_DEVELOPERS 2011-10-19 20:48:45 UTC (rev 12169) +++ trunk/README_DEVELOPERS 2011-10-19 21:56:25 UTC (rev 12170) @@ -17,6 +17,23 @@ warnings, etc. +Building a distribution tarball +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +To build a distribution tarball from the valgrind sources: + + make dist + +In addition to compiling, linking and packaging everything up, the command +will also build the documentation. Even if all required tools for building the +documentation are installed, this step may not succeed because of hidden +dependencies. E.g. on Ubuntu you must have "docbook-xsl" installed. +Additionally, specific tool versions maybe needed. + +If you only want to test whether the generated tarball is complete and runs +regression tests successfully, building documentation is not needed. +Edit docs/Makefile.am, search for BUILD_ALL_DOCS and follow instructions there. + + Running the regression tests ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To build and run all the regression tests, run "make [--quiet] regtest". |