summaryrefslogtreecommitdiff
path: root/HOWTO
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2002-07-08 23:49:25 +0000
committerSteven Knight <knight@baldmt.com>2002-07-08 23:49:25 +0000
commit3de3284918acb0add37b818400c1a7309a3316ff (patch)
treeade66700ef7c766a9057b0672b2bd4e7e9be7159 /HOWTO
parenta745dc65b8ccbc9b843a992b97218d5551ef644c (diff)
downloadscons-3de3284918acb0add37b818400c1a7309a3316ff.tar.gz
Add a prototype os2 Platform() module.
Diffstat (limited to 'HOWTO')
-rw-r--r--HOWTO/new-platform.txt72
1 files changed, 72 insertions, 0 deletions
diff --git a/HOWTO/new-platform.txt b/HOWTO/new-platform.txt
new file mode 100644
index 00000000..7e2fce8b
--- /dev/null
+++ b/HOWTO/new-platform.txt
@@ -0,0 +1,72 @@
+Adding a new Platform to the SCons distribution:
+
+ -- Add the following files (aenf):
+
+ src/engine/SCons/Platform/xxx.py
+
+ Use one of the other Platform files as a template.
+
+ The tool_list() function should return the list of tools
+ that will be available through the default construction
+ Environment.
+
+ The generate() function should set construction variables:
+
+ ENV
+ OBJPREFIX
+ OBJSUFFIX
+ PROGPREFIX
+ PROGSUFFIX
+ LIBPREFIX
+ LIBSUFFIX
+ SHLIBPREFIX
+ SHLIBSUFFIX
+ LIBPREFIXES
+ LIBSUFFIXES
+
+ -- Modify the following files (aecp):
+
+ doc/man/scons.1
+
+ Add the new platform to the example of the platform
+ keyword when instantiating an Environment.
+
+ Add the list of default tools returned by tool_list()
+ for this platform.
+
+ rpm/scons.spec
+
+ Add to the list at the bottom of the file:
+
+ /usr/lib/scons/SCons/Platform/xxx.py
+ /usr/lib/scons/SCons/Platform/xxx.pyc
+
+ [THIS LIST SHOULD BE GENERATED FROM MANIFEST.in,
+ AND WILL BE SOME DAY.]
+
+ src/CHANGES.txt
+
+ Add mention of the new Platform specification.
+
+ src/engine/MANIFEST.in
+
+ Add to the list:
+
+ SCons/Platform/xxx.py
+
+ src/engine/SCons/Platform/Platform/PlatformTests.py
+
+ Copy and paste one of the other platform tests to verify
+ the ability to initialize an environment through a call
+ to the object returned by Platform('xxx')
+
+ src/engine/SCons/Platform/__init__.py
+
+ Add logic to platform_default() (if necessary) to return
+ the appropriate platform string.
+
+ test/Platform.py
+
+ Add the new platform to the SConstruct and SConscript
+ files. Add the expected output to the "expect"
+ variable.