diff options
Diffstat (limited to 'src/engine/SCons/Tool/Subversion.xml')
-rw-r--r-- | src/engine/SCons/Tool/Subversion.xml | 135 |
1 files changed, 135 insertions, 0 deletions
diff --git a/src/engine/SCons/Tool/Subversion.xml b/src/engine/SCons/Tool/Subversion.xml new file mode 100644 index 000000000..7c851b5ff --- /dev/null +++ b/src/engine/SCons/Tool/Subversion.xml @@ -0,0 +1,135 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +__COPYRIGHT__ + +This file is processed by the bin/SConsDoc.py module. +See its __doc__ string for a discussion of the format. +--> + +<!DOCTYPE sconsdoc [ +<!ENTITY % scons SYSTEM '../../../../doc/scons.mod'> +%scons; +<!ENTITY % builders-mod SYSTEM '../../../../doc/generated/builders.mod'> +%builders-mod; +<!ENTITY % functions-mod SYSTEM '../../../../doc/generated/functions.mod'> +%functions-mod; +<!ENTITY % tools-mod SYSTEM '../../../../doc/generated/tools.mod'> +%tools-mod; +<!ENTITY % variables-mod SYSTEM '../../../../doc/generated/variables.mod'> +%variables-mod; +]> + +<sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> + +<!-- +<tool name="Subversion"> +<summary> +<para> +Sets construction variables for interacting with Subversion. +</para> +</summary> +<sets> +<item>SVN</item> +<item>SVNFLAGS</item> +<item>SVNCOM</item> +</sets> +<uses> +<item>SVNCOMSTR</item> +</uses> +</tool> +--> + +<!-- +<cvar name="SVN"> +<summary> +<para> +The Subversion executable (usually named +<command>svn</command>). +</para> +</summary> +</cvar> +--> + +<!-- +<cvar name="SVNCOM"> +<summary> +<para> +The command line used to +fetch source files from a Subversion repository. +</para> +</summary> +</cvar> +--> + +<!-- +<cvar name="SVNFLAGS"> +<summary> +<para> +General options that are passed to Subversion. +</para> +</summary> +</cvar> +--> + +<!-- +<scons_function name="Subversion"> +<arguments signature="global"> +(repository, module) +</arguments> +<summary> +<para> +A factory function that +returns a Builder object +to be used to fetch source files +from the specified Subversion +<varname>repository</varname>. +The returned Builder +is intended to be passed to the +&f-link-SourceCode; +function. +</para> + +<para> +The optional specified +<varname>module</varname> +will be added to the beginning +of all repository path names; +this can be used, in essence, +to strip initial directory names +from the repository path names, +so that you only have to +replicate part of the repository +directory hierarchy in your +local build directory. +</para> + +<para> +This function is deprecated, see the entry for the +&f-SourceCode; +function. +</para> + +<para> +Example: +</para> + +<example_commands> +# Will fetch foo/bar/src.c +# from /usr/local/Subversion/foo/bar/src.c. +env.SourceCode('.', env.Subversion('file:///usr/local/Subversion')) + +# Will fetch bar/src.c +# from /usr/local/Subversion/foo/bar/src.c. +env.SourceCode('.', env.Subversion('file:///usr/local/Subversion', 'foo')) + +# Will fetch src.c +# from /usr/local/Subversion/foo/bar/src.c. +env.SourceCode('.', env.Subversion('file:///usr/local/Subversion', 'foo/bar')) +</example_commands> +</summary> +</scons_function> +--> + +</sconsdoc> |