AMBuild Tutorial - Revision history

BAILOPAN: /* Multiple Scripts */

2020-08-25T04:00:27Z

‎Multiple Scripts

BAILOPAN: /* Multiple Scripts */

2020-08-25T03:58:12Z

‎Multiple Scripts

BAILOPAN: /* Multiple Scripts */

2020-08-25T03:56:31Z

‎Multiple Scripts

BAILOPAN at 03:55, 25 August 2020

2020-08-25T03:55:03Z

BAILOPAN at 07:56, 23 November 2015

2015-11-23T07:56:35Z

BAILOPAN at 07:52, 23 November 2015

2015-11-23T07:52:59Z

BAILOPAN at 21:49, 2 December 2013

2013-12-02T21:49:57Z

BAILOPAN at 16:54, 15 November 2013

2013-11-15T16:54:28Z

BAILOPAN at 10:49, 11 November 2013

2013-11-11T10:49:25Z

BAILOPAN at 10:37, 11 November 2013

2013-11-11T10:37:52Z

@@ Line 175: / Line 175: @@
 <Python>
 # AMBuildScript
-builder.DetectCxx()
+cxx = builder.DetectCxx()
 program = cxx.Program("hello")
@@ Line 214: / Line 214: @@
 It is possible to pass variables to other scripts (they appear as global variables), or they can be attached to the <tt>builder</tt> object and they will automatically be propagated down. It's useful to propagate compiler objects this way, so they don't have to be re-detected and reconfigured in every subsequent script. For more information, see [[AMBuild API]].
 ==Custom Options==

@@ Line 213: / Line 213: @@
 </Python>
-It is possible to pass variables to other scripts (they appear as global variables), or they can be attached to the <tt>builder</tt> object and they will automatically be propagated down. It's useful to propagate compiler objects this way, so they don't have to be re-detected and reconfigured in every subsequent script.
+It is possible to pass variables to other scripts (they appear as global variables), or they can be attached to the <tt>builder</tt> object and they will automatically be propagated down. It's useful to propagate compiler objects this way, so they don't have to be re-detected and reconfigured in every subsequent script. For more information, see [[AMBuild API]].
 ==Custom Options==

@@ Line 212: / Line 212: @@
 rvalue = folders
 </Python>
 ==Custom Options==

@@ Line 26: / Line 26: @@
 from ambuild2 import run
-prep = run.BuildParser(sys.path[0], api='2.1')
+prep = run.BuildParser(sys.path[0], api='2.2')
 prep.Configure()
 </pre>
@@ Line 34: / Line 34: @@
 The first step is to tell AMBuild to detect the first available C or C++ compiler. This is done with the following line:
 <Python>
-builder.DetectCompilers()
+cxx = builder.DetectCxx()
 </Python>
@@ Line 44: / Line 44: @@
 Checking CC compiler (vendor test gcc)... ['cc', 'test.c', '-o', 'test']
 found gcc version 4.7
-Checking CXX compiler (vendor test gcc)... ['c++', '-fno-exceptions', '-fno-rtti', 'test.cpp', '-o', 'testp']
+Checking CXX compiler (vendor test gcc)... ['c++', 'test.cpp', '-o', 'testp']
 found gcc version 4.7
+$
 </pre>
-If you get an error - either you don't have a compatible C or C++ compiler installed, or AMBuild has a bug (please [https://bugs.alliedmods.net/ report it!]).
+If you get an error - it's likely you don't have a compiler installed. Make sure gcc, clang, or Microsoft Visual Studio is available where appropriate.
 Now, we're ready to complete our AMBuildScript:
 <Python>
-program = builder.cxx.Program("hello")
+program = cxx.Program("hello")
 program.sources = [
    'main.cpp',
@@ Line 177: / Line 177: @@
 builder.DetectCxx()
-program = builder.cxx.Program("hello")
+program = cxx.Program("hello")
 program.sources = [
    'main.cpp',
@@ Line 221: / Line 221: @@
 import sys, ambuild2.run
-parser = run.BuildParser(sys.path[0], api='2.1')
+parser = run.BuildParser(sys.path[0], api='2.2')
 parser.Configure()
 </Python>
-The <tt>parser</tt> object has an <tt>options</tt> attribute, which is an instance of <tt>optparse.OptionParser</tt>. You can add to it, for example,
+The <tt>parser</tt> object has an <tt>options</tt> attribute, which is an instance of <tt>argparse.ArgumentParser</tt>. You can add to it, for example,
 <Python>
@@ Line 231: / Line 231: @@
 import sys, ambuild2.run
-parser = run.BuildParser(sys.path[0], api='2.1')
+parser = run.BuildParser(sys.path[0], api='2.2')
-parser.options.add_option('--enable-debug', action='store_true', dest='debug', default=False,
+parser.options.add_argument('--enable-debug', action='store_true', dest='debug', default=False,
-                        help='Enable debugging symbols')
+                            help='Enable debugging symbols')
-parser.options.add_option('--enable-optimize', action='store_true', dest='opt', default=False,
+parser.options.add_argument('--enable-optimize', action='store_true', dest='opt', default=False,
-                        help='Enable optimization')
+                            help='Enable optimization')
 parser.Configure()
 </Python>
@@ Line 243: / Line 243: @@
 <Python>
 if builder.options.debug:
-   builder.cxx.cflags += ['-O0', '-ggdb3']
+   cxx.cflags += ['-O0', '-ggdb3']
-   builder.cxx.cdefines += ['DEBUG']
+   cxx.cdefines += ['DEBUG']
 if builder.options.opt:
-   builder.cxx.cflags += ['-O3']
+   cxx.cflags += ['-O3']
-   builder.cxx.cdefines += ['NDEBUG']
+   cxx.cdefines += ['NDEBUG']
 </Python>
@@ Line 261: / Line 261: @@
 <Python>
-cmd, generated_headers = builder.AddCommand(
+generated_headers = builder.AddCommand(
    argv = ['python', os.path.join(builder.buildPath, 'tools', 'buildbot', 'generate_headers.py')],
    inputs = [os.path.join(builder.sourcePath, '.hg', 'dirstate')],
@@ Line 271: / Line 271: @@
 <Python>
-library = builder.cxx.Library('cstrike')
+library = cxx.Library('cstrike')
 library.sources = ['cstrike.cpp', 'smsdk_ext.cpp']
-library.weak_deps += generated_headers
+library.sourcedeps += generated_headers
 builder.Add(library)
 </Python>
@@ Line 284: / Line 284: @@
 <Python>
-program = builder.cxx.Program('sample')
+program = cxx.Program('sample')
 builder.Build(['cairo/AMBuild', 'gtk/AMBuild'], {

@@ Line 26: / Line 26: @@
 from ambuild2 import run
-prep = run.BuildParser(sys.path[0])
+prep = run.BuildParser(sys.path[0], api='2.1')
 prep.Configure()
 </pre>
@@ Line 221: / Line 221: @@
 import sys, ambuild2.run
-parser = run.BuildParser(sys.path[0])
+parser = run.BuildParser(sys.path[0], api='2.1')
 parser.Configure()
 </Python>
-The <tt>prep</tt> object has an <tt>options</tt> attribute, which is an instance of <tt>optparse.OptionParser</tt>. You can add to it, for example,
+The <tt>parser</tt> object has an <tt>options</tt> attribute, which is an instance of <tt>optparse.OptionParser</tt>. You can add to it, for example,
 <Python>
@@ Line 231: / Line 231: @@
 import sys, ambuild2.run
-prep = run.PrepareBuild(sys.path[0])
+parser = run.BuildParser(sys.path[0], api='2.1')
-prep.options.add_option('--enable-debug', action='store_true', dest='debug', default=False,
+parser.options.add_option('--enable-debug', action='store_true', dest='debug', default=False,
                          help='Enable debugging symbols')
-prep.options.add_option('--enable-optimize', action='store_true', dest='opt', default=False,
+parser.options.add_option('--enable-optimize', action='store_true', dest='opt', default=False,
                          help='Enable optimization')
-prep.Configure()
+parser.Configure()
 </Python>

← Older revision		Revision as of 10:49, 11 November 2013
Line 192:		Line 192:

	When <tt>PackageScript</tt> is parsed during the configure step, all of its jobs will automatically be configured to occur inside a <tt>dist</tt> folder within the build folder, so <tt>'.'</tt> actually refers to <tt>./dist/</tt>.		When <tt>PackageScript</tt> is parsed during the configure step, all of its jobs will automatically be configured to occur inside a <tt>dist</tt> folder within the build folder, so <tt>'.'</tt> actually refers to <tt>./dist/</tt>.
		+
		+	If you have only one script, you can use <tt>RunScript</tt> instead. This also lets scripts return a value. For example:
		+	<Python>
		+	# AMBuildScript
		+	folders = builder.RunScript('MakeFolders')
		+	</Python>
		+
		+	<Python>
		+	# MakeFolders
		+	folders = [
		+	builder.AddFolder('egg'),
		+	builder.AddFolder('yam'),
		+	builder.AddFolder('plant'),
		+	]
		+
		+	# Magic variable; assigning to "rvalue" will propagate the value
		+	# back up to RunScript().
		+	rvalue = folders
		+	</Python>

	==Custom Options==		==Custom Options==

@@ Line 263: / Line 263: @@
 Reconfiguring can happen for two reasons. One is if you change some properties of the build, for example, configuring a debug build over an existing optimized build. Another is if a build script changes, AMBuild will automatically reconfigure the build using the previous configure options.
-===Output Cleaning=
+===Output Cleaning===
 When a reconfigure occurs, AMBuild will produce a new dependency graph alongside the old dependency graph, and these graphs are then merged. Any generated files in the old graph that are not present in the new graph are removed from the file system. This is necessary to ensure that builds do not become inconsistent or corrupt: every incremental build should be identical to a clean build.