Bug 1475997 - Using ansible-doc -l when pointing to the TripleO validations should not throw an error.
Using ansible-doc -l when pointing to the TripleO validations should not thro...
Status: ON_DEV
Product: Red Hat OpenStack
Classification: Red Hat
Component: openstack-tripleo-validations (Show other bugs)
11.0 (Ocata)
Unspecified Unspecified
unspecified Severity unspecified
: ---
: 12.0 (Pike)
Assigned To: Florian Fuchs
nlevinki
: Triaged
Depends On:
Blocks:
  Show dependency treegraph
 
Reported: 2017-07-27 14:19 EDT by Darin Sorrentino
Modified: 2017-08-18 11:02 EDT (History)
6 users (show)

See Also:
Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of:
Environment:
Last Closed:
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
CRM:
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---


Attachments (Terms of Use)


External Trackers
Tracker ID Priority Status Summary Last Updated
OpenStack gerrit 491845 None None None 2017-08-18 11:02 EDT

  None (edit)
Description Darin Sorrentino 2017-07-27 14:19:15 EDT
Description of problem:

If using an ansible.cfg file pointing to TripleO Validations and you attempt to list the docs for the modules, it throws an error:

$ grep ^library ansible.cfg 

library = /usr/share/openstack-tripleo-validations/validations/library

$ ansible-doc -l

ERROR! module advanced_format has a documentation error formatting or is missing documentation

$ 

The validations should have associated docs to show their use and ansible-doc -l should list those.

Version-Release number of selected component (if applicable):


How reproducible:


Steps to Reproduce:
1. One Director create an ansible.cfg with an library pointing to /usr/share/openstack-tripleo-validations/validations/library
2. Run: ansible-doc -l
3.

Actual results:

$ ansible-doc -l

ERROR! module advanced_format has a documentation error formatting or is missing documentation


Expected results:

Document list of the validations

Additional info:

Note You need to log in before you can comment on or make changes to this bug.