From c68de94a986fb65e5bb0530a24b8b1b622f22289 Mon Sep 17 00:00:00 2001 From: Randall Meyer Date: Mon, 21 Sep 2020 10:23:48 -0700 Subject: [PATCH] Docs cleanup Remove references to ATS 4.x, update examples for logging to YAML --- doc/admin-guide/files/records.config.en.rst | 4 ++-- doc/admin-guide/plugins/access_control.en.rst | 20 +++++++++---------- .../cache-architecture/architecture.en.rst | 4 ++-- plugins/experimental/statichit/statichit.cc | 2 +- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/doc/admin-guide/files/records.config.en.rst b/doc/admin-guide/files/records.config.en.rst index 9060916d18c..0e9a58b1b98 100644 --- a/doc/admin-guide/files/records.config.en.rst +++ b/doc/admin-guide/files/records.config.en.rst @@ -537,10 +537,10 @@ Local Manager process as, which also has the effect of setting ownership of configuration and log files. - As of version 2.1.1 if the user_id is prefixed with pound character (``#``) + If the user_id is prefixed with pound character (``#``), the remainder of the string is considered to be a `numeric user identifier `_. - If the value is set to ``#-1`` |TS| will not change the user during startup. + If the value is set to ``#-1``, |TS| will not change the user during startup. .. important:: diff --git a/doc/admin-guide/plugins/access_control.en.rst b/doc/admin-guide/plugins/access_control.en.rst index d06d5efc04b..8fec83be080 100644 --- a/doc/admin-guide/plugins/access_control.en.rst +++ b/doc/admin-guide/plugins/access_control.en.rst @@ -379,16 +379,16 @@ Configuration files * Format the ``access_control.log`` -.. code-block:: bash - - access_control_format = format { - Format = '% sub=%<{@TokenSubject}cqh> tid=%<{@TokenId}cqh> status=%<{@TokenStatus}cqh> cache=%<{x-cache}psh> key=%<{x-cache-key}psh>' } - - log.ascii { - Filename = 'access_control', - Format = access_control_format - } - +.. code-block:: yaml + + logging: + formats: + - format: '% sub=%<{@TokenSubject}cqh> tid=%<{@TokenId}cqh> status=%<{@TokenStatus}cqh> cache=%<{x-cache}psh> key=%<{x-cache-key}psh>' + name: access_control_format + logs: + - filename: access_control + format: access_control_format + mode: ascii * X-Debug plugin added to ``plugin.config`` diff --git a/doc/developer-guide/cache-architecture/architecture.en.rst b/doc/developer-guide/cache-architecture/architecture.en.rst index 0f04102643f..2bc34635424 100644 --- a/doc/developer-guide/cache-architecture/architecture.en.rst +++ b/doc/developer-guide/cache-architecture/architecture.en.rst @@ -95,8 +95,8 @@ assigned to a stripe (and in turn to a cache volume) automatically based on a hash of the URI used to retrieve the object from the :term:`origin server`. It is possible to configure this to a limited extent in :file:`hosting.config`, which supports content from specific hosts or domain to be stored on specific -cache volumes. As of version 4.0.1 it is also possible to control which cache -spans (and hence, which cache stripes) are contained in a specific cache volume. +cache volumes. It's also possible to control which cache spans (and hence, +which cache stripes) are contained in a specific cache volume. The layout and structure of the cache spans, the cache volumes, and the cache stripes that compose them are derived entirely from :file:`storage.config` and diff --git a/plugins/experimental/statichit/statichit.cc b/plugins/experimental/statichit/statichit.cc index cc481df8f9c..15203508faa 100644 --- a/plugins/experimental/statichit/statichit.cc +++ b/plugins/experimental/statichit/statichit.cc @@ -1,6 +1,6 @@ /** @file - Static HIt Content Serving + Static Hit Content Serving @section license License