X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=doc%2Fmanual%2Fprimer%2Fautotools.txt;h=3471eacd7e9cb3f9c39587ded515d377bb116f8c;hb=6e9571164b4461dde96201a0676783c60151642f;hp=10c60006c3bb14df0a73cad6abc52561e7b54f46;hpb=eedfcb2cbebe22629502d1987d063919ce376b46;p=openocd.git diff --git a/doc/manual/primer/autotools.txt b/doc/manual/primer/autotools.txt index 10c60006c3..3471eacd7e 100644 --- a/doc/manual/primer/autotools.txt +++ b/doc/manual/primer/autotools.txt @@ -22,14 +22,14 @@ cases, a fresh bootstrap may be still required. @subsection primerbootstrapcures Problems Solved By Bootstrap For example, the build system can fail in unexpected ways after running -svn update. Here, the make maintainer-clean +git pull. Here, the make maintainer-clean should be used to remove all of the files generated by the @c bootstrap script and subsequent build processes. In this particular case, one may also need to remove stray files by hand after running this command to ensure everything is rebuilt properly. This step should be necessary only if the @c maintainer-clean was run -@b after altering the build system files with Subversion. If it is run +@b after altering the build system files with git. If it is run @b before any updates, the build system should never leave artifacts in the tree. @@ -53,26 +53,6 @@ The @c autoconf program generates the @c configure script from included in the project distribution packages and run by users to configure the build process for their system. -@subsection primermaintainermode Maintainer Mode - -After a fresh checkout, @c bootstrap, and a simple @c configure, you may -experience errors when running @c make that some files cannot be found -(e.g. @c version.texi), and a second @c make will "mysteriously" solve -the problems. The isssue is well-known and expected, if unfortunate. - -The OpenOCD project requires that all developers building from the -Subversion repository use the @c --enable-maintainer-mode option when -running the @c configure script. This option ensures that certain files -are created during the build process that would normally be packaged in -the distribution tarball. The @c bootstrap script will remind you of -this requirement when it runs. - -In addition to solving these problems, this option enables Makefile -rules (provided by automake) that allow the normal @c make process to -rebuild the autotools outputs, included the automake-generated Makefiles -themselves. This avoids the heavy-handed approach of running the -@c bootstrap script after changing one of these files. - @section primerautomake Automake Makefiles The @c automake program generates @c Makefile.in files (from @c @@ -143,8 +123,8 @@ implement new checks. The make distcheck command produces an archive of the project deliverables (using make dist) and verifies its -integrity for distribution by attemptng to use the package in the same -manner as a user. +integrity for distribution by attempting to use the package in the same +manner as a user. These checks includes the following steps: -# Unpack the project archive into its expected directory.