From 080238fd391ca52c5f8484b2370b972cbe87ffb8 Mon Sep 17 00:00:00 2001 From: Florian Krohm Date: Wed, 19 Oct 2011 21:56:25 +0000 Subject: [PATCH] Add some verbiage about "make dist". git-svn-id: svn://svn.valgrind.org/valgrind/trunk@12170 --- README_DEVELOPERS | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README_DEVELOPERS b/README_DEVELOPERS index 9d523db565..b4b7d4ffa2 100644 --- a/README_DEVELOPERS +++ b/README_DEVELOPERS @@ -17,6 +17,23 @@ output spewed out during compilation, letting you actually see any errors, 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". -- 2.47.2