summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/yacc.xml
diff options
context:
space:
mode:
authorLuca Falavigna <dktrkranz@debian.org>2014-04-26 15:11:58 +0200
committerLuca Falavigna <dktrkranz@debian.org>2014-04-26 15:11:58 +0200
commita3a0ab66f0da855e75e3a0e2acfb8aa106b46510 (patch)
tree5352edff1387c3d7e5a8b49ec56524f085c22782 /src/engine/SCons/Tool/yacc.xml
parent51fa4e4acb6fc8fc7a2af0fbdc21fd1e8feddb3a (diff)
parent140d836e9cd54fb67b969fd82ef7ed19ba574d40 (diff)
Merge tag 'upstream/2.3.1'
Upstream version 2.3.1
Diffstat (limited to 'src/engine/SCons/Tool/yacc.xml')
-rw-r--r--src/engine/SCons/Tool/yacc.xml57
1 files changed, 47 insertions, 10 deletions
diff --git a/src/engine/SCons/Tool/yacc.xml b/src/engine/SCons/Tool/yacc.xml
index 7ad1387..2b4e964 100644
--- a/src/engine/SCons/Tool/yacc.xml
+++ b/src/engine/SCons/Tool/yacc.xml
@@ -1,64 +1,94 @@
+<?xml version="1.0" encoding="UTF-8"?>
<!--
-Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation
+Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 The SCons Foundation
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/scons.xsd scons.xsd">
+
<tool name="yacc">
<summary>
+<para>
Sets construction variables for the &yacc; parse generator.
+</para>
</summary>
<sets>
-YACC
-YACCFLAGS
-YACCCOM
-YACCHFILESUFFIX
-YACCHXXFILESUFFIX
-YACCVCGFILESUFFIX
+<item>YACC</item>
+<item>YACCFLAGS</item>
+<item>YACCCOM</item>
+<item>YACCHFILESUFFIX</item>
+<item>YACCHXXFILESUFFIX</item>
+<item>YACCVCGFILESUFFIX</item>
</sets>
<uses>
-YACCCOMSTR
+<item>YACCCOMSTR</item>
</uses>
</tool>
<cvar name="YACC">
<summary>
+<para>
The parser generator.
+</para>
</summary>
</cvar>
<cvar name="YACCCOM">
<summary>
+<para>
The command line used to call the parser generator
to generate a source file.
+</para>
</summary>
</cvar>
<cvar name="YACCCOMSTR">
<summary>
+<para>
The string displayed when generating a source file
using the parser generator.
If this is not set, then &cv-link-YACCCOM; (the command line) is displayed.
+</para>
-<example>
+<example_commands>
env = Environment(YACCCOMSTR = "Yacc'ing $TARGET from $SOURCES")
-</example>
+</example_commands>
</summary>
</cvar>
<cvar name="YACCFLAGS">
<summary>
+<para>
General options passed to the parser generator.
If &cv-link-YACCFLAGS; contains a <option>-d</option> option,
SCons assumes that the call will also create a .h file
(if the yacc source file ends in a .y suffix)
or a .hpp file
(if the yacc source file ends in a .yy suffix)
+</para>
</summary>
</cvar>
<cvar name="YACCHFILESUFFIX">
<summary>
+<para>
The suffix of the C
header file generated by the parser generator
when the
@@ -71,11 +101,13 @@ it exists to allow you to specify
what suffix the parser generator will use of its own accord.
The default value is
<filename>.h</filename>.
+</para>
</summary>
</cvar>
<cvar name="YACCHXXFILESUFFIX">
<summary>
+<para>
The suffix of the C++
header file generated by the parser generator
when the
@@ -94,11 +126,13 @@ where the default is
because the default &bison; parser generator just
appends <filename>.h</filename>
to the name of the generated C++ file.
+</para>
</summary>
</cvar>
<cvar name="YACCVCGFILESUFFIX">
<summary>
+<para>
The suffix of the file
containing the VCG grammar automaton definition
when the
@@ -111,5 +145,8 @@ it exists to allow you to specify
what suffix the parser generator will use of its own accord.
The default value is
<filename>.vcg</filename>.
+</para>
</summary>
</cvar>
+
+</sconsdoc> \ No newline at end of file