From 445755cb1f9663035326e9d6be812ce53bb5cf11 Mon Sep 17 00:00:00 2001 From: Steven Knight Date: Fri, 14 Dec 2001 02:14:10 +0000 Subject: Prepare release notes, change log, etc. --- Construct | 6 ++-- HOWTO/README | 3 ++ HOWTO/release.txt | 62 +++++++++++++++++++++++++++++++++++ src/CHANGES.txt | 36 +++++++++++++++++++++ src/README.txt | 12 ++++++- src/RELEASE.txt | 96 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 212 insertions(+), 3 deletions(-) create mode 100644 HOWTO/release.txt create mode 100644 src/CHANGES.txt create mode 100644 src/RELEASE.txt diff --git a/Construct b/Construct index 049ce06..9c61370 100644 --- a/Construct +++ b/Construct @@ -244,8 +244,10 @@ $scons = { debian/scons.postinst debian/scons.prerm) ], - 'files' => [ qw(LICENSE.txt README.txt os_spawnv_fix.diff - scons.1 script/scons.bat setup.cfg setup.py) ], + 'files' => [ qw(CHANGES.txt LICENSE.txt + README.txt RELEASE.txt + os_spawnv_fix.diff scons.1 + script/scons.bat setup.cfg setup.py) ], 'filemap' => { 'scons.1' => '../doc/man/scons.1', }, diff --git a/HOWTO/README b/HOWTO/README index 32f1170..cda7606 100644 --- a/HOWTO/README +++ b/HOWTO/README @@ -5,3 +5,6 @@ change.txt How changes are integrated, including generating and distributing aedist change sets, and updating the CVS repository on SourceForge. + +release.txt + Steps to go through when releasing a new version of SCons. diff --git a/HOWTO/release.txt b/HOWTO/release.txt new file mode 100644 index 0000000..0adc94e --- /dev/null +++ b/HOWTO/release.txt @@ -0,0 +1,62 @@ +Things to do to release a version of SCons: + + Prepare RELEASE notes + + Prepare CHANGES text + + Read through the README.txt file for any updates + + Build candidate packages + + test on Linux + test on Windows NT + + + + END THE BRANCH (need more info) + + START THE NEW BRANCH (need more info) + + + + Read through the FAQ for any updates + + Update the web site: + + new version number (template) + announcement on the home page + new packages in the download page + checkin new scons-doc.tar.gz on the web site + + + + Upload the packages to the web site (download page) + + Test downloading from the web site + + + + Upload the packages to the SourceForge project page + + Test downloading from the SourceForge project page + + + + Add news item to the SourceForge project page + + Prepare an announcement + + Announce to the following mailing lists: + + scons-announce@lists.sourceforge.net + scons-users@lists.sourceforge.net + scons-devel@lists.sourceforge.net + python-list@python.org + python-announce@python.org + cons-discuss@gnu.org + + linux-announce@news.ornl.gov? + + Notify freshmeat.net + + Notifty www.cmtoday.com/contribute.html diff --git a/src/CHANGES.txt b/src/CHANGES.txt new file mode 100644 index 0000000..0f0b823 --- /dev/null +++ b/src/CHANGES.txt @@ -0,0 +1,36 @@ +# Copyright (c) 2001 Steven Knight +# __FILE__ __REVISION__ __DATE__ __DEVELOPER__ + + + SCons - a software construction tool + + Change Log + + + +RELEASE 0.01 - Thu Dec 13 19:25:23 CST 2001 + +A brief overview of important functionality available in release 0.01: + + - C and C++ compilation on POSIX and Windows NT. + + - Automatic scanning of C/C++ source files for #include dependencies. + + - Support for building libraries; setting construction variables + allows creation of shared libraries. + + - Library and C preprocessor search paths. + + - File changes detected using MD5 signatures. + + - User-definable Builder objects for building files. + + - User-definable Scanner objects for scanning for dependencies. + + - Parallel build (-j) support. + + - Dependency cycles detected. + + - Linux packages available in RPM and Debian format. + + - Windows installer available. diff --git a/src/README.txt b/src/README.txt index 1659437..8bb1df4 100644 --- a/src/README.txt +++ b/src/README.txt @@ -13,6 +13,10 @@ files" are actually Python scripts, allowing you to use the full power of a real scripting language to solve build problems. You do not, however, need to know Python to use SCons effectively. +See the RELEASE.txt file for notes about this specific release, +including known problems. See the CHANGES.txt file for a list of +changes since the previous release. + LATEST VERSION ============== @@ -43,7 +47,13 @@ You should have system installation privileges (that is, "root" or DOCUMENTATION ============= -Documentation for SCons is available at: +See the RELEASE.txt file for notes about this specific release, +including known problems. See the CHANGES.txt file for a list of +changes since the previous release. + +The scons.1 man page is included in this package. + +Additional documentation for SCons is available at: http://www.scons.org/doc.html diff --git a/src/RELEASE.txt b/src/RELEASE.txt new file mode 100644 index 0000000..1c20e26 --- /dev/null +++ b/src/RELEASE.txt @@ -0,0 +1,96 @@ +# Copyright (c) 2001 Steven Knight +# __FILE__ __REVISION__ __DATE__ __DEVELOPER__ + + + SCons - a software construction tool + + Release Notes + + +This is an alpha release of SCons, a tool for building software (and +other files). SCons is implemented in Python, and its "configuration +files" are actually Python scripts, allowing you to use the full power +of a real scripting language to solve build problems. You do not, +however, need to know Python to use SCons effectively. + +So that everyone using SCons can help each other learn how to use it +more effectively, please sign up for the scons-users mailing list at: + + http://lists.sourceforge.net/lists/listinfo/scons-users + + + +RELEASE 0.01 - Thu Dec 13 19:25:23 CST 2001 + + This is the initial alpha release of SCons. This release contains a + lot of functionality, and owing to an extensive test suite, the SCons + team believes that this release is of sufficient quality that you can + use it for real work. + + Nevertheless, because this is an alpha release, heed the following + disclaimers: + + - Expect bugs. Please report any bugs or other problems that you + find to our bug tracker at our SourceForge project page: + + http://sourceforge.net/tracker/?func=add&group_id=30337&atid=398971 + + We have a reliable bug-fixing methodology already in place and + expect to respond to problems relatively quickly. + + - It is possible that interfaces will change in future releases. We + will strive to hold this to a minimum, but you may need to modify + your SConscript files in the future if there is a compelling reason + to change an interface. + + - Documentation is spottier than we'd like. You may need to dive + into the source code to figure out how to do something. We will + be addressing this in upcoming releases, but would be more than + glad to have your assistance in correcting this problem... :-) + + In particular, the "SCons Design" documentation on the SCons web + site is currently out of date, as we made significant changes to + portions of the interface as we figured out what worked and what + didn't during implementation.L + + KNOWN PROBLEMS IN THIS RELEASE: + + - Support for parallel builds (-j) does not work on WIN32 systems + prior to *official* Python release 2.2 (not 2.2 pre-releases). + + Prior to Python 2.2, there is a bug in Python's Win32 + implementation such that when a thread spawns an external command, + it blocks all threads from running. This breaks the SCons + multithreading architecture used to support -j builds. + + We have included a patch file, os_spawnv_fix.diff, that you can + use if you you want to fix your version of Python to support + parallel builds in SCons. + + - Again, the "SCons Design" documentation on the SCons web + site is currently out of date. Take what you read there with a + grain of salt. + + - There is a hard-coding that prevents using file timestamps instead + of MD5 signatures to determine if a file is up-to-date. (There + also isn't yet a mechanism to configure that.) + + - No support yet for the following future features: + + - Separate build directories (BuildDir(), a.k.a. "Link" in + Cons classic) + + - Repository search paths (-Y) + + - Configurable signature calculation + + - No support for caching built files. + + - No support yet for the following command-line options: + + -d -e -l --list-actions --list-derived --list-where + -o -p -q -r -R --random -u -w --write-filenames -W + --warn-undefined-variables + + Thank you for your interest, and please let us know how we can help + improve SCons for your needs. -- cgit v0.12