yahoo-eng-team team mailing list archive

["Markus Zoeller \(markus_z\)" <mzoeller@xxxxxxxxxx>]

Public bug reported:

Version: Nova Newton master b335318 Jenkins 2016-04-13

Steps to reproduce:
    * checkout nova code
    * in base folder execute: "tox -e genconfig"
    * check section "[xenserver]" in file "etc/nova/nova.conf.sample"

There is too much whitespace between the "#" on the left side until
the actual doc starts. The multiline comment at [2] is not properly
formatted. See the other sections for the expected result.

See the rendered result at [1]. Launchpad crops the superfluous
whitespace, so I cannot show an example here.

References:
[1] http://docs.openstack.org/developer/nova/sample_config.html
[2] https://github.com/openstack/nova/blob/b335318a6254e0e4752bcf0665579527b628c963/nova/conf/xenserver.py

** Affects: nova
     Importance: Low
         Status: Triaged


** Tags: config doc low-hanging-fruit

** Changed in: nova
       Status: New => Triaged

** Changed in: nova
   Importance: Undecided => Low

** Tags added: config doc low-hanging-fruit

** Description changed:

  Version: Nova Newton master b335318 Jenkins 2016-04-13
  
  Steps to reproduce:
-     * checkout nova code
-     * in base folder execute: "tox -e genconfig"
-     * check section "[xenserver]" in file "etc/nova/nova.conf.sample" 
+     * checkout nova code
+     * in base folder execute: "tox -e genconfig"
+     * check section "[xenserver]" in file "etc/nova/nova.conf.sample"
  
  There is too much whitespace between the "#" on the left side until
  the actual doc starts. The multiline comment at [2] is not properly
  formatted. See the other sections for the expected result.
  
- Example:
- [xenserver]
- 
- #
- # From nova.conf
- #
- 
- #
- #                Number of seconds to wait for agent's reply to a request.
- #
- #                Nova configures/performs certain administrative actions on a
- #                server with the help of an agent that's installed on the
- # server.
- #                The communication between Nova and the agent is achieved via
- #                sharing messages, called records, over xenstore, a shared
- #                storage across all the domains on a Xenserver host.
- #                Operations performed by the agent on behalf of nova are:
- #                'version',' key_init',
- # 'password','resetnetwork','inject_file',
- #                and 'agentupdate'.
+ See the rendered result at [1]. Launchpad crops the superfluous
+ whitespace, so I cannot show an example here.
  
  References:
  [1] http://docs.openstack.org/developer/nova/sample_config.html
  [2] https://github.com/openstack/nova/blob/b335318a6254e0e4752bcf0665579527b628c963/nova/conf/xenserver.py

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Compute (nova).
https://bugs.launchpad.net/bugs/1570270

Title:
  nova.sample.conf: The xenserver docs have a wrong indentation

Status in OpenStack Compute (nova):
  Triaged

Bug description:
  Version: Nova Newton master b335318 Jenkins 2016-04-13

  Steps to reproduce:
      * checkout nova code
      * in base folder execute: "tox -e genconfig"
      * check section "[xenserver]" in file "etc/nova/nova.conf.sample"

  There is too much whitespace between the "#" on the left side until
  the actual doc starts. The multiline comment at [2] is not properly
  formatted. See the other sections for the expected result.

  See the rendered result at [1]. Launchpad crops the superfluous
  whitespace, so I cannot show an example here.

  References:
  [1] http://docs.openstack.org/developer/nova/sample_config.html
  [2] https://github.com/openstack/nova/blob/b335318a6254e0e4752bcf0665579527b628c963/nova/conf/xenserver.py

To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1570270/+subscriptions