Start documenting administrative procedures.

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

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..132abcd
--- /dev/null
+++ b/README
@@ -0,0 +1,49 @@
+Welcome to the SCons development tree.  Here's a brief guide (not
+guaranteed to be up-to-date) to what you'll find herein:
+
+admin/
+       Documentation of SCons administrative procedures.  Maybe
+       other administrative stuff in the future.
+
+build/
+        This doesn't exist if you're looking at a vanilla source tree.
+        This is generated as part of our build process, and it's where,
+        believe it or not, we *build* everything.
+
+Construct
+        The "Makefile" for the SCons distribution.  Yes, we're using
+        Cons to build its improved stepchild.  (Of course, this will
+        change to an SConstruct file as soon as we have SCons to the
+        point where it can handle the functionality we need...)
+
+config
+        The Aegis configuration, governing much of how we use Aegis to
+        build, test, control source, etc.
+
+etc/
+        A subdirectory for miscellaneous things that we need.  Right
+        now, it has copies of Python modules that we use for testing,
+        and which we don't want to force people to have to install on
+        their own just to help out with SCons development.
+
+runtest.py
+runtest.sh
+        Scripts for running our tests.  The Python version is used
+        by Aegis for running tests against a copy of the source as
+        extracted from an archive.  The shell version runs tests against
+        the local src/ tree, so you don't have to do a build before
+        testing your changes.  (Hmm, that should probably just be an
+        option to runtest.py...)
+
+src/
+       Where the actual source code is kept, of course.
+
+template/
+        Template files, used by Aegis to give you a head start when you
+        aenf or aent a new file.  I haven't been keeping these up to
+       date...
+
+test/
+        End-to-end tests of the SCons utility itself.  These are
+        separate from the individual module unit tests, which live
+        side-by-side with the modules under src/.

diff --git a/admin/README b/admin/README
new file mode 100644 (file)
index 0000000..3970b50
--- /dev/null
+++ b/admin/README
@@ -0,0 +1,7 @@
+Here you'll find plain text documentation of how SCons administrative
+procedures are handled.  Files contained herein:
+
+change.txt
+        How changes are integrated, including generating and
+        distributing aedist change sets, and updating the CVS repository
+        on SourceForge.

diff --git a/admin/change.txt b/admin/change.txt
new file mode 100644 (file)
index 0000000..ad769af
--- /dev/null
+++ b/admin/change.txt
@@ -0,0 +1,56 @@
+Handling a change set:
+
+    -- Start the change:
+
+               aedb {cnum}     [if it's initiated locally]
+               aedist -r       [if it's a remote submission]
+
+    -- Normal development cycle:
+
+               aeb
+               aet
+               aet -bl
+               aet -reg        [optional]
+               aed
+               aede
+
+    -- As the reviewer:
+ 
+               aerpass {cnum}
+
+    -- As the integrator:
+
+               aeib {cnum}
+               aeb
+               aet
+               aet -bl
+               aet -reg
+               aed
+               aeipass
+
+    -- Distribute the change to scons-aedist:
+
+               aedist -s -p scons.0.1 {cnum} > scons.0.1.C{cnum}.ae
+               pine -attach scons.0.1C{cnum}.ae scons-aedist@lists.sourceforge.net
+                       Subject: scons.0.1 - {SUMMARY}
+                       Body:  aegis -l -p scons.0.1 -c {cnum} cd
+
+               rm scons.0.1.C{cnum}.ae
+
+       [This will eventually be automated.]
+
+    -- Update the aedist baseline on the web site:
+
+               aedist -s -bl -p scons.0.1 > scons.0.1.ae
+               scp scons.0.1.ae stevenknight@scons.sourceforge.net:/home/groups/s/sc/scons/htdocs/scons.0.1.ae
+               rm scons.0.1.ae
+
+       [This will eventually be automated.]
+
+    -- Distribute the change to CVS:
+
+               export CVS_RSH=ssh
+               ae2cvs -n -aegis -p scons.0.1 -c {cnum} -u ~/SCons/scons
+               ae2cvs -x -aegis -p scons.0.1 -c {cnum} -u ~/SCons/scons
+
+       [This may eventually be automated.]