Skip to content

[man] Enhance sos-report.1 and sos-collect.1 by new options - #4441

Open
pmoravec wants to merge 1 commit into
sosreport:mainfrom
pmoravec:sos-pmoravec-man-missing-options
Open

[man] Enhance sos-report.1 and sos-collect.1 by new options#4441
pmoravec wants to merge 1 commit into
sosreport:mainfrom
pmoravec:sos-pmoravec-man-missing-options

Conversation

@pmoravec

Copy link
Copy Markdown
Contributor

Similarly like in #4430 and #4440, man pages miss some command line options added as a feature, but forgotten to be mentioned in man pages.

Further to that, mention --upload / --clean options there and refer to upload/clean component for their relevant options.

Closes: #4441


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?

Similarly like in sosreport#4430 and sosreport#4440, man pages miss some command line
options added as a feature, but forgotten to be mentioned in man pages.

Further to that, mention --upload / --clean options there and refer to
upload/clean component for their relevant options.

Closes: sosreport#4441

Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
@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-4441
  • And now you can install the packages.

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

@pmoravec

Copy link
Copy Markdown
Contributor Author

There is some discrepancy between "for upload/clean options, see man pages of sos-upload / sos-clean" versus "sos-collect lists each and every sos-report option, and duplicates the manual".

I try to follow the current approach that is not fully coherent. On the other side, sos collect is always coupled with sos report, so it makes sense to duplicate report's options in sos-collect manpages. Similarly, sos-report lists sos-upload options explicitly.

If you feel a different approach should be followed, let describe your idea.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant