This is an automated email from the ASF dual-hosted git repository.
mxmanghi pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tcl-rivet.git
The following commit(s) were added to refs/heads/master by this push:
new a5e2d75 clarified and extended ::rivet::env manual page
a5e2d75 is described below
commit a5e2d750f85f6cfbd9943abdf56ccb7f99fdcc8e
Author: Massimo Manghi <massimo.man...@gmail.com>
AuthorDate: Wed Oct 13 10:47:02 2021 +0200
clarified and extended ::rivet::env manual page
---
doc/xml/commands.xml | 123 +++++++++++++++++++++++++--------------------------
1 file changed, 61 insertions(+), 62 deletions(-)
diff --git a/doc/xml/commands.xml b/doc/xml/commands.xml
index 9d4386a..38ee5ab 100644
--- a/doc/xml/commands.xml
+++ b/doc/xml/commands.xml
@@ -460,61 +460,63 @@
</refentry>
<refentry id="debug">
- <refnamediv>
- <refname>debug</refname>
- <refpurpose>
- A command to print strings, arrays
- and the values of variables as specified by the arguments.
- </refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>::rivet::debug</command>
- <arg choice="plain">-subst</arg><arg><on|off></arg>
- <arg
choice="plain">-separator</arg><arg><string></arg>
- <arg
choice="plain">-option</arg><arg><replaceable><value></replaceable></arg>
- <arg
choice="plain">-option</arg><arg><replaceable><value></replaceable></arg>
- <arg choice="plain">...</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <refnamediv>
+ <refname>debug</refname>
+ <refpurpose>
+ A command to print strings, arrays
+ and the values of variables as specified by the
arguments.
+ </refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>::rivet::debug</command>
+ <arg
choice="plain">-subst</arg><arg><on|off></arg>
+ <arg
choice="plain">-separator</arg><arg><string></arg>
+ <arg
choice="plain">-option</arg><arg><replaceable><value></replaceable></arg>
+ <arg
choice="plain">-option</arg><arg><replaceable><value></replaceable></arg>
+ <arg choice="plain">...</arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>
- A command to make debugging more convenient print strings,
arrays
- and the values of variables as specified by the arguments.
- </para>
- <para>
- Also allows the setting of an array called debug which will
pick up
- options for all debug commands.
- </para>
- </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>
+ A command to make debugging more convenient print
strings, arrays
+ and the values of variables as specified by the
arguments.
+ </para>
+ <para>
+ Also allows the setting of an array called debug
which will pick up
+ options for all debug commands.
+ </para>
+ </refsect1>
</refentry>
-
<refentry id="env">
- <refnamediv>
- <refname>env</refname>
- <refpurpose>
- Loads a single "environmental variable" into a Tcl variable.
- </refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>env</refname>
+ <refpurpose>
+ Returns the value a single "environmental variable".
+ </refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>::rivet::env</command>
- <arg><replaceable>varName</replaceable></arg>
- </cmdsynopsis>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>::rivet::env</command>
+
<arg><replaceable>environment_variable_name</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>
- If it is only necessary to load one environmental variable,
- this command may be used to avoid the overhead of loading
- and storing the entire array.
- </para>
- </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>
+ If just one environmental variable is needed
<command>::rivet::env</command>
+ returns the variable value or an empty string if
the environment
+ variable name in the argument is not defined.
+ This command has some performance advantages with
respect to
+ <command>::rivet::load_env</command> since it
avoids the
+ loading of the whole set of environment and header
variables.
+ </para>
+ </refsect1>
</refentry>
<refentry id="escape_sgml_chars">
@@ -530,19 +532,16 @@
</cmdsynopsis>
</refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>
- Scans through each character in the specified string looking
- for any special (with respect to SGML, and hence HTML)
characters
- from the specified string, and returns the result.
- For example, the right angle bracket is escaped to the
corrected
- ampersand gt symbol.
- </para>
- <!--note>
- You must require the <command>rivetlib</command> package in
order to gain access to this command
- </note -->
- </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>
+ Scans through each character in the specified
string looking
+ for any special (with respect to SGML, and hence
HTML) characters
+ from the specified string, and returns the result.
+ For example, the right angle bracket is escaped to
the corrected
+ ampersand gt symbol.
+ </para>
+ </refsect1>
</refentry>
<refentry id="escape_shell_command">
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@tcl.apache.org
For additional commands, e-mail: commits-h...@tcl.apache.org
