PBR

argument -o/--output-dir is required

Bug #1753082 reported by Jeremy Stanley
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
PBR
Fix Released
Undecided
Stephen Finucane

Bug Description

Sphinx 1.7.1 is causing build-openstack-sphinx-docs jobs for some projects to return "setup.py: error: argument -o/--output-dir is required" from under PBR.

  2018-03-03 08:11:33.605714 | TASK [sphinx : Run sphinx using legacy pbr runner]
  2018-03-03 08:11:34.563699 | ubuntu-xenial | running build_sphinx
  2018-03-03 08:11:34.564643 | ubuntu-xenial | creating /home/zuul/src/git.openstack.org/openstack/neutron-lib/doc/build
  2018-03-03 08:11:34.564955 | ubuntu-xenial | creating /home/zuul/src/git.openstack.org/openstack/neutron-lib/doc/build/doctrees
  2018-03-03 08:11:34.565301 | ubuntu-xenial | creating /home/zuul/src/git.openstack.org/openstack/neutron-lib/doc/build/html
  2018-03-03 08:11:34.576235 | ubuntu-xenial | [pbr] Writing ChangeLog
  2018-03-03 08:11:34.576712 | ubuntu-xenial | [pbr] Generating ChangeLog
  2018-03-03 08:11:34.628505 | ubuntu-xenial | [pbr] ChangeLog complete (0.1s)
  2018-03-03 08:11:34.628877 | ubuntu-xenial | [pbr] Generating AUTHORS
  2018-03-03 08:11:34.711519 | ubuntu-xenial | [pbr] AUTHORS complete (0.1s)
  2018-03-03 08:11:34.718146 | ubuntu-xenial | usage: usage: setup.py [OPTIONS] -o <OUTPUT_PATH> <MODULE_PATH> [EXCLUDE_PATTERN, ...]
  2018-03-03 08:11:34.718597 | ubuntu-xenial | setup.py: error: argument -o/--output-dir is required
  2018-03-03 08:11:35.121773 | ubuntu-xenial | ERROR
  2018-03-03 08:11:35.122259 | ubuntu-xenial | {
  2018-03-03 08:11:35.122436 | ubuntu-xenial | "delta": "0:00:00.995805",
  2018-03-03 08:11:35.122604 | ubuntu-xenial | "end": "2018-03-03 08:11:34.777136",
  2018-03-03 08:11:35.122771 | ubuntu-xenial | "failed": true,
  2018-03-03 08:11:35.122936 | ubuntu-xenial | "rc": 2,
  2018-03-03 08:11:35.123101 | ubuntu-xenial | "start": "2018-03-03 08:11:33.781331"
  2018-03-03 08:11:35.123262 | ubuntu-xenial | }

Sample above taken from http://logs.openstack.org/03/548803/1/check/build-openstack-sphinx-docs/0548c1d/job-output.txt.gz#_2018-03-03_08_11_34_718597

Revision history for this message
Jeremy Stanley (fungi) wrote :

Proposed https://review.openstack.org/549412 to temporarily roll back to an earlier Sphinx version in OpenStack's master requirements upper constraints list.

Revision history for this message
Dirk Mueller (dmllr) wrote :

https://review.openstack.org/551438 should help with avoiding this in the future.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to pbr (master)

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

Changed in pbr:
assignee: nobody → Stephen Finucane (stephenfinucane)
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on pbr (master)

Change abandoned by Stephen Finucane (<email address hidden>) on branch: master
Review: https://review.openstack.org/552523
Reason: Solved it

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to pbr (master)

Reviewed: https://review.openstack.org/552100
Committed: https://git.openstack.org/cgit/openstack-dev/pbr/commit/?id=1fe0ceab39d47300d99b69b2ad3bbf87a4c61c08
Submitter: Zuul
Branch: master

commit 1fe0ceab39d47300d99b69b2ad3bbf87a4c61c08
Author: Stephen Finucane <email address hidden>
Date: Mon Mar 12 17:34:58 2018 +0000

    builddoc: Treat '[pbr] autodoc_tree_excludes' as a multi-line opt

    We were treating this a single line, comma- or space-delimited option.
    This was incorrect and was causing issues for projects like neutron-lib
    when Sphinx 1.7, which switches from optparse to the stricter argparse
    was used. In addition, this project was including comments in the
    multi-line opt. These were being passed through but Sphinx < 1.7 was
    simply ignoring them. These are now filtered out.

    Change-Id: I177edf0f44714175da220cf3a960b8f23aa4ab09
    Closes-Bug: #1753082

Changed in pbr:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack-dev/pbr 4.0.0

This issue was fixed in the openstack-dev/pbr 4.0.0 release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

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