You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by bn...@apache.org on 2022/05/25 15:31:29 UTC
[trafficserver] branch master updated: Add missing configuration files man pages (#8861)
This is an automated email from the ASF dual-hosted git repository.
bneradt 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 0a3369173 Add missing configuration files man pages (#8861)
0a3369173 is described below
commit 0a3369173b275e335bd83c8cb31673a0ef725590
Author: Jean Baptiste Favre <gi...@jbfavre.org>
AuthorDate: Wed May 25 17:31:23 2022 +0200
Add missing configuration files man pages (#8861)
* Add missing sni.yaml and strategies.yaml man pages. Improve file readability
---
doc/manpages.py | 81 +++++++++++++++++++++++++++++++++++++++------------------
1 file changed, 56 insertions(+), 25 deletions(-)
diff --git a/doc/manpages.py b/doc/manpages.py
index 9e6cc44d8..66644997e 100644
--- a/doc/manpages.py
+++ b/doc/manpages.py
@@ -21,34 +21,65 @@ man_pages = [
# pages
('developer-guide/api/functions/' + filename[:-4], filename.split('.', 1)[0], filename.split('.', 1)[0] + ' API function', None, '3ts') for filename in os.listdir('developer-guide/api/functions/') if filename != 'index.en.rst' and filename.endswith('.rst')] + [
- ('appendices/command-line/traffic_ctl.en', 'traffic_ctl', u'Traffic Server command line tool', None, '8'),
- ('appendices/command-line/traffic_crashlog.en', 'traffic_crashlog', u'Traffic Server crash log helper', None, '8'),
- ('appendices/command-line/traffic_logcat.en', 'traffic_logcat', u'Traffic Server log spooler', None, '8'),
- ('appendices/command-line/traffic_logstats.en', 'traffic_logstats', u'Traffic Server analyzer', None, '8'),
- ('appendices/command-line/traffic_manager.en', 'traffic_manager', u'Traffic Server process manager', None, '8'),
- ('appendices/command-line/traffic_server.en', 'traffic_server', u'Traffic Server', None, '8'),
+ # Add all files in the appendices/command-line directory to the list
+ # of manual pages
+ ('appendices/command-line/traffic_cache_tool.en', 'traffic_cache_tool',
+ u'Traffic Server cache management tool', None, '1'),
+ ('appendices/command-line/traffic_crashlog.en', 'traffic_crashlog',
+ u'Traffic Server crash log helper', None, '8'),
+ ('appendices/command-line/traffic_ctl.en', 'traffic_ctl',
+ u'Traffic Server command line tool', None, '8'),
+ ('appendices/command-line/traffic_layout.en', 'traffic_layout',
+ u'Traffic Server sandbox management tool', None, '1'),
+ ('appendices/command-line/traffic_logcat.en', 'traffic_logcat',
+ u'Traffic Server log spooler', None, '8'),
+ ('appendices/command-line/traffic_logstats.en', 'traffic_logstats',
+ u'Traffic Server analyzer', None, '8'),
+ ('appendices/command-line/traffic_manager.en', 'traffic_manager',
+ u'Traffic Server process manager', None, '8'),
+ ('appendices/command-line/traffic_server.en', 'traffic_server',
+ u'Traffic Server', None, '8'),
+ ('appendices/command-line/traffic_top.en', 'traffic_top',
+ u'Display Traffic Server statistics', None, '1'),
+ ('appendices/command-line/traffic_via.en', 'traffic_via',
+ u'Traffic Server Via header decoder', None, '1'),
+ ('appendices/command-line/traffic_wccp.en', 'traffic_wccp',
+ u'Traffic Server WCCP client', None, '1'),
+ ('appendices/command-line/tspush.en', 'tspush',
+ u'Push objects into the Traffic Server cache', None, '1'),
+ ('appendices/command-line/tsxs.en', 'tsxs',
+ u'Traffic Server plugin tool', None, '1'),
- ('appendices/command-line/tspush.en', 'tspush', u'Push objects into the Traffic Server cache', None, '1'),
- ('appendices/command-line/traffic_top.en', 'traffic_top', u'Display Traffic Server statistics', None, '1'),
- ('appendices/command-line/tsxs.en', 'tsxs', u'Traffic Server plugin tool', None, '1'),
- ('appendices/command-line/traffic_via.en', 'traffic_via', u'Traffic Server Via header decoder', None, '1'),
- ('appendices/command-line/traffic_layout.en', 'traffic_layout', u'Traffic Server sandbox management tool', None, '1'),
- ('appendices/command-line/traffic_cache_tool.en', 'traffic_cache_tool', u'Traffic Server cache management tool', None, '1'),
- ('appendices/command-line/traffic_wccp.en', 'traffic_wccp', u'Traffic Server WCCP client', None, '1'),
-
- ('admin-guide/files/cache.config.en', 'cache.config', u'Traffic Server cache configuration file', None, '5'),
- ('admin-guide/files/hosting.config.en', 'hosting.config', u'Traffic Server domain hosting configuration file', None, '5'),
- ('admin-guide/files/ip_allow.yaml.en', 'ip_allow.yaml', u'Traffic Server IP access control configuration file', None, '5'),
- ('admin-guide/files/logging.yaml.en', 'logging.yaml', u'Traffic Server logging configuration file', None, '5'),
- ('admin-guide/files/parent.config.en', 'parent.config', u'Traffic Server parent cache configuration file', None, '5'),
- ('admin-guide/files/plugin.config.en', 'plugin.config', u'Traffic Server global plugin configuration file', None, '5'),
- ('admin-guide/files/records.config.en', 'records.config', u'Traffic Server configuration file', None, '5'),
- ('admin-guide/files/remap.config.en', 'remap.config', u'Traffic Server remap rules configuration file', None, '5'),
- ('admin-guide/files/splitdns.config.en', 'splitdns.config', u'Traffic Server split DNS configuration file', None, '5'),
+ # Add all files in the admin-guide/files directory to the list
+ # of manual pages
+ ('admin-guide/files/cache.config.en', 'cache.config',
+ u'Traffic Server cache configuration file', None, '5'),
+ ('admin-guide/files/hosting.config.en', 'hosting.config',
+ u'Traffic Server domain hosting configuration file', None, '5'),
+ ('admin-guide/files/ip_allow.yaml.en', 'ip_allow.yaml',
+ u'Traffic Server IP access control configuration file', None, '5'),
+ ('admin-guide/files/logging.yaml.en', 'logging.yaml',
+ u'Traffic Server logging configuration file', None, '5'),
+ ('admin-guide/files/parent.config.en', 'parent.config',
+ u'Traffic Server parent cache configuration file', None, '5'),
+ ('admin-guide/files/plugin.config.en', 'plugin.config',
+ u'Traffic Server global plugin configuration file', None, '5'),
+ ('admin-guide/files/records.config.en', 'records.config',
+ u'Traffic Server configuration file', None, '5'),
+ ('admin-guide/files/remap.config.en', 'remap.config',
+ u'Traffic Server remap rules configuration file', None, '5'),
+ ('admin-guide/files/sni.yaml.en', 'sni.yaml',
+ u'Traffic Server sni rules configuration file', None, '5'),
+ ('admin-guide/files/splitdns.config.en', 'splitdns.config',
+ u'Traffic Server split DNS configuration file', None, '5'),
('admin-guide/files/ssl_multicert.config.en', 'ssl_multicert.config',
u'Traffic Server SSL certificate configuration file', None, '5'),
- ('admin-guide/files/storage.config.en', 'storage.config', u'Traffic Server cache storage configuration file', None, '5'),
- ('admin-guide/files/volume.config.en', 'volume.config', u'Traffic Server cache volume configuration file', None, '5'),
+ ('admin-guide/files/storage.config.en', 'storage.config',
+ u'Traffic Server cache storage configuration file', None, '5'),
+ ('admin-guide/files/strategies.yaml.en', 'strategies.yaml',
+ u'Traffic Server cache hierarchy configuration file', None, '5'),
+ ('admin-guide/files/volume.config.en', 'volume.config',
+ u'Traffic Server cache volume configuration file', None, '5'),
]