From 48f19e9e5ecc069f379ad433fdaf280ac9b54e16 Mon Sep 17 00:00:00 2001 From: Luca Falavigna Date: Sat, 23 Jan 2010 15:22:02 +0100 Subject: Imported Upstream version 1.2.0.d20100117 --- doc/SConscript | 12 ++--- doc/design/scons.mod | 2 +- doc/developer/architecture.xml | 2 +- doc/developer/branches.xml | 2 +- doc/developer/copyright.xml | 2 +- doc/developer/cycle.xml | 2 +- doc/developer/main.xml | 2 +- doc/developer/packaging.xml | 2 +- doc/developer/preface.xml | 2 +- doc/developer/sourcetree.xml | 2 +- doc/developer/testing.xml | 2 +- doc/man/scons-time.1 | 6 +-- doc/man/scons.1 | 27 +++++++----- doc/man/sconsign.1 | 6 +-- doc/python10/scons.mod | 2 +- doc/scons.mod | 3 +- doc/user/README | 2 +- doc/user/actions.in | 2 +- doc/user/actions.xml | 2 +- doc/user/add-method.in | 2 +- doc/user/add-method.xml | 14 +----- doc/user/alias.in | 2 +- doc/user/alias.xml | 2 +- doc/user/ant.in | 2 +- doc/user/ant.xml | 2 +- doc/user/build-install.in | 24 +++++----- doc/user/build-install.xml | 24 +++++----- doc/user/builders-built-in.in | 2 +- doc/user/builders-built-in.xml | 14 +----- doc/user/builders-commands.in | 2 +- doc/user/builders-commands.xml | 2 +- doc/user/builders-writing.in | 22 ++++++---- doc/user/builders-writing.xml | 22 ++++++---- doc/user/builders.in | 2 +- doc/user/builders.xml | 2 +- doc/user/caching.in | 2 +- doc/user/caching.xml | 2 +- doc/user/command-line.in | 2 +- doc/user/command-line.xml | 45 +++++++++---------- doc/user/copyright.in | 2 +- doc/user/copyright.xml | 2 +- doc/user/depends.in | 74 ++++++++++++++++--------------- doc/user/depends.xml | 99 +++++++++++++++++++++--------------------- doc/user/environments.in | 2 +- doc/user/environments.xml | 25 ++--------- doc/user/errors.in | 2 +- doc/user/errors.xml | 2 +- doc/user/example.in | 2 +- doc/user/example.xml | 2 +- doc/user/factories.in | 2 +- doc/user/factories.xml | 2 +- doc/user/file-removal.in | 2 +- doc/user/file-removal.xml | 2 +- doc/user/hierarchy.in | 2 +- doc/user/hierarchy.xml | 2 +- doc/user/install.in | 2 +- doc/user/install.xml | 2 +- doc/user/java.in | 2 +- doc/user/java.xml | 2 +- doc/user/less-simple.in | 2 +- doc/user/less-simple.xml | 14 +----- doc/user/libraries.in | 2 +- doc/user/libraries.xml | 26 +---------- doc/user/main.in | 2 +- doc/user/main.xml | 2 +- doc/user/make.in | 2 +- doc/user/make.xml | 2 +- doc/user/mergeflags.in | 2 +- doc/user/mergeflags.xml | 2 +- doc/user/misc.in | 2 +- doc/user/misc.xml | 4 +- doc/user/nodes.in | 2 +- doc/user/nodes.xml | 14 +----- doc/user/output.in | 2 +- doc/user/output.xml | 14 +----- doc/user/parseconfig.in | 28 +++++++++++- doc/user/parseconfig.xml | 50 +++++++++++---------- doc/user/parseflags.in | 2 +- doc/user/parseflags.xml | 14 +----- doc/user/preface.in | 2 +- doc/user/preface.xml | 2 +- doc/user/python.in | 2 +- doc/user/python.xml | 2 +- doc/user/repositories.in | 2 +- doc/user/repositories.xml | 2 +- doc/user/run.in | 2 +- doc/user/run.xml | 2 +- doc/user/scanners.in | 2 +- doc/user/scanners.xml | 2 +- doc/user/sconf.in | 2 +- doc/user/sconf.xml | 2 +- doc/user/separate.in | 2 +- doc/user/separate.xml | 2 +- doc/user/sideeffect.in | 2 +- doc/user/sideeffect.xml | 2 +- doc/user/simple.in | 2 +- doc/user/simple.xml | 38 +--------------- doc/user/sourcecode.in | 2 +- doc/user/sourcecode.xml | 2 +- doc/user/tasks.in | 2 +- doc/user/tasks.xml | 2 +- doc/user/tools.in | 2 +- doc/user/tools.xml | 2 +- doc/user/troubleshoot.in | 2 +- doc/user/troubleshoot.xml | 38 ++++------------ doc/user/variables.in | 2 +- doc/user/variables.xml | 2 +- doc/user/variants.in | 2 +- doc/user/variants.xml | 14 +----- 109 files changed, 352 insertions(+), 485 deletions(-) (limited to 'doc') diff --git a/doc/SConscript b/doc/SConscript index fd18ef4..9ad4d12 100644 --- a/doc/SConscript +++ b/doc/SConscript @@ -3,7 +3,7 @@ # # -# Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 The SCons Foundation +# Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 The SCons Foundation # # Permission is hereby granted, free of charge, to any person obtaining # a copy of this software and associated documentation files (the @@ -102,8 +102,8 @@ s = Scanner(name = 'xml', function = scanxml, skeys = ['.xml', '.mod']) orig_env = env env = orig_env.Clone(SCANNERS = [s], - SCONS_PROC_PY = File('#bin/scons-proc.py').rfile(), - SCONSOUTPUT_PY = File('#bin/sconsoutput.py').rfile()) + SCONS_DOC_PY = File('#bin/scons-doc.py').rfile(), + SCONS_PROC_PY = File('#bin/scons-proc.py').rfile()) # Fetch the list of files in the build engine that contain # SCons documentation XML for processing. @@ -231,7 +231,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. 'SCons-win32-install-3.jpg', 'SCons-win32-install-4.jpg', ], - 'sconsoutput' : 1, + 'scons-doc' : 1, }, } @@ -257,7 +257,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. manifest = File(os.path.join(doc, 'MANIFEST')).rstr() src_files = map(lambda x: x[:-1], open(manifest).readlines()) - build_doc = docs[doc].get('sconsoutput') and int(ARGUMENTS.get('BUILDDOC', 0)) + build_doc = docs[doc].get('scons-doc') and int(ARGUMENTS.get('BUILDDOC', 0)) for s in src_files: doc_s = os.path.join(doc, s) build_s = os.path.join(build, doc, s) @@ -268,7 +268,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. if build_doc and ext == '.xml': env.Command(doc_s, base + '.in', - "$PYTHON $SCONSOUTPUT_PY $SOURCE > $TARGET") + "$PYTHON $SCONS_DOC_PY $SOURCE > $TARGET") orig_env.SCons_revision(build_s, doc_s) Local(build_s) diff --git a/doc/design/scons.mod b/doc/design/scons.mod index d805210..012bc3e 100644 --- a/doc/design/scons.mod +++ b/doc/design/scons.mod @@ -1,6 +1,6 @@ + - - % scons -Q - gcc -o hello.o -c hello.c - gcc -o version.o -c version.c - gcc -o hello hello.o version.o - % scons -Q - gcc -o version.o -c version.c - gcc -o hello hello.o version.o - % scons -Q - gcc -o version.o -c version.c - gcc -o hello hello.o version.o - + (Note that for the above example to work, + we &sleep; for one second in between each run, + so that the &SConstruct; file will create a + version.c file with a time string + that's one second later than the previous run.) + + @@ -1694,19 +1691,24 @@ With these changes, - we get the desired behavior of - re-building the version.o file, - and therefore re-linking the hello executable, - only when the hello.c has changed: + we get the desired behavior of only + re-linking the hello executable + when the hello.c has changed, + even though the version.o is rebuilt + (because the &SConstruct; file still changes the + version.c contents directly each run): - scons -Q - scons -Q + scons -Q hello + sleep 1 + scons -Q hello + sleep 1 edit hello.c - scons -Q - scons -Q + scons -Q hello + sleep 1 + scons -Q hello diff --git a/doc/user/depends.xml b/doc/user/depends.xml index b72f41f..d386a1f 100644 --- a/doc/user/depends.xml +++ b/doc/user/depends.xml @@ -1,6 +1,6 @@ @@ -1568,7 +1559,7 @@ If we list version.c as an actual source file, - though, then version.o + though, then the version.o file will get rebuilt every time we run &SCons; (because the &SConstruct; file itself changes the contents of version.c) @@ -1578,27 +1569,30 @@ - + (Note that for the above example to work, + we &sleep; for one second in between each run, + so that the &SConstruct; file will create a + version.c file with a time string + that's one second later than the previous run.) - - % scons -Q - gcc -o hello.o -c hello.c - gcc -o version.o -c version.c - gcc -o hello hello.o version.o - % scons -Q - gcc -o version.o -c version.c - gcc -o hello hello.o version.o - % scons -Q - gcc -o version.o -c version.c - gcc -o hello hello.o version.o - + @@ -1644,28 +1638,35 @@ With these changes, - we get the desired behavior of - re-building the version.o file, - and therefore re-linking the hello executable, - only when the hello.c has changed: + we get the desired behavior of only + re-linking the hello executable + when the hello.c has changed, + even though the version.o is rebuilt + (because the &SConstruct; file still changes the + version.c contents directly each run): - % scons -Q + % scons -Q hello cc -o version.o -c version.c cc -o hello.o -c hello.c cc -o hello version.o hello.o - % scons -Q - scons: `.' is up to date. + % sleep 1 + % scons -Q hello + cc -o version.o -c version.c + scons: `hello' is up to date. + % sleep 1 % edit hello.c [CHANGE THE CONTENTS OF hello.c] - % scons -Q + % scons -Q hello cc -o version.o -c version.c cc -o hello.o -c hello.c cc -o hello version.o hello.o - % scons -Q - scons: `.' is up to date. + % sleep 1 + % scons -Q hello + cc -o version.o -c version.c + scons: `hello' is up to date. diff --git a/doc/user/environments.in b/doc/user/environments.in index 124aaaa..dfe98f2 100644 --- a/doc/user/environments.in +++ b/doc/user/environments.in @@ -1,6 +1,6 @@ + + + % scons -Q + ['/lib/compat', '/usr/X11/include'] + scons: `.' is up to date. + @@ -109,6 +122,19 @@ + + + + % scons -Q + ['/usr/X11/include'] + scons: `.' is up to date. + diff --git a/doc/user/parseconfig.xml b/doc/user/parseconfig.xml index 1f85ad0..534ea3d 100644 --- a/doc/user/parseconfig.xml +++ b/doc/user/parseconfig.xml @@ -1,6 +1,6 @@ + % scons -Q - Package x11 was not found in the pkg-config search path. - Perhaps you should add the directory containing `x11.pc' - to the PKG_CONFIG_PATH environment variable - No package 'x11' found - OSError: 'pkg-config x11 --cflags --libs' exited 1: - File "/home/my/project/SConstruct", line 3: - env.ParseConfig("pkg-config x11 --cflags --libs") - File "bootstrap/src/engine/SCons/Environment.py", line 1474: - None - File "bootstrap/src/engine/SCons/Environment.py", line 593: - None + ['/lib/compat', '/usr/X11/include'] + scons: `.' is up to date. @@ -116,17 +118,19 @@ print env['CPPPATH'] + + % scons -Q - Package x11 was not found in the pkg-config search path. - Perhaps you should add the directory containing `x11.pc' - to the PKG_CONFIG_PATH environment variable - No package 'x11' found - OSError: 'pkg-config x11 --cflags --libs' exited 1: - File "/home/my/project/SConstruct", line 2: - env.ParseConfig("pkg-config x11 --cflags --libs") - File "bootstrap/src/engine/SCons/Environment.py", line 1474: - None - File "bootstrap/src/engine/SCons/Environment.py", line 593: - None + ['/usr/X11/include'] + scons: `.' is up to date. diff --git a/doc/user/parseflags.in b/doc/user/parseflags.in index b21df4f..d65e5b8 100644 --- a/doc/user/parseflags.in +++ b/doc/user/parseflags.in @@ -1,6 +1,6 @@