Skip to content

Commit

Permalink
docs: remove unsupported --mask flag from man pages
Browse files Browse the repository at this point in the history
  • Loading branch information
infinitewarp committed Dec 17, 2024
1 parent 8bd92f6 commit 27bdce9
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 78 deletions.
27 changes: 3 additions & 24 deletions docs/_build/QPC_VAR_PROGRAM_NAME.1
Original file line number Diff line number Diff line change
Expand Up @@ -599,7 +599,7 @@ Use the \fBQPC_VAR_PROGRAM_NAME report\fP command to retrieve a report from a sc
.sp
The \fBQPC_VAR_PROGRAM_NAME report details\fP command retrieves a detailed report that contains the unprocessed facts that are gathered during a scan. These facts are the raw output from Network, vCenter, Satellite, Openshift, Red Hat Advanced Cluster Security and Ansible scans, as applicable.
.sp
\fBQPC_VAR_PROGRAM_NAME report details (\-\-scan\-job\fP \fIscan_job_identifier\fP \fB|\fP \fB\-\-report\fP \fIreport_identifier\fP \fB)\fP \fB(\-\-json|\-\-csv)\fP \fB\-\-output\-file\fP \fIpath\fP \fB[\-\-mask]\fP
\fBQPC_VAR_PROGRAM_NAME report details (\-\-scan\-job\fP \fIscan_job_identifier\fP \fB|\fP \fB\-\-report\fP \fIreport_identifier\fP \fB)\fP \fB(\-\-json|\-\-csv)\fP \fB\-\-output\-file\fP \fIpath\fP
.sp
\fB\-\-scan\-job=scan_job_identifier\fP
.INDENT 0.0
Expand Down Expand Up @@ -635,20 +635,13 @@ Displays the results of the report in CSV format. Mutually exclusive with the \f
Optional. Sets the path to a file location where the report data is saved. The file extension must be \fB\&.json\fP for the JSON report or \fB\&.csv\fP for the CSV report. When the field is not provided and \fI\-\-json\fP specified, a JSON report will be generated to stdout.
.UNINDENT
.UNINDENT
.sp
\fB\-\-mask\fP
.INDENT 0.0
.INDENT 3.5
Displays the results of the report with sensitive data masked by a hash.
.UNINDENT
.UNINDENT
.SS Viewing the Deployments Report
.sp
The \fBQPC_VAR_PROGRAM_NAME report deployments\fP command retrieves a report that contains the processed fingerprints from a scan. A \fIfingerprint\fP is the set of system, product, and entitlement facts for a particular physical or virtual machine. A processed fingerprint results from a procedure that merges facts from various sources, and, when possible, deduplicates redundant systems.
.sp
For example, the raw facts of a scan that includes both Network and vCenter sources could show two instances of a machine, indicated by an identical MAC address. The deployments report results in a deduplicated and merged fingerprint that shows both the Network and vCenter facts for that machine as a single set.
.sp
\fBQPC_VAR_PROGRAM_NAME report deployments (\-\-scan\-job\fP \fIscan_job_identifier\fP \fB|\fP \fB\-\-report\fP \fIreport_identifier\fP \fB)\fP \fB(\-\-json|\-\-csv)\fP \fB\-\-output\-file\fP \fIpath\fP \fB[\-\-mask]\fP
\fBQPC_VAR_PROGRAM_NAME report deployments (\-\-scan\-job\fP \fIscan_job_identifier\fP \fB|\fP \fB\-\-report\fP \fIreport_identifier\fP \fB)\fP \fB(\-\-json|\-\-csv)\fP \fB\-\-output\-file\fP \fIpath\fP
.sp
\fB\-\-scan\-job=scan_job_identifier\fP
.INDENT 0.0
Expand Down Expand Up @@ -684,13 +677,6 @@ Displays the results of the report in CSV format. Mutually exclusive with the \f
Optional. Sets the path to a file location where the report data is saved. The file extension must be \fB\&.json\fP for the JSON report or \fB\&.csv\fP for the CSV report. When the field is not provided and \fI\-\-json\fP specified, a JSON report will be generated to stdout.
.UNINDENT
.UNINDENT
.sp
\fB\-\-mask\fP
.INDENT 0.0
.INDENT 3.5
Displays the results of the report with sensitive data masked by a hash.
.UNINDENT
.UNINDENT
.SS Viewing the Insights Report
.sp
The \fBQPC_VAR_PROGRAM_NAME report insights\fP command retrieves a report that contains the hosts to be uploaded to the subscription insights service. A \fIhost\fP is the set of system, product, and entitlement facts for a particular physical or virtual machine.
Expand Down Expand Up @@ -721,7 +707,7 @@ Optional. Sets the path to a file location where the report data is saved. The f
.sp
The \fBQPC_VAR_PROGRAM_NAME report download\fP command downloads a set of reports, identified either by scan job identifer or report identifier, as a TAR.GZ file. The report TAR.GZ file contains the details and deployments reports in both their JSON and CSV formats.
.sp
\fBQPC_VAR_PROGRAM_NAME report download (\-\-scan\-job\fP \fIscan_job_identifier\fP \fB|\fP \fB\-\-report\fP \fIreport_identifier\fP \fB)\fP \fB\-\-output\-file\fP \fIpath\fP \fB[\-\-mask]\fP
\fBQPC_VAR_PROGRAM_NAME report download (\-\-scan\-job\fP \fIscan_job_identifier\fP \fB|\fP \fB\-\-report\fP \fIreport_identifier\fP \fB)\fP \fB\-\-output\-file\fP \fIpath\fP
.sp
\fB\-\-scan\-job=scan_job_identifier\fP
.INDENT 0.0
Expand All @@ -743,13 +729,6 @@ Contains the report identifier to use to download the reports. Mutually exclusiv
Required. Sets the path to a file location where the report data is saved. The file extension must be \fB\&.tar.gz\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-\-mask\fP
.INDENT 0.0
.INDENT 3.5
Download the reports with sensitive data masked by a hash.
.UNINDENT
.UNINDENT
.SS Merging Scan Job Results
.sp
The \fBQPC_VAR_PROGRAM_NAME report merge\fP command merges report data and returns the report identifier of the merged report. You can use this report identifier and the \fBQPC_VAR_PROGRAM_NAME report\fP command with the \fBdetails\fP or \fBdeployments\fP subcommands to retrieve a report from the merged results.
Expand Down
18 changes: 3 additions & 15 deletions docs/_build/man-qpc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -490,7 +490,7 @@ Viewing the Details Report

The ``qpc report details`` command retrieves a detailed report that contains the unprocessed facts that are gathered during a scan. These facts are the raw output from Network, vCenter, Satellite, Openshift, Red Hat Advanced Cluster Security and Ansible scans, as applicable.

**qpc report details (--scan-job** *scan_job_identifier* **|** **--report** *report_identifier* **)** **(--json|--csv)** **--output-file** *path* **[--mask]**
**qpc report details (--scan-job** *scan_job_identifier* **|** **--report** *report_identifier* **)** **(--json|--csv)** **--output-file** *path*

``--scan-job=scan_job_identifier``

Expand All @@ -512,18 +512,14 @@ The ``qpc report details`` command retrieves a detailed report that contains the

Optional. Sets the path to a file location where the report data is saved. The file extension must be ``.json`` for the JSON report or ``.csv`` for the CSV report. When the field is not provided and `--json` specified, a JSON report will be generated to stdout.

``--mask``

Displays the results of the report with sensitive data masked by a hash.

Viewing the Deployments Report
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``qpc report deployments`` command retrieves a report that contains the processed fingerprints from a scan. A *fingerprint* is the set of system, product, and entitlement facts for a particular physical or virtual machine. A processed fingerprint results from a procedure that merges facts from various sources, and, when possible, deduplicates redundant systems.

For example, the raw facts of a scan that includes both Network and vCenter sources could show two instances of a machine, indicated by an identical MAC address. The deployments report results in a deduplicated and merged fingerprint that shows both the Network and vCenter facts for that machine as a single set.

**qpc report deployments (--scan-job** *scan_job_identifier* **|** **--report** *report_identifier* **)** **(--json|--csv)** **--output-file** *path* **[--mask]**
**qpc report deployments (--scan-job** *scan_job_identifier* **|** **--report** *report_identifier* **)** **(--json|--csv)** **--output-file** *path*

``--scan-job=scan_job_identifier``

Expand All @@ -545,10 +541,6 @@ For example, the raw facts of a scan that includes both Network and vCenter sour

Optional. Sets the path to a file location where the report data is saved. The file extension must be ``.json`` for the JSON report or ``.csv`` for the CSV report. When the field is not provided and `--json` specified, a JSON report will be generated to stdout.

``--mask``

Displays the results of the report with sensitive data masked by a hash.

Viewing the Insights Report
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -574,7 +566,7 @@ Downloading Reports

The ``qpc report download`` command downloads a set of reports, identified either by scan job identifer or report identifier, as a TAR.GZ file. The report TAR.GZ file contains the details and deployments reports in both their JSON and CSV formats.

**qpc report download (--scan-job** *scan_job_identifier* **|** **--report** *report_identifier* **)** **--output-file** *path* **[--mask]**
**qpc report download (--scan-job** *scan_job_identifier* **|** **--report** *report_identifier* **)** **--output-file** *path*

``--scan-job=scan_job_identifier``

Expand All @@ -588,10 +580,6 @@ The ``qpc report download`` command downloads a set of reports, identified eithe

Required. Sets the path to a file location where the report data is saved. The file extension must be ``.tar.gz``.

``--mask``

Download the reports with sensitive data masked by a hash.

Merging Scan Job Results
~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
27 changes: 3 additions & 24 deletions docs/_build/qpc.1
Original file line number Diff line number Diff line change
Expand Up @@ -599,7 +599,7 @@ Use the \fBqpc report\fP command to retrieve a report from a scan. You can retri
.sp
The \fBqpc report details\fP command retrieves a detailed report that contains the unprocessed facts that are gathered during a scan. These facts are the raw output from Network, vCenter, Satellite, Openshift, Red Hat Advanced Cluster Security and Ansible scans, as applicable.
.sp
\fBqpc report details (\-\-scan\-job\fP \fIscan_job_identifier\fP \fB|\fP \fB\-\-report\fP \fIreport_identifier\fP \fB)\fP \fB(\-\-json|\-\-csv)\fP \fB\-\-output\-file\fP \fIpath\fP \fB[\-\-mask]\fP
\fBqpc report details (\-\-scan\-job\fP \fIscan_job_identifier\fP \fB|\fP \fB\-\-report\fP \fIreport_identifier\fP \fB)\fP \fB(\-\-json|\-\-csv)\fP \fB\-\-output\-file\fP \fIpath\fP
.sp
\fB\-\-scan\-job=scan_job_identifier\fP
.INDENT 0.0
Expand Down Expand Up @@ -635,20 +635,13 @@ Displays the results of the report in CSV format. Mutually exclusive with the \f
Optional. Sets the path to a file location where the report data is saved. The file extension must be \fB\&.json\fP for the JSON report or \fB\&.csv\fP for the CSV report. When the field is not provided and \fI\-\-json\fP specified, a JSON report will be generated to stdout.
.UNINDENT
.UNINDENT
.sp
\fB\-\-mask\fP
.INDENT 0.0
.INDENT 3.5
Displays the results of the report with sensitive data masked by a hash.
.UNINDENT
.UNINDENT
.SS Viewing the Deployments Report
.sp
The \fBqpc report deployments\fP command retrieves a report that contains the processed fingerprints from a scan. A \fIfingerprint\fP is the set of system, product, and entitlement facts for a particular physical or virtual machine. A processed fingerprint results from a procedure that merges facts from various sources, and, when possible, deduplicates redundant systems.
.sp
For example, the raw facts of a scan that includes both Network and vCenter sources could show two instances of a machine, indicated by an identical MAC address. The deployments report results in a deduplicated and merged fingerprint that shows both the Network and vCenter facts for that machine as a single set.
.sp
\fBqpc report deployments (\-\-scan\-job\fP \fIscan_job_identifier\fP \fB|\fP \fB\-\-report\fP \fIreport_identifier\fP \fB)\fP \fB(\-\-json|\-\-csv)\fP \fB\-\-output\-file\fP \fIpath\fP \fB[\-\-mask]\fP
\fBqpc report deployments (\-\-scan\-job\fP \fIscan_job_identifier\fP \fB|\fP \fB\-\-report\fP \fIreport_identifier\fP \fB)\fP \fB(\-\-json|\-\-csv)\fP \fB\-\-output\-file\fP \fIpath\fP
.sp
\fB\-\-scan\-job=scan_job_identifier\fP
.INDENT 0.0
Expand Down Expand Up @@ -684,13 +677,6 @@ Displays the results of the report in CSV format. Mutually exclusive with the \f
Optional. Sets the path to a file location where the report data is saved. The file extension must be \fB\&.json\fP for the JSON report or \fB\&.csv\fP for the CSV report. When the field is not provided and \fI\-\-json\fP specified, a JSON report will be generated to stdout.
.UNINDENT
.UNINDENT
.sp
\fB\-\-mask\fP
.INDENT 0.0
.INDENT 3.5
Displays the results of the report with sensitive data masked by a hash.
.UNINDENT
.UNINDENT
.SS Viewing the Insights Report
.sp
The \fBqpc report insights\fP command retrieves a report that contains the hosts to be uploaded to the subscription insights service. A \fIhost\fP is the set of system, product, and entitlement facts for a particular physical or virtual machine.
Expand Down Expand Up @@ -721,7 +707,7 @@ Optional. Sets the path to a file location where the report data is saved. The f
.sp
The \fBqpc report download\fP command downloads a set of reports, identified either by scan job identifer or report identifier, as a TAR.GZ file. The report TAR.GZ file contains the details and deployments reports in both their JSON and CSV formats.
.sp
\fBqpc report download (\-\-scan\-job\fP \fIscan_job_identifier\fP \fB|\fP \fB\-\-report\fP \fIreport_identifier\fP \fB)\fP \fB\-\-output\-file\fP \fIpath\fP \fB[\-\-mask]\fP
\fBqpc report download (\-\-scan\-job\fP \fIscan_job_identifier\fP \fB|\fP \fB\-\-report\fP \fIreport_identifier\fP \fB)\fP \fB\-\-output\-file\fP \fIpath\fP
.sp
\fB\-\-scan\-job=scan_job_identifier\fP
.INDENT 0.0
Expand All @@ -743,13 +729,6 @@ Contains the report identifier to use to download the reports. Mutually exclusiv
Required. Sets the path to a file location where the report data is saved. The file extension must be \fB\&.tar.gz\fP\&.
.UNINDENT
.UNINDENT
.sp
\fB\-\-mask\fP
.INDENT 0.0
.INDENT 3.5
Download the reports with sensitive data masked by a hash.
.UNINDENT
.UNINDENT
.SS Merging Scan Job Results
.sp
The \fBqpc report merge\fP command merges report data and returns the report identifier of the merged report. You can use this report identifier and the \fBqpc report\fP command with the \fBdetails\fP or \fBdeployments\fP subcommands to retrieve a report from the merged results.
Expand Down
18 changes: 3 additions & 15 deletions docs/source/man-template.rst
Original file line number Diff line number Diff line change
Expand Up @@ -490,7 +490,7 @@ Viewing the Details Report

The ``QPC_VAR_PROGRAM_NAME report details`` command retrieves a detailed report that contains the unprocessed facts that are gathered during a scan. These facts are the raw output from Network, vCenter, Satellite, Openshift, Red Hat Advanced Cluster Security and Ansible scans, as applicable.

**QPC_VAR_PROGRAM_NAME report details (--scan-job** *scan_job_identifier* **|** **--report** *report_identifier* **)** **(--json|--csv)** **--output-file** *path* **[--mask]**
**QPC_VAR_PROGRAM_NAME report details (--scan-job** *scan_job_identifier* **|** **--report** *report_identifier* **)** **(--json|--csv)** **--output-file** *path*

``--scan-job=scan_job_identifier``

Expand All @@ -512,18 +512,14 @@ The ``QPC_VAR_PROGRAM_NAME report details`` command retrieves a detailed report

Optional. Sets the path to a file location where the report data is saved. The file extension must be ``.json`` for the JSON report or ``.csv`` for the CSV report. When the field is not provided and `--json` specified, a JSON report will be generated to stdout.

``--mask``

Displays the results of the report with sensitive data masked by a hash.

Viewing the Deployments Report
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``QPC_VAR_PROGRAM_NAME report deployments`` command retrieves a report that contains the processed fingerprints from a scan. A *fingerprint* is the set of system, product, and entitlement facts for a particular physical or virtual machine. A processed fingerprint results from a procedure that merges facts from various sources, and, when possible, deduplicates redundant systems.

For example, the raw facts of a scan that includes both Network and vCenter sources could show two instances of a machine, indicated by an identical MAC address. The deployments report results in a deduplicated and merged fingerprint that shows both the Network and vCenter facts for that machine as a single set.

**QPC_VAR_PROGRAM_NAME report deployments (--scan-job** *scan_job_identifier* **|** **--report** *report_identifier* **)** **(--json|--csv)** **--output-file** *path* **[--mask]**
**QPC_VAR_PROGRAM_NAME report deployments (--scan-job** *scan_job_identifier* **|** **--report** *report_identifier* **)** **(--json|--csv)** **--output-file** *path*

``--scan-job=scan_job_identifier``

Expand All @@ -545,10 +541,6 @@ For example, the raw facts of a scan that includes both Network and vCenter sour

Optional. Sets the path to a file location where the report data is saved. The file extension must be ``.json`` for the JSON report or ``.csv`` for the CSV report. When the field is not provided and `--json` specified, a JSON report will be generated to stdout.

``--mask``

Displays the results of the report with sensitive data masked by a hash.

Viewing the Insights Report
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -574,7 +566,7 @@ Downloading Reports

The ``QPC_VAR_PROGRAM_NAME report download`` command downloads a set of reports, identified either by scan job identifer or report identifier, as a TAR.GZ file. The report TAR.GZ file contains the details and deployments reports in both their JSON and CSV formats.

**QPC_VAR_PROGRAM_NAME report download (--scan-job** *scan_job_identifier* **|** **--report** *report_identifier* **)** **--output-file** *path* **[--mask]**
**QPC_VAR_PROGRAM_NAME report download (--scan-job** *scan_job_identifier* **|** **--report** *report_identifier* **)** **--output-file** *path*

``--scan-job=scan_job_identifier``

Expand All @@ -588,10 +580,6 @@ The ``QPC_VAR_PROGRAM_NAME report download`` command downloads a set of reports,

Required. Sets the path to a file location where the report data is saved. The file extension must be ``.tar.gz``.

``--mask``

Download the reports with sensitive data masked by a hash.

Merging Scan Job Results
~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit 27bdce9

Please sign in to comment.