From 2e862e98a5109da56222d7ba7bcc52c5d718ea82 Mon Sep 17 00:00:00 2001 From: Steven Knight Date: Wed, 19 Sep 2001 14:29:08 +0000 Subject: Add an outline for a User's Guide. --- doc/Conscript | 3 + doc/scons.mod | 24 ++++++- doc/user/.aeignore | 3 + doc/user/builders.sgml | 32 ++++++++++ doc/user/caching.sgml | 21 +++++++ doc/user/cons.sgml | 21 +++++++ doc/user/depends.sgml | 76 ++++++++++++++++++++++ doc/user/environments.sgml | 43 +++++++++++++ doc/user/errors.sgml | 21 +++++++ doc/user/example.sgml | 21 +++++++ doc/user/hierarchy.sgml | 32 ++++++++++ doc/user/main.sgml | 153 +++++++++++++++++++++++++++++++++++++++++++++ doc/user/make.sgml | 21 +++++++ doc/user/more.sgml | 109 ++++++++++++++++++++++++++++++++ doc/user/preface.sgml | 65 +++++++++++++++++++ doc/user/reference.sgml | 43 +++++++++++++ doc/user/repositories.sgml | 32 ++++++++++ doc/user/run.sgml | 65 +++++++++++++++++++ doc/user/scanners.sgml | 21 +++++++ doc/user/simple.sgml | 87 ++++++++++++++++++++++++++ doc/user/troubleshoot.sgml | 21 +++++++ doc/user/variants.sgml | 21 +++++++ 22 files changed, 934 insertions(+), 1 deletion(-) create mode 100644 doc/user/.aeignore create mode 100644 doc/user/builders.sgml create mode 100644 doc/user/caching.sgml create mode 100644 doc/user/cons.sgml create mode 100644 doc/user/depends.sgml create mode 100644 doc/user/environments.sgml create mode 100644 doc/user/errors.sgml create mode 100644 doc/user/example.sgml create mode 100644 doc/user/hierarchy.sgml create mode 100644 doc/user/main.sgml create mode 100644 doc/user/make.sgml create mode 100644 doc/user/more.sgml create mode 100644 doc/user/preface.sgml create mode 100644 doc/user/reference.sgml create mode 100644 doc/user/repositories.sgml create mode 100644 doc/user/run.sgml create mode 100644 doc/user/scanners.sgml create mode 100644 doc/user/simple.sgml create mode 100644 doc/user/troubleshoot.sgml create mode 100644 doc/user/variants.sgml diff --git a/doc/Conscript b/doc/Conscript index 9e5f0d9..8a5f15f 100644 --- a/doc/Conscript +++ b/doc/Conscript @@ -48,6 +48,9 @@ Ignore("version.sgml"); 'html' => 'scons.html', 'text' => 1, }, + 'user' => { + 'html' => 'book1.html', + }, ); # Find internal dependencies in .sgml files: diff --git a/doc/scons.mod b/doc/scons.mod index 7e5470e..7a36685 100644 --- a/doc/scons.mod +++ b/doc/scons.mod @@ -57,7 +57,7 @@ @@ -65,17 +65,29 @@ Alias"> Aliases"> Build"> +Cache"> Clean"> +Clone"> Command"> Copy"> Default"> +DefaultRules"> +Depends"> Environment"> Export"> Help"> +Ignore"> +Install"> +InstallAs"> Link"> Local"> +Module"> +Objects"> Precious"> Repository"> +RuleSet"> +Salt"> +SourceSignature"> Task"> @@ -95,6 +107,16 @@ + +SCONSFLAGS"> + + + + diff --git a/doc/user/.aeignore b/doc/user/.aeignore new file mode 100644 index 0000000..872e8be --- /dev/null +++ b/doc/user/.aeignore @@ -0,0 +1,3 @@ +*,D +.*.swp +.consign diff --git a/doc/user/builders.sgml b/doc/user/builders.sgml new file mode 100644 index 0000000..f74f1aa --- /dev/null +++ b/doc/user/builders.sgml @@ -0,0 +1,32 @@ + + + + X + + + +
+ Builders That Execute External Commands + + + + X + + + +
+ +
+ Builders That Execute Python Functions + + + + X + + + +
diff --git a/doc/user/caching.sgml b/doc/user/caching.sgml new file mode 100644 index 0000000..66db8ad --- /dev/null +++ b/doc/user/caching.sgml @@ -0,0 +1,21 @@ + + + + X + + + +
+ The &Cache; Method + + + + X + + + +
diff --git a/doc/user/cons.sgml b/doc/user/cons.sgml new file mode 100644 index 0000000..2514e74 --- /dev/null +++ b/doc/user/cons.sgml @@ -0,0 +1,21 @@ + + + + X + + + +
+ X + + + + X + + + +
diff --git a/doc/user/depends.sgml b/doc/user/depends.sgml new file mode 100644 index 0000000..eb5c422 --- /dev/null +++ b/doc/user/depends.sgml @@ -0,0 +1,76 @@ + + + + X + + + +
+ MD5 Signatures + + + + X + + + +
+ +
+ Time Stamps + + + + X + + + +
+ +
+ The &Depends; Method + + + + X + + + +
+ +
+ The &Ignore; Method + + + + X + + + +
+ +
+ The &Salt; Method + + + + X + + + +
+ +
+ The &SourceSignature; Method + + + + X + + + +
diff --git a/doc/user/environments.sgml b/doc/user/environments.sgml new file mode 100644 index 0000000..59ad3cf --- /dev/null +++ b/doc/user/environments.sgml @@ -0,0 +1,43 @@ + + + + X + + + +
+ The &Environment; Constructor + + + + X + + + +
+ +
+ The &Clone; Method + + + + X + + + +
+ +
+ The &Copy; Method + + + + X + + + +
diff --git a/doc/user/errors.sgml b/doc/user/errors.sgml new file mode 100644 index 0000000..2514e74 --- /dev/null +++ b/doc/user/errors.sgml @@ -0,0 +1,21 @@ + + + + X + + + +
+ X + + + + X + + + +
diff --git a/doc/user/example.sgml b/doc/user/example.sgml new file mode 100644 index 0000000..2514e74 --- /dev/null +++ b/doc/user/example.sgml @@ -0,0 +1,21 @@ + + + + X + + + +
+ X + + + + X + + + +
diff --git a/doc/user/hierarchy.sgml b/doc/user/hierarchy.sgml new file mode 100644 index 0000000..3b5e24f --- /dev/null +++ b/doc/user/hierarchy.sgml @@ -0,0 +1,32 @@ + + + + X + + + +
+ &SConscript; Files + + + + X + + + +
+ +
+ X + + + + X + + + +
diff --git a/doc/user/main.sgml b/doc/user/main.sgml new file mode 100644 index 0000000..eb7ab39 --- /dev/null +++ b/doc/user/main.sgml @@ -0,0 +1,153 @@ + + + + %version; + + + %scons; + + + + + + + + + + + + + + + + + + + + +]> + + + + SCons User Guide &build_version; + + + Steven + Knight + + + Revision &build_revision; (&build_date;) + + 2001 + + + 2001 + Steven Knight + + + + ©right; + + + version &build_version; + + + + + Preface + &preface; + + + + Simple Builds + &simple; + + + + Construction Environments + &environments; + + + + Dependencies + &depends; + + + + More Things to Do With Builds + &more; + + + + Hierarchial Builds + &hierarchy; + + + + Variant Builds + &variants; + + + + Writing Builders + &builders; + + + + Writing Scanners + &scanners; + + + + Building From Code Repositories + &repositories; + + + + Caching Built Files + &caching; + + + + How to Run &SCons; + &run; + + + + Troubleshooting + &troubleshoot; + + + + Quick Reference + &reference; + + + + Errors Generated by &SCons; + &errors; + + + + Complex &SCons; Example + &example; + + + + Converting From Make + &make; + + + + Converting From Cons + &cons; + + + diff --git a/doc/user/make.sgml b/doc/user/make.sgml new file mode 100644 index 0000000..2514e74 --- /dev/null +++ b/doc/user/make.sgml @@ -0,0 +1,21 @@ + + + + X + + + +
+ X + + + + X + + + +
diff --git a/doc/user/more.sgml b/doc/user/more.sgml new file mode 100644 index 0000000..dc1d0a3 --- /dev/null +++ b/doc/user/more.sgml @@ -0,0 +1,109 @@ + + + + X + + + +
+ The &InstallAs; Method + + + + X + + + +
+ +
+ The &Precious; Method + + + + X + + + +
+ +
+ The &Command; Method + + + + X + + + +
+ +
+ The &Objects; Method + + + + X + + + +
+ +
+ The &Program; Method + + + + X + + + +
+ +
+ The &Library; Method + + + + X + + + +
+ +
+ The &Module; Method + + + + X + + + +
+ +
+ The &RuleSet; Method + + + + X + + + +
+ +
+ The &DefaultRules; Method + + + + X + + + +
diff --git a/doc/user/preface.sgml b/doc/user/preface.sgml new file mode 100644 index 0000000..2fddf4e --- /dev/null +++ b/doc/user/preface.sgml @@ -0,0 +1,65 @@ + + + + X + + + +
+ Why &SCons;? + + + + X + + + +
+ +
+ History + + + + X + + + +
+ +
+ Conventions + + + + X + + + +
+ +
+ Acknowledgements + + + + X + + + +
+ +
+ Contact + + + + X + + + +
diff --git a/doc/user/reference.sgml b/doc/user/reference.sgml new file mode 100644 index 0000000..594ced1 --- /dev/null +++ b/doc/user/reference.sgml @@ -0,0 +1,43 @@ + + + + X + + + +
+ Command-Line Options + + + + X + + + +
+ +
+ Default Builders + + + + X + + + +
+ +
+ X + + + + X + + + +
diff --git a/doc/user/repositories.sgml b/doc/user/repositories.sgml new file mode 100644 index 0000000..8ba1ff7 --- /dev/null +++ b/doc/user/repositories.sgml @@ -0,0 +1,32 @@ + + + + X + + + +
+ The &Repository; Method + + + + X + + + +
+ +
+ X + + + + X + + + +
diff --git a/doc/user/run.sgml b/doc/user/run.sgml new file mode 100644 index 0000000..3ba222f --- /dev/null +++ b/doc/user/run.sgml @@ -0,0 +1,65 @@ + + + + X + + + +
+ Command-line Target Aliases + + + + X + + + +
+ +
+ Selective Builds + + + + X + + + +
+ +
+ Build Pruning + + + + X + + + +
+ +
+ Overriding Construction Variables + + + + X + + + +
+ +
+ The &SCONSFLAGS; Environment Variable + + + + X + + + +
diff --git a/doc/user/scanners.sgml b/doc/user/scanners.sgml new file mode 100644 index 0000000..2514e74 --- /dev/null +++ b/doc/user/scanners.sgml @@ -0,0 +1,21 @@ + + + + X + + + +
+ X + + + + X + + + +
diff --git a/doc/user/simple.sgml b/doc/user/simple.sgml new file mode 100644 index 0000000..eef6b45 --- /dev/null +++ b/doc/user/simple.sgml @@ -0,0 +1,87 @@ + + + + X + + + +
+ The &SConstruct; File + + + + X + + + +
+ +
+ The &Program; Builder + + + + X + + + +
+ +
+ The &Library; Builder + + + + X + + + +
+ +
+ The &Install; Builder + + + + X + + + +
+ +
+ Running &SCons; + + + + X + + + +
+ +
+ The &Default; Method + + + + X + + + +
+ +
+ The &Help; Method + + + + X + + + +
diff --git a/doc/user/troubleshoot.sgml b/doc/user/troubleshoot.sgml new file mode 100644 index 0000000..2514e74 --- /dev/null +++ b/doc/user/troubleshoot.sgml @@ -0,0 +1,21 @@ + + + + X + + + +
+ X + + + + X + + + +
diff --git a/doc/user/variants.sgml b/doc/user/variants.sgml new file mode 100644 index 0000000..2514e74 --- /dev/null +++ b/doc/user/variants.sgml @@ -0,0 +1,21 @@ + + + + X + + + +
+ X + + + + X + + + +
-- cgit v0.12