Simple updates to the Developer and Guidelines pages, in preparation
authorstevenknight <stevenknight@fdb21ef1-2011-0410-befe-b5e4ea1792b1>
Thu, 25 May 2006 23:06:50 +0000 (23:06 +0000)
committerstevenknight <stevenknight@fdb21ef1-2011-0410-befe-b5e4ea1792b1>
Thu, 25 May 2006 23:06:50 +0000 (23:06 +0000)
for a more thorough reworking to handle branches.

git-svn-id: http://scons.tigris.org/svn/scons/trunk@1506 fdb21ef1-2011-0410-befe-b5e4ea1792b1

scons.org/dev.php
scons.org/guidelines.php

index 53ba971d17ab89f1d43a1b1c6db09a90391964b8..8549d6a49c9eeb2213d39da2d73b6388e22dc3a0 100644 (file)
@@ -23,11 +23,12 @@ reliable tool for building software.  Here are the key points: </p>
 <ul>
 <li>We write a lot of automated tests to test the daylights out of <span
 class="sconslogo">SCons</span>.
-Lines of test code outnumber lines of code in SCons itself
-by more than two to one.
+Lines of test code currently outnumber lines of code in SCons itself
+by more than 2.5 to one.
 <li>We use the Aegis change management system to control the development and
 testing process.
-<li>You can still use CVS as a read-only front end for submitting patches.
+<li>You can still use Subversion or CVS as a front end
+for submitting patches.
 </ul>
 
 </p>
@@ -100,10 +101,10 @@ Updated whenever a change is made to <span class="sconslogo">SCons</span>.
 
 <div class="link">
 <div class="linkname">
-<a href="http://scons.tigris.org/source/browse/scons/">CVS&nbsp;repository</a></td>
+<a href="http://scons.tigris.org/source/browse/scons/">Subversion&nbsp;repository</a></td>
 </div>
 <div class="linkdesc">
-The browsable CVS repository at
+The browsable Subversion repository at
 <a href="http://www.tigris.org">Tigris.org</a>.
 Updated whenever a change is made to <span class="sconslogo">SCons</span>.
 </div>
index 47184850cf6dafc8cf593b03e35c1e9ededa3a0f..33393082800fb9dffbc0095712dfff58041c61d7 100644 (file)
@@ -9,7 +9,7 @@
 <div id="bodycontent">
 <h2> SCons Developer's Guidelines </h2>
 
-<center>28 September 2004</center>
+<center>22 May 2006</center>
 <ol class="upper-roman">
 <li>
 General
@@ -18,10 +18,10 @@ General
 <ol class="decimal">
 <li>
 All SCons software (SCons itself, tests, supporting utilities) will be
-written to Python version 1.5.2.
+written to work with Python version 1.5.2.
 </li>
 <li>
-SCons will be tested against Python versions 1.5.2 and 2.2.x.
+SCons will be tested against Python versions 1.5.2 and some version of 2.x.
 </li>
 <li>
 The SCons distribution will be generated
@@ -37,7 +37,7 @@ SCons installation will be atomic, and will install all necessary
 non-standard modules and/or packages.
 </li>
 <li>
-At a minimum, SCons will be tested on Linux and Windows 2000.  We will add
+At a minimum, SCons will be tested on Linux and Windows XP.  We will add
 other platforms as they become available.  All tests must be written
 portably.
 </li>
@@ -62,9 +62,13 @@ Aegis.
 SCons infrastructure module tests are written using PyUnit.
 </li>
 <li>
-Tests of full SCons script functionality are written using the
+Tests of SCons packaging are written using subclasses of the
 TestCmd.py module.
 </li>
+<li>
+Tests of full SCons script functionality are written using subclasses
+of the TestCmd.py module.
+</li>
 </ol>
 </p>
 </li>
@@ -136,8 +140,8 @@ the infrastructure as needed to continue to make testing even easier, so
 long as it still does the job.
 </p>
 <p>
-SCons development uses two testing methodologies, one for unit tests and
-one for end-to-end functional tests:
+SCons development uses three (!) testing harnesses, one for unit tests,
+one for end-to-end functional tests, and one for test execution:
 </p>
 <ul>
        <li>
@@ -158,14 +162,23 @@ one for end-to-end functional tests:
         live in the <code>test/</code> subdirectory and which use the
        TestCmd.py infrastructure.
        </li>
+        <li>
+        Execution of these tests will be handled by the
+        <a href="http://www.codesourcery.com/qmtest/">QMTest</a>
+        infrastructure, as wrapped by an execution script.
+        <strong>Note:</strong>  The transition to using
+        QMTest is still in progress.  The wrapper execution script
+        currently executes the test scripts directly.
+        </li>
 </ul>
 <p>
-The end-to-end tests in the <code>test/</code> subdirectory are not
-substitutes for module unit tests.  If you modify a module under the
-<code>src/scons/</code> subdirectory, you *must* modify its
-<code>*Tests.py</code> script to validate your change.  This can be
-(and probably should be) in addition to a <code>test/*</code>
-test of how the modification affects the end-to-end workings of SCons.
+The end-to-end tests in the <code>test/</code> subdirectory are
+not substitutes for module unit tests.  If you modify a module
+under the <code>src/scons/</code> subdirectory, you generally
+<emphasis>must</emphasis>modify its <code>*Tests.py</code> script to
+validate your change.  This can be (and probably should be) in addition to
+a <code>test/*</code> test of how the modification affects the end-to-end
+workings of SCons.
 </p>
 </li>
 
@@ -176,16 +189,17 @@ General developer requirements
 <p>
 <ol class="decimal">
 <li>
-All developers must subscribe to the dev@scons.tigris.org mailing list.
+All project developers must subscribe to the dev@scons.tigris.org
+mailing list.
 </li>
 <li>
-All developers are encouraged, but not required, to register at
-Tigris.org and SourceForge.
+All project developers must register at Tigris.org and be added to the
+SCons developer list, so that the number of active developers can be
+accurately represented on the SCons project page.
 </li>
 <li>
-Developers registered at SourceForge should be added to the SCons
-developer list, so that the number of active developers can be
-accurately represented on the SCons project page.
+We will accept patches from developers not actually registered on
+the project, so long as the patches conform to our normal requirements.
 </li>
 </ol>
 </p>
@@ -237,7 +251,7 @@ automatically to the Tigris.org and SourceForge CVS repositories.
 
 
 <li>
-Using CVS for SCons development
+Using Subversion for SCons development
 <p>
 <ol class="decimal">
 <li>