-
Notifications
You must be signed in to change notification settings - Fork 542
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Global] Update strings to align with sos
tooling names
#3666
Conversation
Congratulations! One of the builds has completed. 🍾 You can install the built RPMs by following these steps:
Please note that the RPMs should be used only in a testing environment. |
d74628c
to
6ed4184
Compare
What about changing the man pages? Thoughts on replacing
|
I think Similar point to
|
Didn't do the man pages yet, but would probably be good to include that in this change after all.
Yeah, leaving that there for legacy support currently. I think we would drop that at the same time we eventually drop the |
+1, worth adding a warning to be nice to users (for two releases / one year maybe? or just 1 release / 6m?), and drop it altogether with the binary redirection. |
+1 on deprecation warning and then getting rid; gives us time to update our internal documentation |
6ed4184
to
b9d0c9c
Compare
Updated with a new warning and removal date for the redirectors, also updated the man pages. |
msg = ("WARNING: the 'sosreport' command has been deprecated in favor " | ||
"of the new 'sos' command, E.G. 'sos report', and will be removed " | ||
"in the upcoming sos-4.9 release.\n" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a similar text to man/en/sosreport.1
as well? man sosreport
makes user to still feel nothing is changing..
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sosreport.1 is a symlink to man/en/sos-report.1
, so I hadn't considered adding something there. Could be worth a note in the description though for sure.
Sounds good otherwise! |
This commit serves to reinforce the typing of "sos (space) report" in place of the legacy "sosreport", and similarly updates items such as "sos-collector" to "sos collect". The tool is `sos` ("ess-oh-ess"), of which `report` and `collect` are sub-commands. The most visible change is the update to the line printed before the path to a generate sos report, which may be significant for scripts and/or automation. To be clear, this commit changes this line: `Your sosreport has been generated and saved in:` to `Your sos report has been generated and saved in:` Note that this does not change the use of `sosreport` when used as part of method names, nor does it change the *filename* of the generated archive for either `report` or `collect`. Signed-off-by: Jake Hunsaker <jacob.r.hunsaker@gmail.com>
b9d0c9c
to
f65ff7f
Compare
Updated with a new note in the manpages about the deprecation. |
This commit serves to reinforce the typing of "sos (space) report" in place of the legacy "sosreport", and similarly updates items such as "sos-collector" to "sos collect". The tool is
sos
("ess-oh-ess"), of whichreport
andcollect
are sub-commands.The most visible change is the update to the line printed before the path to a generate sos report, which may be significant for scripts and/or automation. To be clear, this commit changes this line:
Your sosreport has been generated and saved in:
to
Your sos report has been generated and saved in:
Note that this does not change the use of
sosreport
when used as part of method names, nor does it change the filename of the generated archive for eitherreport
orcollect
.Please place an 'X' inside each '[]' to confirm you adhere to our Contributor Guidelines