yahoo-eng-team team mailing list archive
-
yahoo-eng-team team
-
Mailing list archive
-
Message #72311
[Bug 1755783] Re: PCI configuration documentation renders with smart quotes
Reviewed: https://review.openstack.org/553860
Committed: https://git.openstack.org/cgit/openstack/oslo.config/commit/?id=03ff144f0bf386982d379d18aeb9183146a05fd5
Submitter: Zuul
Branch: master
commit 03ff144f0bf386982d379d18aeb9183146a05fd5
Author: Stephen Finucane <sfinucan@xxxxxxxxxx>
Date: Fri Mar 16 16:53:37 2018 +0000
sphinxext: Start parsing 'Opt.help' as rST
Users expect this to be parsed as rST and write their docstrings
accordingly. This has the potential to introduce warnings for users with
improperly formatted rST and these warnings can be promoted to errors if
'sphinx-build' is used with the '-W' option. As a result, we disable the
'warning-is-error' logger for these options. We may wish to change this
behavior in the future.
It is not really possible to test this yet as the output wouldn't look
much different. In addition, the error messages generated are rather
unhelpful. Both of these can be changed in a future modification.
Change-Id: Ic6c2dcbe7823dd3fdc71db8dc5afab2d604559e3
Closes-Bug: #1755783
** Changed in: oslo.config
Status: In Progress => Fix Released
--
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/1755783
Title:
PCI configuration documentation renders with smart quotes
Status in OpenStack Compute (nova):
Fix Released
Status in oslo.config:
Fix Released
Bug description:
https://docs.openstack.org/nova/latest/configuration/config.html#pci
For example, an alias example line renders as:
alias = { “name”: “QuickAssist”, “product_id”: “0443”, “vendor_id”:
“8086”, “device_type”: “type-PCI”, “numa_policy”: “required” }
Instead of the valid:
alias = { "name": "QuickAssist", "product_id": "0443", "vendor_id":
"8086", "device_type": "type-PCI", "numa_policy": "required" }
To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1755783/+subscriptions
References