From d5fdcf669727f610bd741c6940260524d2e84f92 Mon Sep 17 00:00:00 2001 From: Hartmut Kaiser Date: Wed, 10 Jan 2007 01:49:22 +0000 Subject: [PATCH] Fixed documentation. [SVN r36680] --- doc/supported_pragmas.html | 16 ++++++++-------- doc/wave_driver.html | 9 +++++---- 2 files changed, 13 insertions(+), 12 deletions(-) diff --git a/doc/supported_pragmas.html b/doc/supported_pragmas.html index 9c6475f..93fad2b 100644 --- a/doc/supported_pragmas.html +++ b/doc/supported_pragmas.html @@ -57,13 +57,13 @@

description

-

trace

-

enable/on/1
- disable/off/0

-

Enable or disable the tracing of the +

trace

+

enable/on/1
+ disable/off/0

+

Enable or disable the tracing of the macro expansion process. This is needed, even if there is given the --trace command line option, because the trace output is generated only, if there - is at least one trace(enable) pragma found.

+ is at least one trace(enable) pragma found.

stop

@@ -101,12 +101,12 @@

option

line: [0|1]
preserve: [0|1|2]
- output: ["filename" | null] + output: ["filename" | null | default]

The option(line: ...) directive allows to control, whether #line directives will be generated in the output stream. Specify either '0' or '1' as the option parameter. All other values will be flaged as illegal.

The option(preserve: ...) directive allows to control the amount of whitespace generated in the output stream. The value '0' removes any not needed whitespace, the value '1' keeps comments only and the value '2' does not remove any whitespace.

-

The option(output: ...) directive allows to specify the name of the file, where the output is generated to. Specify either a valid filename (which will be interpreted relative to directory of the processed file) or the value null (without quotes) to disable the output at all.

+

The option(output: ...) directive allows to specify the name of the file, where the output is generated to. Specify either a valid filename (which will be interpreted relative to directory of the processed file), the value null to disable the output at all, or the value default to use the output as specified on the command line using the --output/-o option.

All pragma's not listed here but flagged as 'wave' are currently reported as @@ -133,7 +133,7 @@ Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

Last updated: - Tuesday, May 2, 2006 17:28 + Tuesday, January 9, 2007 19:46

 

diff --git a/doc/wave_driver.html b/doc/wave_driver.html index bd185c4..0a17ae9 100644 --- a/doc/wave_driver.html +++ b/doc/wave_driver.html @@ -78,7 +78,7 @@

-o [--output] path

Specify a filename to be used for the generated preprocessed output - stream. If this option is not given, then the standard output is used (stdout). If the filename given equals to '-' (without the quotes), no output is generated initially. This is especially useful for syntax checks only or in conjunction with the #pragma wave option(output: ...) directive restricting the generated out to specific parts only.

+ stream. If this option is not given, then the standard output is used (stdout). If the filename given equals to '-' (without the quotes), no output is generated initially. This is especially useful for syntax checks only or in conjunction with the #pragma wave option(output: ...) directive restricting the generated out to specific parts only (for a description see the section Supported Pragma Directives).

-E [--autooutput]

@@ -247,8 +247,9 @@ is now disabled by default because it may cause a potential security threat. The line.

The Wave driver program at startup looks for a configuration - file named 'wave.cfg' in the same directory where it was started from (where the driver executable - is located). If this file exists, it is treated as a normal + file named 'wave.cfg' in every directory up the file system hierarchy starting + from the directory where the input file is located. The first file found stops + the search. If a file exists, it is treated as a normal configuration file and the specified herein options are interpreted as if they were given as the first options on the command line. This feature is very useful for defining a global environment for the Wave preprocessor driver.

@@ -266,7 +267,7 @@ is now disabled by default because it may cause a potential security threat. The Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

Last updated: - Monday, March 13, 2006 19:18 + Tuesday, January 9, 2007 19:42