Skip to content

[man] Document usernames and treat-certificates for sos clean - #4440

Open
suraj-cmd wants to merge 1 commit into
sosreport:mainfrom
suraj-cmd:man-document-clean-options
Open

[man] Document usernames and treat-certificates for sos clean#4440
suraj-cmd wants to merge 1 commit into
sosreport:mainfrom
suraj-cmd:man-document-clean-options

Conversation

@suraj-cmd

Copy link
Copy Markdown
Contributor

sos clean accepts --usernames and --treat-certificates but neither is
documented in sos-clean.1, sos-mask.1 or sos-report.1, so there is no man
page reference for either.

--treat-certificates in particular decides whether certificate files found in
an archive are obfuscated, kept, or removed before that archive is passed to a
third party, which is a decision users should be able to find documented.

This adds both to the synopsis and the option list, alongside the other
obfuscation inputs.

Follows the same gap found in #4430, where the S3 upload options were missing
from sos-report.1.


Please place an 'X' inside each '[]' to confirm you adhere to our Contributor Guidelines

  • Is the commit message split over multiple lines and hard-wrapped at 72 characters?
  • Is the subject and message clear and concise?
  • Does the subject start with [plugin_name] if submitting a plugin patch or a [section_name] if part of the core sosreport code?
  • Does the commit contain a Signed-off-by: First Lastname email@example.com?
  • Are any related Issues or existing PRs properly referenced via a Closes (Issue) or Resolved (PR) line?
  • Are all passwords or private data gathered by this PR obfuscated?

@suraj-cmd
suraj-cmd force-pushed the man-document-clean-options branch from 0835c68 to 9da3d3b Compare August 10, 2026 19:12
@packit-as-a-service

Copy link
Copy Markdown

Congratulations! One of the builds has completed. 🍾

You can install the built RPMs by following these steps:

  • sudo dnf install -y 'dnf*-command(copr)'
  • dnf copr enable packit/sosreport-sos-4440
  • And now you can install the packages.

Please note that the RPMs should be used only in a testing environment.

@pmoravec pmoravec added Reviewed/Needs 2nd Ack Require a 2nd ack from a maintainer Quick Change This is likely a quick/trivial code change Status/Needs Review This issue still needs a review from project members Kind/Obfuscation Fixes an Obfuscation issue Kind/Documentation Updates and Fixes documentation labels Aug 11, 2026
Comment thread man/en/sos-clean.1 Outdated
Comment on lines 11 to 14
[\-\-usernames]
[\-\-treat-certificates]
[\-\-map-file]
[\-\-jobs]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A nitpick (like in the previous PR, when we are doing a change..): can you please add here -j short variant of the --jobs as well? My eyes spotted it is missing here as well..

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pmoravec oops i missed that let me fix that in one min please stay with me

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pmoravec its done now !!! can we gohead and merge ?

sos clean accepts --usernames and --treat-certificates but
neither is documented in sos-clean.1, sos-mask.1 or
sos-report.1, so there is no man page reference for either.

--treat-certificates in particular decides whether certificate
files found in an archive are obfuscated, kept, or removed
before that archive is passed to a third party, which is a
decision users should be able to find documented.

Add both to the synopsis and the option list, alongside the
other obfuscation inputs.

Signed-off-by: Suraj Patil <surajpatil522@gmail.com>
@suraj-cmd
suraj-cmd force-pushed the man-document-clean-options branch from 9da3d3b to 56d8925 Compare August 11, 2026 10:10
@pmoravec

Copy link
Copy Markdown
Contributor

ACK from me, let wait for 2nd approval to let us merge.

Thanks for the PR and nitpick fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Kind/Documentation Updates and Fixes documentation Kind/Obfuscation Fixes an Obfuscation issue Quick Change This is likely a quick/trivial code change Reviewed/Needs 2nd Ack Require a 2nd ack from a maintainer Status/Needs Review This issue still needs a review from project members

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants