Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add some verbiage about "make dist".

git-svn-id: svn://svn.valgrind.org/valgrind/trunk@12170 a5019735-40e9-0310-863c-91ae7b9d1cf9
  • Loading branch information...
commit cb8ea55c5546fa542dab3066f8a7ebbab57b7732 1 parent 4a37e32
florian authored
Showing with 17 additions and 0 deletions.
  1. +17 −0 README_DEVELOPERS
View
17 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".
Please sign in to comment.
Something went wrong with that request. Please try again.