You are viewing a plain text version of this content. The canonical link for it is here.
Posted to rivet-dev@tcl.apache.org by mx...@apache.org on 2011/11/20 23:41:57 UTC
svn commit: r1204291 - in /tcl/rivet/branches/rivet-namespace: ChangeLog
configure.ac doc/rivet.xml doc/xml/commands.xml doc/xml/install.xml
Author: mxmanghi
Date: Sun Nov 20 22:41:56 2011
New Revision: 1204291
URL: http://svn.apache.org/viewvc?rev=1204291&view=rev
Log:
2011-11-20 Massimo Manghi <mx...@apache.org>
* doc/xml/commands.xml,doc/xml/install.xml: documentation for building Rivet updated.
* configure.ac: corrected help message for --disable-rivet-commands-export
Modified:
tcl/rivet/branches/rivet-namespace/ChangeLog
tcl/rivet/branches/rivet-namespace/configure.ac
tcl/rivet/branches/rivet-namespace/doc/rivet.xml
tcl/rivet/branches/rivet-namespace/doc/xml/commands.xml
tcl/rivet/branches/rivet-namespace/doc/xml/install.xml
Modified: tcl/rivet/branches/rivet-namespace/ChangeLog
URL: http://svn.apache.org/viewvc/tcl/rivet/branches/rivet-namespace/ChangeLog?rev=1204291&r1=1204290&r2=1204291&view=diff
==============================================================================
--- tcl/rivet/branches/rivet-namespace/ChangeLog (original)
+++ tcl/rivet/branches/rivet-namespace/ChangeLog Sun Nov 20 22:41:56 2011
@@ -1,4 +1,8 @@
2011-11-20 Massimo Manghi <mx...@apache.org>
+ * doc/xml/commands.xml,doc/xml/install.xml: documentation for building Rivet updated.
+ * configure.ac: corrected help message for --disable-rivet-commands-export
+
+2011-11-20 Massimo Manghi <mx...@apache.org>
* src/rivet.h: Macro definition for Rivet command objects has rolled back to
its previous form and doesn't call Tcl_Export anymore. In case commands are
exported by calling Tcl_Export in rivetCore.c and rivetPkgInit.c
Modified: tcl/rivet/branches/rivet-namespace/configure.ac
URL: http://svn.apache.org/viewvc/tcl/rivet/branches/rivet-namespace/configure.ac?rev=1204291&r1=1204290&r2=1204291&view=diff
==============================================================================
--- tcl/rivet/branches/rivet-namespace/configure.ac (original)
+++ tcl/rivet/branches/rivet-namespace/configure.ac Sun Nov 20 22:41:56 2011
@@ -509,7 +509,7 @@ AC_DEFUN([HONOR_HEAD_REQUESTS],[
AC_DEFUN([RIVET_COMMANDS_EXPORT],[
AC_ARG_ENABLE(
rivet-commands-export,
- [ --enable-rivet-commands-export to export commands from ::rivet namespace],
+ [ --disable-rivet-commands-export to prevent export from ::rivet namespace],
[ rivet_commands_export=$enable_rivet_commands_export ],
[ rivet_commands_export="yes"]
)
Modified: tcl/rivet/branches/rivet-namespace/doc/rivet.xml
URL: http://svn.apache.org/viewvc/tcl/rivet/branches/rivet-namespace/doc/rivet.xml?rev=1204291&r1=1204290&r2=1204291&view=diff
==============================================================================
--- tcl/rivet/branches/rivet-namespace/doc/rivet.xml (original)
+++ tcl/rivet/branches/rivet-namespace/doc/rivet.xml Sun Nov 20 22:41:56 2011
@@ -95,7 +95,7 @@
&directives.xml;
<!-- Commands -->
- &commands.xml;
+ &commands.xml;
<!-- examples-sgml -->
&examples.xml;
Modified: tcl/rivet/branches/rivet-namespace/doc/xml/commands.xml
URL: http://svn.apache.org/viewvc/tcl/rivet/branches/rivet-namespace/doc/xml/commands.xml?rev=1204291&r1=1204290&r2=1204291&view=diff
==============================================================================
--- tcl/rivet/branches/rivet-namespace/doc/xml/commands.xml (original)
+++ tcl/rivet/branches/rivet-namespace/doc/xml/commands.xml Sun Nov 20 22:41:56 2011
@@ -6,13 +6,24 @@
<command>::rivet</command> namespace.
</para>
<para>
- In order to preserve out of the box compatibility with existing scripts
- the whole set of commands is now implicitly imported into the global
- namespace, but this is not guaranteed to work forever and in future
- releases of Rivet it will be removed. Importing the commands into the global
- namespace with <command>namespace import ::rivet::*</command> will be possible
- but deprecated and instead it is recommended commands to be fully specified
- throught the namespace prefix.
+ In order to preserve out of the box compatibility with existing scripts,
+ Rivet exports commands by default and makes them available for import
+ into any namespace (global namespace included).
+ Rivet's build system can be told not to export the command set by
+ passing the switch <command>--disable-rivet-commands-export</command>
+ to 'configure'. In the future we may change this option's default.
+ </para>
+ <para>
+ Commands must be imported into another namespace with the
+ command:
+ </para>
+ <para>
+ <command>namespace import -force ::rivet::*</command>
+ </para>
+ <para>
+ Whenever a new application is being developed and compatibility
+ issues can be confined within specific files, it is recommended
+ that commands be specified with their fully qualified names.
</para>
</section>
<refentry id="abort_code">
@@ -1006,23 +1017,16 @@ bxxb ccxxxxcc</programlisting>
<command>::rivet::no_body</command>
</cmdsynopsis>
</refsynopsisdiv>
-
- <refsect1>
+ <refsect1>
<title>Description</title>
<para>
- Create a self referencing URL from a filename. <command>makeurl</command>
- can be used in three ways
- <itemizedlist>
- <listitem> No argument is passed to the command (returns the current script URL)</listitem>
- <listitem>
- A relative style path is passed (returns the argument prepended with the
- current script's URL)
- </listitem>
- <listitem>
- An absolute path is passed to the command: (returns the full URL to the
- resource)
- </listitem>
+ This command is useful for situations where it is necessary
+ to only return HTTP headers and no actual content. For
+ instance, when returning a 304 redirect.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="parray">
<refnamediv>
<refname>parray</refname>
Modified: tcl/rivet/branches/rivet-namespace/doc/xml/install.xml
URL: http://svn.apache.org/viewvc/tcl/rivet/branches/rivet-namespace/doc/xml/install.xml?rev=1204291&r1=1204290&r2=1204291&view=diff
==============================================================================
--- tcl/rivet/branches/rivet-namespace/doc/xml/install.xml (original)
+++ tcl/rivet/branches/rivet-namespace/doc/xml/install.xml Sun Nov 20 22:41:56 2011
@@ -188,10 +188,26 @@ tar -xvf rivet-X.X.X.tar.gz</programlist
<varlistentry>
<term>--disable-upload-var</term>
<listitem>
- By default uploads are stored in Tcl variables. This switch sets the default for the configuration
- parameter 'UploadFilesToVar' to 0. (Can be changed in the configuration)
+ By default uploads are stored in Tcl variables.
+ This switch sets the default for the configuration
+ parameter 'UploadFilesToVar' to 0.
+ (Can be changed in the configuration)
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>--disable-rivet-commands-export</term>
+ <listitem>
+ Rivet commands are created in the ::rivet namespace. To improve code readability
+ it is recommended you write your scripts using the fully qualified name
+ definitions. For compatibility with existing code, commands are exported from
+ ::rivet and can be thus imported into any namespace (global namespace included)
+ with the command
+ <programlisting>
+ namespace import -force ::rivet::*
+ </programlisting>
+ The default value for this option may change in the future.
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
<para>
---------------------------------------------------------------------
To unsubscribe, e-mail: rivet-cvs-unsubscribe@tcl.apache.org
For additional commands, e-mail: rivet-cvs-help@tcl.apache.org