Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixes to ansible-doc #47209

Merged
merged 2 commits into from
Oct 17, 2018
Merged

fixes to ansible-doc #47209

merged 2 commits into from
Oct 17, 2018

Conversation

bcoca
Copy link
Member

@bcoca bcoca commented Oct 17, 2018

2 for the price of 1

ISSUE TYPE
  • Bugfix Pull Request
COMPONENT NAME

ansible-doc

ANSIBLE VERSION
2.7

bcoca and others added 2 commits October 17, 2018 11:53
* removed hardcoded loader/plugins list
* updated a few errors to keep orig object
* fix httpapi/cliconf listing
* ansible-doc fixes
* show undocumented as UNDOCUMENTEd
* added missing undoc

(cherry picked from commit fce9673)
…7012)

* An earlier optimization of ansible-doc -l caused failures.

The optimization quickly searches the plugin code for short_description
fields and then uses that in the -l output.  The searching was a bit too
naive and ended up pulling out malformed yaml.  This caused those
plugins to be omitted from the list of plugins of that type with
a warning that their documentation strings were wrong.

This change makes the documentation parser aware that the documentation
string could have a relative indent for all of its fields which makes it
robust in the face of this particular problem.

* Don't search for space after short_description:

Any whitespace would be valid.  In particular newline

(cherry picked from commit 61ae642)
@acozine
Copy link
Contributor

acozine commented Oct 17, 2018

Backports #47012 and #47137 to 2.7.

@ansibot
Copy link
Contributor

ansibot commented Oct 17, 2018

Hi @bcoca, thank you for submitting this pull-request!

click here for bot help

@ansibot ansibot added affects_2.7 This issue/PR affects Ansible v2.7 backport This PR does not target the devel branch. bug This issue/PR relates to a bug. needs_triage Needs a first human triage before being processed. support:community This issue/PR relates to code supported by the Ansible community. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Oct 17, 2018
@acozine acozine merged commit b2381cf into ansible:stable-2.7 Oct 17, 2018
@abadger
Copy link
Contributor

abadger commented Oct 17, 2018

Merged for 2.7.1 release

@jborean93 jborean93 removed the needs_triage Needs a first human triage before being processed. label Oct 18, 2018
@bcoca bcoca deleted the adoc_fies_bck branch November 19, 2018 18:12
@ansible ansible locked and limited conversation to collaborators Jul 22, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.7 This issue/PR affects Ansible v2.7 backport This PR does not target the devel branch. bug This issue/PR relates to a bug. support:community This issue/PR relates to code supported by the Ansible community. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants