trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From a..@apache.org
Subject [trafficserver] branch master updated: Doc: Repair various warnings, mostly from header_rewrite and ArgParser. Update the nitpick list.
Date Fri, 12 Oct 2018 23:04:19 GMT
This is an automated email from the ASF dual-hosted git repository.

amc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git


The following commit(s) were added to refs/heads/master by this push:
     new dd60b19  Doc: Repair various warnings, mostly from header_rewrite and ArgParser.
Update the nitpick list.
dd60b19 is described below

commit dd60b1913432548d947289274d206e48c3cc44c5
Author: Alan M. Carroll <amc@apache.org>
AuthorDate: Fri Oct 12 16:58:42 2018 -0500

    Doc: Repair various warnings, mostly from header_rewrite and ArgParser.
    Update the nitpick list.
---
 doc/admin-guide/plugins/header_rewrite.en.rst           | 11 +++++++----
 doc/conf.py                                             |  8 ++++----
 doc/developer-guide/internal-libraries/ArgParser.en.rst | 12 +++++++-----
 3 files changed, 18 insertions(+), 13 deletions(-)

diff --git a/doc/admin-guide/plugins/header_rewrite.en.rst b/doc/admin-guide/plugins/header_rewrite.en.rst
index e4796b0..28ca6c3 100644
--- a/doc/admin-guide/plugins/header_rewrite.en.rst
+++ b/doc/admin-guide/plugins/header_rewrite.en.rst
@@ -608,7 +608,7 @@ be specified multiple times, such as ``Set-Cookie``, but for headers which
may
 only be specified once you may prefer to use `set-header`_ instead.
 
 The header's ``<value>`` may be specified as a literal string, or it may take
-advantage of `Variable Expansion`_ to calculate a dynamic value for the header.
+advantage of :ref:`header-rewrite-expansion` to calculate a dynamic value for the header.
 
 counter
 ~~~~~~~
@@ -721,7 +721,7 @@ Replaces the value of header ``<name>`` with ``<value>``,
creating the header
 if necessary.
 
 The header's ``<value>`` may be specified according to `Header Values`_ or take
-advantage of `Variable Expansion`_ to calculate a dynamic value for the header.
+advantage of :ref:`header-rewrite-expansion` to calculate a dynamic value for the header.
 
 set-redirect
 ~~~~~~~~~~~~
@@ -732,7 +732,7 @@ set-redirect
 When invoked, sends a redirect response to the client, with HTTP status
 ``<code>``, and a new location of ``<destination>``. If the ``QSA`` flag is
 enabled, the original query string will be preserved and added to the new
-location automatically. This operator supports `Variable Expansion`_ for
+location automatically. This operator supports :ref:`header-rewrite-expansion` for
 ``<destination>``.
 
 set-status
@@ -804,6 +804,8 @@ L      Last rule, do not continue.
 QSA    Append the results of the rule to the query string.
 ====== ========================================================================
 
+.. _header-rewrite-expansion:
+
 Values and Variable Expansion
 -----------------------------
 
@@ -822,8 +824,9 @@ Variable                New condition variable to use
 %<cqhm>                 %{METHOD}
 %<cque>                 %[CLIENT-URL}
 %<cquup>                %{CLIENT-URL:PATH}
+======================= ==================================================================================
 
-Remember that the %<INBOUND:...> tags can now simply be replaced with the %{INBOUND:...}
equivalent.
+The %<INBOUND:...> tags can now be replaced with the %{INBOUND:...} equivalent.
 
 You can concatenate values using strings, condition values and variable expansions via the
``+`` operator.
 Variables (eg %<tag>) in the concatenation must be enclosed in double quotes ``"``::
diff --git a/doc/conf.py b/doc/conf.py
index a297303..11884b6 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -170,10 +170,10 @@ nitpicky = True
 nitpick_ignore = [ ('c:type', 'int64_t')
                  , ('c:type', 'bool')
                  , ('c:type', 'sockaddr')
-                 , ('cpp:typeOrConcept', 'T') # template arg
-                 , ('cpp:typeOrConcept', 'F') # template arg
-                 , ('cpp:typeOrConcept', 'Args') # variadic template arg
-                 , ('cpp:typeOrConcept', 'Rest') # variadic template arg
+                 , ('cpp:identifier', 'T') # template arg
+                 , ('cpp:identifier', 'F') # template arg
+                 , ('cpp:identifier', 'Args') # variadic template arg
+                 , ('cpp:identifier', 'Rest') # variadic template arg
                  ]
 
 # Autolink issue references.
diff --git a/doc/developer-guide/internal-libraries/ArgParser.en.rst b/doc/developer-guide/internal-libraries/ArgParser.en.rst
index 9594e7e..6e16197 100644
--- a/doc/developer-guide/internal-libraries/ArgParser.en.rst
+++ b/doc/developer-guide/internal-libraries/ArgParser.en.rst
@@ -44,10 +44,12 @@ All parsed arguments and function will be put in a key-value pairs structure
 Usage
 +++++
 
-The usage of the ArgParser is straightforward. The user is expected to create an
-ArgParser for the program. Commands and options can be added to the parser with details
-including ENV variable, arguments expected, etc. After a single method :code:`parse(argv)`
is called,
-An object containing all information and parsed arguments available to use will be returned.
+The usage of the ArgParser is straightforward. An :code:`ArgParser` instance is
+created. Commands and options are then added to this instance, along with
+details including ENV variable, arguments expected, etc. The method
+:code:`parse(argv)` is called, passing the :code:`argv` from the command line
+(:code:`main` function arguments). An object containing the parsed command line
+information will be returned.
 
 Create a parser
 ---------------
@@ -177,7 +179,7 @@ Classes
 
       Add a global_usage for :code:`help_message()`. Example: `traffic_blabla [--SWITCH [ARG]]`.
 
-   .. function:: void set_default_command(std::string const &cmd);
+   .. function:: void set_default_command(std::string const &cmd)
 
       Set a default command to the parser. This method should be called after the adding
of the commands.
 


Mime
View raw message