diff options
| author | whoami-rajat <rajatdhasmana@gmail.com> | 2022-04-28 14:38:13 +0530 |
|---|---|---|
| committer | whoami-rajat <rajatdhasmana@gmail.com> | 2022-04-28 15:27:31 +0530 |
| commit | 9673a74b600cd387aa3d13a6ff923c06c304c55a (patch) | |
| tree | b5a4d17b56b3809d9a48888acbe3f29204ace4d9 /releasenotes | |
| parent | d89cdda6b13ad664443051a53b084781f255b048 (diff) | |
| download | oslo-policy-9673a74b600cd387aa3d13a6ff923c06c304c55a.tar.gz | |
Only pass exclude-deprecated when True3.12.1
The '--exclude-deprecated' parameter should only be passed to
oslo.config to parse when it is True.
The final generated sphinx syntax is[1] where [--exclude-deprecated]
doesn't require True/False value and only should be passed when True.
The change introducing this[2] causes parsing issue in oslo.config[3]
while checking <bool>.startswith (we pass True/False value) and even
after that while calling argparse[4] with following error[5].
[1] usage: sphinx-build [-h] [--config-dir DIR] [--config-file PATH] [--exclude-deprecated] [--format FORMAT] [--namespace NAMESPACE]
[--noexclude-deprecated] [--output-file OUTPUT_FILE]
[2] https://review.opendev.org/c/openstack/oslo.policy/+/830514
[3] https://opendev.org/openstack/oslo.config/src/branch/master/oslo_config/cfg.py#L2937
[4] https://opendev.org/openstack/oslo.config/src/branch/master/oslo_config/cfg.py#L2960
[5] > /usr/lib/python3.8/argparse.py(1781)parse_args()
-> if argv:
(Pdb)
> /usr/lib/python3.8/argparse.py(1782)parse_args()
-> msg = _('unrecognized arguments: %s')
(Pdb)
> /usr/lib/python3.8/argparse.py(1783)parse_args()
-> self.error(msg % ' '.join(argv))
(Pdb)
TypeError: sequence item 0: expected str instance, bool found
> /usr/lib/python3.8/argparse.py(1783)parse_args()
-> self.error(msg % ' '.join(argv))
Handler <function generate_sample at 0x7fc0d6697d30> for event 'builder-inited' threw an exception (exception: sequence item 0: expected str instance, bool found)
Closes-Bug: #1970725
Change-Id: I95745b8d1cbdb6a7cf442d431a998b7e3ff600e4
Diffstat (limited to 'releasenotes')
| -rw-r--r-- | releasenotes/notes/fix-passing-exclude-deprecated-param-317745d23022e544.yaml | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/releasenotes/notes/fix-passing-exclude-deprecated-param-317745d23022e544.yaml b/releasenotes/notes/fix-passing-exclude-deprecated-param-317745d23022e544.yaml new file mode 100644 index 0000000..6f44389 --- /dev/null +++ b/releasenotes/notes/fix-passing-exclude-deprecated-param-317745d23022e544.yaml @@ -0,0 +1,6 @@ +--- +fixes: + - | + Fixed passing ``--exclude-deprecated`` boolean value to + sphinx-build command. Now ``--exclude-deprecated`` is only + passed when it is True without bool True/False value. |