Project

General

Profile

Actions

Bug #16148

closed

Enable/disable module descriptions in help output are confusing

Added by Shlomi Zadok almost 8 years ago. Updated almost 6 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
Foreman modules
Target version:
Difficulty:
Triaged:
Fixed in Releases:
Found in Releases:

Description

Cloned from https://bugzilla.redhat.com/show_bug.cgi?id=1329375
Description of problem:

The description for the below options is not right and is confusing.

~]# foreman-installer --help | grep i scap
-
[no-]enable-foreman-plugin-openscap Enable 'foreman_plugin_openscap' puppet module (default: true)
--[no-]enable-foreman-proxy-plugin-openscap Enable 'foreman_proxy_plugin_openscap' puppet module (default: true)
--foreman-proxy-plugin-openscap-enabled enables/disables the plugin (default: true)

Also if "--[no-]enable-foreman-plugin-openscap" configures the sat6 side stuff and "--[no-]enable-foreman-proxy-plugin-openscap" configures the capsule side stuff then the description for "--foreman-proxy-plugin-openscap-enabled" as
"enables/disables the plugin " is not at all clear.

This needs to be updated to bring in more clarity.

Version-Release number of selected component (if applicable):
sat62-snap9.0

How reproducible:

Steps to Reproduce:
1.
2.
3.

Actual results:

Currently the description for [no]enable-foreman-plugin-openscap and [no]enable-foreman-plugin-openscap ,

uses the words "puppet module" which is incorrect.

Also the requirement/purpose of this --foreman-proxy-plugin-openscap-enabled is not clear.

Expected results:

The description is not clear and needs more detail, something like

--[no-]enable-foreman-plugin-openscap Installs and configures the packages required for Satellite6
--[no-]enable-foreman-proxy-plugin-openscap Installs and configures the packages required for Capsules
--foreman-proxy-plugin-openscap-enabled "< exact description>"
Additional info:

Actions

Also available in: Atom PDF