(cherry picked from commit 32b388b4ca)
This commit is contained in:
8
changelogs/fragments/add-missing-cli-docs.yml
Normal file
8
changelogs/fragments/add-missing-cli-docs.yml
Normal file
@ -0,0 +1,8 @@
|
||||
bugfixes:
|
||||
- The ``ansible-config init`` command now has a documentation description.
|
||||
- The ``ansible-galaxy collection download`` command now has a documentation description.
|
||||
- The ``ansible-galaxy collection verify`` command now has a documentation description.
|
||||
- The ``ansible-inventory`` command command now has a documentation description (previously used as the epilog).
|
||||
- The ``ansible-galaxy collection install`` command documentation is now visible (previously hidden by a decorator).
|
||||
- The ``ansible-galaxy role install`` command documentation is now visible (previously hidden by a decorator).
|
||||
- Fix ``ansible-config init`` man page option indentation.
|
||||
@ -334,6 +334,7 @@ class ConfigCLI(CLI):
|
||||
return sections
|
||||
|
||||
def execute_init(self):
|
||||
"""Create initial configuration"""
|
||||
|
||||
data = []
|
||||
config_entries = self._list_entries_from_args()
|
||||
|
||||
@ -10,6 +10,7 @@ __metaclass__ = type
|
||||
# ansible.cli needs to be imported first, to ensure the source bin/* scripts run that code first
|
||||
from ansible.cli import CLI
|
||||
|
||||
import functools
|
||||
import json
|
||||
import os.path
|
||||
import re
|
||||
@ -82,6 +83,7 @@ def with_collection_artifacts_manager(wrapped_method):
|
||||
the related temporary directory auto-cleanup around the target
|
||||
method invocation.
|
||||
"""
|
||||
@functools.wraps(wrapped_method)
|
||||
def method_wrapper(*args, **kwargs):
|
||||
if 'artifacts_manager' in kwargs:
|
||||
return wrapped_method(*args, **kwargs)
|
||||
@ -986,6 +988,7 @@ class GalaxyCLI(CLI):
|
||||
|
||||
@with_collection_artifacts_manager
|
||||
def execute_download(self, artifacts_manager=None):
|
||||
"""Download collections and their dependencies as a tarball for an offline install."""
|
||||
collections = context.CLIARGS['args']
|
||||
no_deps = context.CLIARGS['no_deps']
|
||||
download_path = context.CLIARGS['download_path']
|
||||
@ -1212,6 +1215,7 @@ class GalaxyCLI(CLI):
|
||||
|
||||
@with_collection_artifacts_manager
|
||||
def execute_verify(self, artifacts_manager=None):
|
||||
"""Compare checksums with the collection(s) found on the server and the installed copy. This does not verify dependencies."""
|
||||
|
||||
collections = context.CLIARGS['args']
|
||||
search_paths = context.CLIARGS['collections_path']
|
||||
@ -1249,8 +1253,6 @@ class GalaxyCLI(CLI):
|
||||
You can pass in a list (roles or collections) or use the file
|
||||
option listed below (these are mutually exclusive). If you pass in a list, it
|
||||
can be a name (which will be downloaded via the galaxy API and github), or it can be a local tar archive file.
|
||||
|
||||
:param artifacts_manager: Artifacts manager.
|
||||
"""
|
||||
install_items = context.CLIARGS['args']
|
||||
requirements_file = context.CLIARGS['requirements']
|
||||
|
||||
@ -65,7 +65,7 @@ class InventoryCLI(CLI):
|
||||
def init_parser(self):
|
||||
super(InventoryCLI, self).init_parser(
|
||||
usage='usage: %prog [options] [host|group]',
|
||||
epilog='Show Ansible inventory information, by default it uses the inventory script JSON format')
|
||||
desc='Show Ansible inventory information, by default it uses the inventory script JSON format')
|
||||
|
||||
opt_help.add_inventory_options(self.parser)
|
||||
opt_help.add_vault_options(self.parser)
|
||||
|
||||
Reference in New Issue
Block a user