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 f9badea Doc: Minor fixes - some MimeHdr functions, traffic_layout, event loop metrics. f9badea is described below commit f9badea6417f3c2e9d7a6de4684971ef75237d4b Author: Alan M. Carroll <a...@apache.org> AuthorDate: Wed Nov 1 08:13:01 2017 -0500 Doc: Minor fixes - some MimeHdr functions, traffic_layout, event loop metrics. --- .../monitoring/statistics/core/misc.en.rst | 25 ++++----- doc/appendices/command-line/traffic_layout.en.rst | 64 +++++++++++++--------- .../functions/TSMimeHdrFieldValueStringSet.en.rst | 16 ++++++ .../api/functions/TSMimeHdrFieldValuesCount.en.rst | 2 + 4 files changed, 66 insertions(+), 41 deletions(-) diff --git a/doc/admin-guide/monitoring/statistics/core/misc.en.rst b/doc/admin-guide/monitoring/statistics/core/misc.en.rst index ba03882..e54e967 100644 --- a/doc/admin-guide/monitoring/statistics/core/misc.en.rst +++ b/doc/admin-guide/monitoring/statistics/core/misc.en.rst @@ -25,37 +25,32 @@ Miscellaneous .. ts:stat:: global proxy.process.http.misc_count_stat integer .. ts:stat:: global proxy.process.http.misc_user_agent_bytes_stat integer -.. ts:stat:: global proxy.process.eventloop count integer - :unit: nanoseconds +.. ts:stat:: global proxy.process.eventloop.count integer Number of event loops executed. -.. ts:stat:: global proxy.process.eventloop events integer - :unit: nanoseconds +.. ts:stat:: global proxy.process.eventloop.events integer - Number of events executed. + Number of events dispatched. -.. ts:stat:: global proxy.process.eventloop events.min integer - :unit: nanoseconds +.. ts:stat:: global proxy.process.eventloop.events.min integer Minimum number of events dispatched in a loop. -.. ts:stat:: global proxy.process.eventloop events.max integer - :unit: nanoseconds +.. ts:stat:: global proxy.process.eventloop.events.max integer Maximum number of events dispatched in a loop. -.. ts:stat:: global proxy.process.eventloop wait integer - :unit: nanoseconds +.. ts:stat:: global proxy.process.eventloop.wait integer Number of loops that did a conditional wait. -.. ts:stat:: global proxy.process.eventloop time.min integer +.. ts:stat:: global proxy.process.eventloop.time.min integer :unit: nanoseconds - Shortest time spent in loop. + Shortest time spent in a loop. -.. ts:stat:: global proxy.process.eventloop time.max integer +.. ts:stat:: global proxy.process.eventloop.time.max integer :unit: nanoseconds - Longest time spent in loop. + Longest time spent in a loop. diff --git a/doc/appendices/command-line/traffic_layout.en.rst b/doc/appendices/command-line/traffic_layout.en.rst index bd790f1..d013498 100644 --- a/doc/appendices/command-line/traffic_layout.en.rst +++ b/doc/appendices/command-line/traffic_layout.en.rst @@ -17,57 +17,69 @@ .. include:: ../../common.defs -.. _traffic_cop: - traffic_layout ***************** +.. program:: traffic_layout + +.. option:: --run-root [<path>] + + Use the run root file at :arg:`path`. + Description ============= -Document for the special functionality of ``runroot`` inside ``traffic_layout`` program -This feature is for the setup of traffic server runroot. -It will create a runtime sandbox for any program of traffic server to run under. +Document for the special functionality of ``runroot`` inside :program:`traffic_layout` This feature +is for the setup of traffic server runroot. It will create a runtime sandbox for any program of +traffic server to run under. -1. Use program traffic_layout to create sandbox. -2. Run any program use the sandbox with ``--run-root=/path`` or ``--run-root`` +#. Use :program:`traffic_layout` to create sandbox. +#. Run any program use the sandbox with ``--run-root=/path/to/file`` or ``--run-root``. How it works: -------------- -1. Create a sandbox directory for programs to run under -2. Copy and symlink build time directories and files to sandbox, allowing users to modify freely. -3. Emit a yaml file that defines layout structure for other programs to use. +#. Create a sandbox directory for programs to run under +#. Copy and symlink build time directories and files to sandbox, allowing users to modify freely. +#. Emit a yaml file that defines layout structure for other programs to use. Options: ============= -1. Initialize the runroot: :: - traffic_layout --init /path/to/sandbox/ +#. Initialize the runroot: :: + + traffic_layout --init /path/to/sandbox/ - If no path is found, it will find the ENV variable $TS_RUNROOT + If no path is found, it will find :envvar:`TS_RUNROOT`. -2. Remove the runroot: :: +#. Remove the runroot: :: - traffic_layout --remove /path/to/sandbox/ + traffic_layout --remove /path/to/sandbox/ - Remove the sandbox we created(check yaml file). - If no path provided, it will find the ENV variable $TS_RUNROOT. - If $TS_RUNROOT not found, it will find bin executing path & current working directory. + Remove the sandbox we created(check yaml file). + If no path provided, it will find :envvar:`TS_RUNROOT`. + If :envvar:`TS_RUNROOT` not found, it will find bin executing path & current working directory. -3. Force flag for creating: :: +#. Force flag for creating: :: - traffic_runroot --force --init /path/to/sandbox + traffic_runroot --force --init /path/to/sandbox - Force create sandbox and overwrite existing directory + Force create sandbox and overwrite existing directory Usage for other programs: ============================================== -Use pass in path or use Environment variable $TS_RUNROOT. -If both not found, program will try to find bin path & current woring directory. :: - trafficserver --run-root=/path/to/runroot - trafficserver --run-root + +Use pass in path or use :envvar:`TS_RUNROOT`. +If both not found, program will try to find bin path & current working directory. :: + + trafficserver --run-root=/path/to/runroot + trafficserver --run-root + +.. envvar:: TS_RUNROOT + + Path to run root file. Notes ========== -Path to sandbox must be an absolute path. + +.. note:: Path to sandbox must be an absolute path. diff --git a/doc/developer-guide/api/functions/TSMimeHdrFieldValueStringSet.en.rst b/doc/developer-guide/api/functions/TSMimeHdrFieldValueStringSet.en.rst index bfcd5bd..a53a7d5 100644 --- a/doc/developer-guide/api/functions/TSMimeHdrFieldValueStringSet.en.rst +++ b/doc/developer-guide/api/functions/TSMimeHdrFieldValueStringSet.en.rst @@ -30,3 +30,19 @@ Synopsis Description =========== + +:func:`TSMimeHdrFieldValueStringSet` sets the value of a MIME field. The field is identified by the +combination of :arg:`bufp`, :arg:`hdr`, and :arg:`field` which should match those passed to the +function that returned :arg:`field` such as :func:`TSMimeHdrFieldFind`. The :arg:`value` is copied +to the header represented by :arg:`bufp`. :arg:`value` does not have to be null terminated (and in +general should not be). + +If :arg:`idx` is non-negative the existing value in the field is treated as a multi-value and +:arg:`idx` as the 0 based index of which element to set. For example if the field had the value +``dave, grigor, tamara`` and :func:`TSMimeHdrFieldValueStringSet` was called with :arg:`value` of +``syeda`` and :arg:`idx` of 1, the value would be set to ``dave, syeda, tamara``. If :arg:`idx` is +non-negative it must be the index of an existing element or exactly one past the last element or the +call will fail. In the example case :arg:`idx` must be between ``0`` and ``3`` inclusive. +:func:`TSMimeHdrFieldValuesCount` can be used to get the current number of elements. + +This function returns :macro:`TS_SUCCESS` if the value was set, :macro:`TS_ERROR` if not. diff --git a/doc/developer-guide/api/functions/TSMimeHdrFieldValuesCount.en.rst b/doc/developer-guide/api/functions/TSMimeHdrFieldValuesCount.en.rst index 90dd9cd..ccadb1f 100644 --- a/doc/developer-guide/api/functions/TSMimeHdrFieldValuesCount.en.rst +++ b/doc/developer-guide/api/functions/TSMimeHdrFieldValuesCount.en.rst @@ -30,3 +30,5 @@ Synopsis Description =========== + +:func:`TSMimeHdrFieldValuesCount` returns the number of elements in a multi-valued :arg:`field`. -- To stop receiving notification emails like this one, please contact ['"commits@trafficserver.apache.org" <commits@trafficserver.apache.org>'].