[asterisk-commits] rizzo: trunk r93536 - /trunk/doc/CODING-GUIDELINES

[SVN commits to the Asterisk project]

Author: rizzo
Date: Tue Dec 18 01:22:26 2007
New Revision: 93536

URL: http://svn.digium.com/view/asterisk?view=rev&rev=93536
Log:
small documentation update (nothing important).


Modified:
    trunk/doc/CODING-GUIDELINES

Modified: trunk/doc/CODING-GUIDELINES
URL: http://svn.digium.com/view/asterisk/trunk/doc/CODING-GUIDELINES?view=diff&rev=93536&r1=93535&r2=93536
==============================================================================
--- trunk/doc/CODING-GUIDELINES (original)
+++ trunk/doc/CODING-GUIDELINES Tue Dec 18 01:22:26 2007
@@ -628,11 +628,12 @@
 	    ==  PART TWO: BUILD ARCHITECTURE  ==
 	    ------------------------------------
 
-The asterisk build architecture relies on 'autoconf' to detect the
+The asterisk build architecture relies on autoconf to detect the
 system configuration, and on a locally developed tool (menuselect) to
 select build options and modules list, and on gmake to do the build.
 
-autoconf will store its findings in two files:
+The first step, usually to be done soon after a checkout, is running
+"./configure", which will store its findings in two files:
 
     + include/asterisk/autoconfig.h
 	contains C macros, normally #define HAVE_FOO or HAVE_FOO_H ,
@@ -649,7 +650,10 @@
 	FOO_DIR=... indicating, for each package, the useful libraries
 	and header files. 
 
+The next step is to run "menuselect", to extract the dependencies existing
+between files and modules, and to store build options.
 menuselect produces two files, both to be read by the Makefile:
+
     + menuselect.makeopts
 	contains for each subdirectory a list of modules that must be
 	excluded from the build, plus some additional informatiom.