From eb5c66c36a480a7734af1bce619d74f7c6cf1360 Mon Sep 17 00:00:00 2001 From: armando-migliaccio Date: Fri, 4 Dec 2015 17:01:20 -0800 Subject: [PATCH] Delete stale neutron-server manual The configuration options come from oslo and the server executable is usually wrapped in a service script, supplied by packagers and/or deployment tools. Any extra documentation available in tree is of relative value, and the fact that this file has been virtually ignored ever since it was added is a testament of that. Let's stop its agony and wish it to rest in peace. Closes-bug: #1520041 Change-Id: If5bba557526903b8064ee28628a21c3459ca85bc --- doc/source/conf.py | 11 ----- doc/source/index.rst | 7 --- doc/source/man/neutron-server.rst | 76 ------------------------------- 3 files changed, 94 deletions(-) delete mode 100644 doc/source/man/neutron-server.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 32b155b6f..77f0b3bb7 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -118,17 +118,6 @@ pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. modindex_common_prefix = ['neutron.'] -# -- Options for man page output -------------------------------------------- - -# Grouping the document tree for man pages. -# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual' - -man_pages = [ - ('man/neutron-server', 'neutron-server', u'Neutron Server', - [u'OpenStack'], 1) -] - - # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. Major themes that come with diff --git a/doc/source/index.rst b/doc/source/index.rst index 54043d2d0..8c3825a8f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -78,10 +78,3 @@ API Extensions ============== Go to http://api.openstack.org for information about OpenStack Network API extensions. - -Man Pages ---------- - -.. toctree:: - - man/neutron-server diff --git a/doc/source/man/neutron-server.rst b/doc/source/man/neutron-server.rst deleted file mode 100644 index 1540b54bc..000000000 --- a/doc/source/man/neutron-server.rst +++ /dev/null @@ -1,76 +0,0 @@ -============== -neutron-server -============== - --------------- -Neutron Server --------------- - -:Author: openstack@lists.openstack.org -:Date: 2012-04-05 -:Copyright: OpenStack Foundation -:Version: 2012.1 -:Manual section: 1 -:Manual group: cloud computing - -SYNOPSIS -======== - - neutron-server [options] - -DESCRIPTION -=========== - -neutron-server provides a webserver that exposes the Neutron API, and -passes all webservice calls to the Neutron plugin for processing. - -OPTIONS -======= - - --version show program's version number and exit - -h, --help show this help message and exit - -v, --verbose Print more verbose output - -d, --debug Print debugging output - --config-file=PATH Path to the config file to use, for example, - /etc/neutron/neutron.conf. When not specified - (the default), we generally look at the first argument - specified to be a config file, and if that is also - missing, we search standard directories for a config - file. (/etc/neutron/, - /usr/lib/pythonX/site-packages/neutron/) - - Logging Options: - The following configuration options are specific to logging - functionality for this program. - - --log-config=PATH If this option is specified, the logging configuration - file specified is used and overrides any other logging - options specified. Please see the Python logging - module documentation for details on logging - configuration files. - --log-date-format=FORMAT - Format string for %(asctime)s in log records. Default: - %Y-%m-%d %H:%M:%S - --use-syslog Output logs to syslog. - --log-file=PATH (Optional) Name of log file to output to. If not set, - logging will go to stdout. - --log-dir=LOG_DIR (Optional) The directory to keep log files in (will be - prepended to --logfile) - -FILES -======== - -* plugins.ini file contains the plugin information. -* neutron.conf file contains neutron-server's configuration information. - -SEE ALSO -======== - -* `OpenStack Neutron Documents `__ -* `OpenStack Neutron Wiki Page `__ - -BUGS -==== - -* Neutron is sourced in Launchpad so you can view current bugs at `OpenStack Bugs `__ - -- 2.45.2