sphinxext: wrong formatting for --foo-bar style mandatory argument

Bug #1706311 reported by Akihiro Motoki
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
cliff
Fix Released
Undecided
Akihiro Motoki

Bug Description

When --foo-bar style mandatory option is used, autoprogram-cliff sphinx extensions renders the usage wrongly.

Note that option references are rendered correctly.
This only happens when rendering usage summary.

For example, https://docs.openstack.org/python-neutronclient/latest/cli/osc/v2/network-trunk.html#network-trunk-create

openstack network trunk create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--prefix PREFIX]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--description <description>]
    --parent
    -p
    ort
    <parent-port>
    [--subport <port=,segmentation-type=,segmentation-id=>]
    [--enable | --disable]
    [--project <project>]
    [--project-domain <project-domain>]
    <name>

Changed in python-cliff:
assignee: nobody → Akihiro Motoki (amotoki)
status: New → In Progress
Revision history for this message
Yushiro FURUKAWA (y-furukawa-2) wrote :
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to cliff (master)

Reviewed: https://review.openstack.org/486562
Committed: https://git.openstack.org/cgit/openstack/cliff/commit/?id=d327658a75abcf46e25c7bb8e2f606d7772d8158
Submitter: Jenkins
Branch: master

commit d327658a75abcf46e25c7bb8e2f606d7772d8158
Author: Yushiro FURUKAWA <email address hidden>
Date: Mon Jul 24 19:39:04 2017 +0900

    Fix regexp for detecting long options

    This commit fixes regexp in order to detect mandatory long arguments
    with hyphen like '--foo-bar <foo-bar>'.

    Note that https://review.openstack.org/#/c/496189/ fixes the bug
    paritally but it does not cover all cases.

    Closes-Bug: #1706311
    Co-Authored-By: Akihiro Motoki <email address hidden>
    Change-Id: I52b9fdecbf1abea1f819b0061fd80b7ca6e0906d

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

This issue was fixed in the openstack/cliff 2.9.0 release.

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.