Fix missing command descriptions in manpages/docs (#81366)

pull/81374/head
Matt Clay 1 year ago committed by GitHub
parent f9d674fcfd
commit 32b388b4ca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -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.

@ -362,6 +362,7 @@ class ConfigCLI(CLI):
return sections return sections
def execute_init(self): def execute_init(self):
"""Create initial configuration"""
data = [] data = []
config_entries = self._list_entries_from_args() config_entries = self._list_entries_from_args()

@ -11,6 +11,7 @@ __metaclass__ = type
from ansible.cli import CLI from ansible.cli import CLI
import argparse import argparse
import functools
import json import json
import os.path import os.path
import pathlib import pathlib
@ -94,6 +95,7 @@ def with_collection_artifacts_manager(wrapped_method):
the related temporary directory auto-cleanup around the target the related temporary directory auto-cleanup around the target
method invocation. method invocation.
""" """
@functools.wraps(wrapped_method)
def method_wrapper(*args, **kwargs): def method_wrapper(*args, **kwargs):
if 'artifacts_manager' in kwargs: if 'artifacts_manager' in kwargs:
return wrapped_method(*args, **kwargs) return wrapped_method(*args, **kwargs)
@ -1041,6 +1043,7 @@ class GalaxyCLI(CLI):
@with_collection_artifacts_manager @with_collection_artifacts_manager
def execute_download(self, artifacts_manager=None): def execute_download(self, artifacts_manager=None):
"""Download collections and their dependencies as a tarball for an offline install."""
collections = context.CLIARGS['args'] collections = context.CLIARGS['args']
no_deps = context.CLIARGS['no_deps'] no_deps = context.CLIARGS['no_deps']
download_path = context.CLIARGS['download_path'] download_path = context.CLIARGS['download_path']
@ -1272,6 +1275,7 @@ class GalaxyCLI(CLI):
@with_collection_artifacts_manager @with_collection_artifacts_manager
def execute_verify(self, artifacts_manager=None): 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'] collections = context.CLIARGS['args']
search_paths = AnsibleCollectionConfig.collection_paths search_paths = AnsibleCollectionConfig.collection_paths
@ -1309,8 +1313,6 @@ class GalaxyCLI(CLI):
You can pass in a list (roles or collections) or use the file 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 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. 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'] install_items = context.CLIARGS['args']
requirements_file = context.CLIARGS['requirements'] requirements_file = context.CLIARGS['requirements']

@ -64,7 +64,7 @@ class InventoryCLI(CLI):
def init_parser(self): def init_parser(self):
super(InventoryCLI, self).init_parser( super(InventoryCLI, self).init_parser(
usage='usage: %prog [options] [host|group]', 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_inventory_options(self.parser)
opt_help.add_vault_options(self.parser) opt_help.add_vault_options(self.parser)

Loading…
Cancel
Save