doc/source/man/neutron-server.rst is out-of-date. is it necessary?

Bug #1520041 reported by Akihiro Motoki
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
neutron
Fix Released
Wishlist
Armando Migliaccio

Bug Description

doc/source/man/neutron-server.rst is not maintained and out-of-date.
Options mainly depend on oslo and it is not easy to maintain it.

One option is to delete it.
There is another opinion that it is worth having the man page even though it is a skeleton. I don't have a good idea on how to keep it up-to-date.

Akihiro Motoki (amotoki)
tags: added: low-hanging-fruit
Revision history for this message
Akihiro Motoki (amotoki) wrote :

/FYI/

A man page itself can be generated from the output of neutron-server --help:

  help2man --version-string=7.0.0 neutron-server

However, the output is roff format.
I don't know a way to generate a ReST forman directly or indirectly (from roff format).

Any idea?

description: updated
Mannu (mannu-ray)
Changed in neutron:
assignee: nobody → Mannu (mannu-ray)
Doug Wiegley (dougwig)
Changed in neutron:
status: New → Confirmed
Revision history for this message
Armando Migliaccio (armando-migliaccio) wrote :

Let's just delete it.

Revision history for this message
Armando Migliaccio (armando-migliaccio) wrote :

As Akihiro said, configuration come from oslo and server executables are usually wrapped in service commands, taken care of by packagers and distributors. Any documentation here provides very little value.

Changed in neutron:
importance: Low → Wishlist
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to neutron (master)

Fix proposed to branch: master
Review: https://review.openstack.org/253750

Changed in neutron:
assignee: Mannu (mannu-ray) → Armando Migliaccio (armando-migliaccio)
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to neutron (master)

Reviewed: https://review.openstack.org/253750
Committed: https://git.openstack.org/cgit/openstack/neutron/commit/?id=eb5c66c36a480a7734af1bce619d74f7c6cf1360
Submitter: Jenkins
Branch: master

commit eb5c66c36a480a7734af1bce619d74f7c6cf1360
Author: armando-migliaccio <email address hidden>
Date: Fri Dec 4 17:01:20 2015 -0800

    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

Changed in neutron:
status: In Progress → Fix Committed
Changed in neutron:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.