r2620 - /1.2/sconstruct -- October 12, 2006 - 06:42

Author: bugman
Date: Thu Oct 12 06:42:07 2006
New Revision: 2620

URL: http://svn.gna.org/viewcvs/relax?rev=2620&view=rev
Log:
Improved the commenting of the 'self.__init__()' function which sets up the 
Scons environments, etc.

The different Environments have been grouped by type.  The docstring has been 
expanded a little.


Modified:
    1.2/sconstruct

Modified: 1.2/sconstruct
URL: 
http://svn.gna.org/viewcvs/relax/1.2/sconstruct?rev=2620&r1=2619&r2=2620&view=diff
==============================================================================
--- 1.2/sconstruct (original)
+++ 1.2/sconstruct Thu Oct 12 06:42:07 2006
@@ -49,7 +49,11 @@
 
 class Main:
     def __init__(self):
-        """Initialise the main building targets."""
+        """Initialise the main building targets.
+        
+        This function sets up the Scons build Environments, sets custom 
Builders, sets the build
+        targets, and sets the build dependancies.
+        """
 
         # Initialisation.
         #################
@@ -64,12 +68,18 @@
         self.set_paths()
 
 
-        # Targets.
-        ##########
+
+        # C module compilation.
+        #######################
 
         # Setup the rules for building the relaxation curve fitting C 
modules (and set it as the default).
         self.relax_fit()
         Default(self.relax_fit_object)
+
+
+
+        # Program installation.
+        #######################
 
         # Install target.
         install_env = Environment(BUILDERS={'install' : 
Builder(action=self.install)},
@@ -79,6 +89,11 @@
         # Uninstall target.
         uninstall_env = Environment(BUILDERS={'uninstall' : 
Builder(action=self.uninstall)})
         uninstall_env.uninstall(target='uninstall', source=None)
+
+
+
+        # Distribution packages.
+        ########################
 
         # Target for creating the binary distribution file.
         binary_dist_env = Environment(BUILDERS={'dummy' : 
Builder(action=self.dummy)})
@@ -125,9 +140,19 @@
         gpg_src_env.sign(target='gpg_src', source=None)
         gpg_src_env.Depends('gpg_src', 'version_check')     # Check the 
program version number before signing.
 
+
+
+        # relax version checking.
+        #########################
+
         # relax version number checking target.
         version_check_env = Environment(BUILDERS={'check' : 
Builder(action=self.test_version)})
         version_check_env.check(target='version_check', source=None)
+
+
+
+        # Cleaning up.
+        ##############
 
         # Clean target.
         clean_env = Environment(BUILDERS={'clean' : 
Builder(action=self.clean_files)})