summaryrefslogtreecommitdiffstats
path: root/doc/user/less-simple.xml
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2008-08-09 18:23:26 (GMT)
committerSteven Knight <knight@baldmt.com>2008-08-09 18:23:26 (GMT)
commitd0c5748eb01e8303b6221afad432cb908672c161 (patch)
tree962a16c94759f57f27387cb315e72a6a028aa443 /doc/user/less-simple.xml
parent2f5c0f667910c8c9db5e93842f5f6201409f704e (diff)
downloadSCons-d0c5748eb01e8303b6221afad432cb908672c161.zip
SCons-d0c5748eb01e8303b6221afad432cb908672c161.tar.gz
SCons-d0c5748eb01e8303b6221afad432cb908672c161.tar.bz2
Merged revisions 3057-3059,3061-3264 via svnmerge from
http://scons.tigris.org/svn/scons/branches/core ........ r3061 | stevenknight | 2008-06-10 10:06:24 -0700 (Tue, 10 Jun 2008) | 3 lines Issue 2085: Fix man page indentation under Debian systems. Also add escape characters to the beginnings of some necessary lines. ........ r3063 | GregNoel | 2008-06-10 17:50:28 -0700 (Tue, 10 Jun 2008) | 1 line Add David as a member; parametize input file ........ r3064 | stevenknight | 2008-06-11 07:22:23 -0700 (Wed, 11 Jun 2008) | 3 lines Issue 1973: Clarify the man page description of the SConscript(src_dir) argument. ........ r3065 | stevenknight | 2008-06-11 11:25:00 -0700 (Wed, 11 Jun 2008) | 3 lines Issues 1974, 1999: document {Add,Get,Set}Option(). Reorganize the section a little bit, other minor edits. ........ r3066 | garyo | 2008-06-12 19:53:51 -0700 (Thu, 12 Jun 2008) | 1 line Document GetBuildFailures in Users Guide. Closes issue #1989. ........ r3067 | stevenknight | 2008-06-14 06:42:07 -0700 (Sat, 14 Jun 2008) | 2 lines Fix build errors from undefined &GetBuildFailures; entity in doc. ........ r3073 | garyo | 2008-06-14 18:40:20 -0700 (Sat, 14 Jun 2008) | 1 line Fix issue #1538 (Handling of string argument in Action.Action). Includes test. ........ r3074 | garyo | 2008-06-14 19:11:30 -0700 (Sat, 14 Jun 2008) | 1 line doc: Trivial man page typo fix. ........ r3075 | stevenknight | 2008-06-15 14:35:13 -0700 (Sun, 15 Jun 2008) | 3 lines Add a test to make sure the env.RCS() applied to an individual file works correctly when the checked-out copy is changed. ........ r3076 | stevenknight | 2008-06-15 23:07:17 -0700 (Sun, 15 Jun 2008) | 2 lines Issue 2025: User's Guide updates from Randall Spangler's review. ........ r3078 | stevenknight | 2008-06-16 06:26:13 -0700 (Mon, 16 Jun 2008) | 2 lines Issue 1990: Document the Requires() function in the Users's Guide. ........ r3082 | stevenknight | 2008-06-16 19:31:00 -0700 (Mon, 16 Jun 2008) | 3 lines Fix the second example in the AddMethod() chapter. Show the Windows output generating a resource file. Other copyedits. ........ r3083 | stevenknight | 2008-06-17 06:44:02 -0700 (Tue, 17 Jun 2008) | 2 lines Fix misspelled entity: &Builders; => &Builder;s. ........ r3084 | stevenknight | 2008-06-17 08:30:13 -0700 (Tue, 17 Jun 2008) | 3 lines Issue 1588: - Document suggested use of the Viual C/C++ /FC option to fix the ability to double-click on file names in compilation error messages. ........ r3085 | stevenknight | 2008-06-17 08:50:33 -0700 (Tue, 17 Jun 2008) | 3 lines Issue 1687: Document the need to use Clean() for any SideEffect() files that must be explicitly removed when their targets are removed. ........ r3086 | stevenknight | 2008-06-17 10:59:28 -0700 (Tue, 17 Jun 2008) | 2 lines Typo fix in the new SideEffect() paragraph. (Gary Oberbrunner) ........ r3088 | cournape | 2008-06-17 19:55:27 -0700 (Tue, 17 Jun 2008) | 3 lines Initialized merge tracking via "svnmerge" with revisions "1-3087" from http://scons.tigris.org/svn/scons/branches/vs_revamp ........ r3094 | stevenknight | 2008-06-19 09:52:16 -0700 (Thu, 19 Jun 2008) | 3 lines Change the User's Guide to use the new Variables object and its associated function for controlling command-line build variables. ........ r3115 | stevenknight | 2008-06-25 06:46:36 -0700 (Wed, 25 Jun 2008) | 2 lines Issue 2072: end indentation after generated Builder text. ........ r3116 | stevenknight | 2008-06-25 19:07:15 -0700 (Wed, 25 Jun 2008) | 2 lines Reorganize the command-line arguments chapter. ........ r3117 | stevenknight | 2008-06-25 19:13:58 -0700 (Wed, 25 Jun 2008) | 2 lines Editing pass for formatting in the Glob() sections. ........ r3118 | stevenknight | 2008-06-25 19:23:09 -0700 (Wed, 25 Jun 2008) | 3 lines Wording changing: Preventing => Controlling, because the chapter also talks about how to clean additional targets. ........ r3119 | stevenknight | 2008-06-25 19:50:41 -0700 (Wed, 25 Jun 2008) | 2 lines Fix missing </literal> tags, minor wording fix. ........ r3120 | stevenknight | 2008-06-25 19:58:34 -0700 (Wed, 25 Jun 2008) | 2 lines Add "the Default Function" to the appropriate subsection title. ........ r3121 | stevenknight | 2008-06-26 08:33:43 -0700 (Thu, 26 Jun 2008) | 2 lines Issue 1988: Document the Variables.UnknownVariables() method. ........ r3122 | stevenknight | 2008-06-26 08:35:51 -0700 (Thu, 26 Jun 2008) | 3 lines Remove comments listing some of the variables that have been documented recently. ........ r3123 | stevenknight | 2008-06-26 12:42:53 -0700 (Thu, 26 Jun 2008) | 2 lines Issue 2118: Fix incorrectly swapped man page text. (Alexey Zezukin) ........ r3124 | bdbaddog | 2008-06-26 21:23:46 -0700 (Thu, 26 Jun 2008) | 2 lines Fix bug 2108 - duplicate text in description of interactive mode ........ r3125 | stevenknight | 2008-06-27 21:54:56 -0700 (Fri, 27 Jun 2008) | 3 lines Issue 1993: Document the $*COMSTR variables, the Progress() function, and create a common "Controlling Build Output" chapter. ........ r3126 | garyo | 2008-06-28 05:46:44 -0700 (Sat, 28 Jun 2008) | 1 line Fix issue 2105; temporarily omit doc saying that SetOption can override user-created Options (until that is implemented). ........ r3127 | stevenknight | 2008-06-28 07:29:18 -0700 (Sat, 28 Jun 2008) | 2 lines Issue 1747: Explicitly document use of Node lists as input to Depends(). ........ r3128 | stevenknight | 2008-06-28 07:48:32 -0700 (Sat, 28 Jun 2008) | 6 lines White space change: indent the construction environment sections further to make way for combining this chapter with others to make one big "Controlling Environments" chapter. Also, get rid of some now-unnecessary doc from the old Cons classic POD, that was taking up space here waiting to be documented. ........ r3129 | cournape | 2008-06-29 01:56:30 -0700 (Sun, 29 Jun 2008) | 3 lines Initialized merge tracking via "svnmerge" with revisions "1-3128" from http://scons.tigris.org/svn/scons/branches/trygrep ........ r3143 | stevenknight | 2008-07-02 10:29:39 -0700 (Wed, 02 Jul 2008) | 3 lines Initialized merge tracking via "svnmerge" with revisions "1-3142" from http://scons.tigris.org/svn/scons/branches/sgk_lookup ........ r3181 | stevenknight | 2008-07-08 07:17:27 -0700 (Tue, 08 Jul 2008) | 4 lines Reorganize the discussion of different environments into one chapter. Document the SetDefault(), PrependUnique(), AppendUnique(), PrependENVPath() and AppendENVPath() functions. ........ r3182 | stevenknight | 2008-07-08 08:47:55 -0700 (Tue, 08 Jul 2008) | 2 lines Issue 1998: Docment the ARGLIST variable in the User's Guide. ........ r3194 | GregNoel | 2008-07-09 23:16:51 -0700 (Wed, 09 Jul 2008) | 1 line remove unnecessary trailing spaces on lines ........ r3204 | stevenknight | 2008-07-11 08:29:18 -0700 (Fri, 11 Jul 2008) | 2 lines Issue 1853: Remove referenc to SCons.Util.CLVar from a doc example. ........ r3206 | GregNoel | 2008-07-12 02:08:19 -0700 (Sat, 12 Jul 2008) | 1 line Another go at describing VariantDir() ........ r3213 | stevenknight | 2008-07-13 08:57:57 -0700 (Sun, 13 Jul 2008) | 3 lines Set /branches/comments in svnmerge-integrated property to allow merging changes in both directions. ........ r3217 | stevenknight | 2008-07-16 06:52:44 -0700 (Wed, 16 Jul 2008) | 2 lines Update the copyright year in the User's Guide. ........ r3218 | stevenknight | 2008-07-16 07:08:52 -0700 (Wed, 16 Jul 2008) | 3 lines Issue 1881: Add man page text clarifying the behavior of Add{Pre,Post}Action() when multiple targets are specified. ........ r3223 | stevenknight | 2008-07-18 08:18:45 -0700 (Fri, 18 Jul 2008) | 3 lines Initialized merge tracking via "svnmerge" with revisions "1-3222" from http://scons.tigris.org/svn/scons/branches/sgk_subst ........ r3231 | stevenknight | 2008-07-22 01:58:11 -0700 (Tue, 22 Jul 2008) | 4 lines Enhance MSVSProject() tests so they're runnable on any system, regardless of whether Visual Studio is installed, or if it's even a Windows system at all. ........ r3237 | GregNoel | 2008-07-26 00:07:49 -0700 (Sat, 26 Jul 2008) | 1 line Issue 1983: Document ParseConfig, MergeFlags, and ParseFlags for the Users' Guide ........ r3238 | stevenknight | 2008-07-26 08:38:18 -0700 (Sat, 26 Jul 2008) | 3 lines Follow-ons for building the User's Guide with Greg's recent additions for MergeFlags() and ParseFlags(). ........ r3239 | stevenknight | 2008-07-26 09:52:40 -0700 (Sat, 26 Jul 2008) | 3 lines Re-arrange some sections talking about creating construction environments and fetching/expanding variables. ........ r3240 | stevenknight | 2008-07-26 12:16:11 -0700 (Sat, 26 Jul 2008) | 2 lines Stylistic editing of new {Merge,Parse}{Config,Flags} sections. ........ r3241 | GregNoel | 2008-07-26 12:42:42 -0700 (Sat, 26 Jul 2008) | 1 line Issue 1987: Document SideEffect for Users' Guide (incomplete) ........ r3242 | stevenknight | 2008-07-26 13:27:56 -0700 (Sat, 26 Jul 2008) | 2 lines Correct dumb XML mistakes in my last checkin. ........ r3243 | stevenknight | 2008-07-26 13:34:05 -0700 (Sat, 26 Jul 2008) | 2 lines One-character typo. Gah. ........ r3244 | stevenknight | 2008-07-26 13:44:14 -0700 (Sat, 26 Jul 2008) | 2 lines Issue 1977,1980: document the Exit() and Flatten() functions. ........ r3245 | stevenknight | 2008-07-27 10:24:12 -0700 (Sun, 27 Jul 2008) | 14 lines Updates to the new SideEffect section (kudos to Greg). While working on this, Greg discovered a bug (issue #2154) that prevents a SideEffect() file from being used as input to another builder call; it makes the builder target not get build when run in paralle (e.g. -j2)... :-( So this patch comments out that section of Greg's section. This also contains my usual editing pass. In this case I changed some of the examples and added a bunch of text to try to help clarify some things that seemed important. I also added a closing paragraph warning that SideEffect() really shouldn't be used as an alternative to specifying multiple target files in a Builder call when a command builds more than one file that you care about. ........ r3246 | stevenknight | 2008-07-27 10:31:17 -0700 (Sun, 27 Jul 2008) | 2 lines Proofreading edits of the MergeFlags() section. (Greg Noel) ........ r3247 | stevenknight | 2008-07-27 11:17:27 -0700 (Sun, 27 Jul 2008) | 2 lines Issue 1976: document ensure{Python,SCons}Version() in the User's Guide. ........ r3249 | GregNoel | 2008-07-28 15:57:00 -0700 (Mon, 28 Jul 2008) | 1 line Add svn-bisect script ........
Diffstat (limited to 'doc/user/less-simple.xml')
-rw-r--r--doc/user/less-simple.xml40
1 files changed, 22 insertions, 18 deletions
diff --git a/doc/user/less-simple.xml b/doc/user/less-simple.xml
index 5392518..35b6b60 100644
--- a/doc/user/less-simple.xml
+++ b/doc/user/less-simple.xml
@@ -198,15 +198,19 @@
</section>
<section>
- <title>Making a list of files with Glob()</title>
+ <title>Making a list of files with &Glob;</title>
<para>
- You can also use the Glob() function to find all files matching a
- certain template, using standard the shell pattern matching
- characters *, ?, and [abc] to match any of a, b, or c. [!abc] is
- also supported, to match any character <emphasis>except</emphasis>
- a, b, or c. This makes many multi-source-file builds quite easy:
+ You can also use the &Glob; function to find all files matching a
+ certain template, using the standard shell pattern matching
+ characters <literal>*</literal>, <literal>?</literal>
+ and <literal>[abc]</literal> to match any of
+ <literal>a</literal>, <literal>b</literal> or <literal>c</literal>.
+ <literal>[!abc]</literal> is also supported,
+ to match any character <emphasis>except</emphasis>
+ <literal>a</literal>, <literal>b</literal> or <literal>c</literal>.
+ This makes many multi-source-file builds quite easy:
</para>
@@ -216,8 +220,8 @@
<para>
- The SCons man page has more details on using Glob() with Variant
- dirs and Repositories and returning strings rather than Nodes.
+ The SCons man page has more details on using &Glob; with Variant
+ directories and Repositories, and returning strings rather than Nodes.
</para>
@@ -377,8 +381,8 @@
</para>
<programlisting>
- list = Split('main.c file1.c file2.c')
- Program('program', list)
+ src_files = Split('main.c file1.c file2.c')
+ Program('program', src_files)
</programlisting>
<para>
@@ -393,10 +397,10 @@
</para>
<programlisting>
- list = Split("""main.c
- file1.c
- file2.c""")
- Program('program', list)
+ src_files = Split("""main.c
+ file1.c
+ file2.c""")
+ Program('program', src_files)
</programlisting>
<para>
@@ -429,8 +433,8 @@
</para>
<programlisting>
- list = Split('main.c file1.c file2.c')
- Program(target = 'program', source = list)
+ src_files = Split('main.c file1.c file2.c')
+ Program(target = 'program', source = src_files)
</programlisting>
<para>
@@ -442,8 +446,8 @@
</para>
<programlisting>
- list = Split('main.c file1.c file2.c')
- Program(source = list, target = 'program')
+ src_files = Split('main.c file1.c file2.c')
+ Program(source = src_files, target = 'program')
</programlisting>
<para>