doc: Be consistent with use of the "sudo" - v2 #9568
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Included the "sudo" command to commands that need to be executed with the super-user privilege.
- Added `Important` notes to inform users the `sudo` command is required to be installed in order to properly follow instructions. Ticket [5720](https://redmine.openinfosecfoundation.org/issues/5720)
|
NOTE: This PR may contain new authors: |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #9568 +/- ##
==========================================
- Coverage 82.20% 82.20% -0.01%
==========================================
Files 968 968
Lines 274275 274275
==========================================
- Hits 225461 225460 -1
- Misses 48814 48815 +1
Flags with carried forward coverage won't be shown. Click here to find out more. |
inashivb
requested changes
Oct 6, 2023
There was a problem hiding this comment.
Hi!
Thank you for your first contribution to our project. :)
- I believe the changes requested in the previous PR here: Install: Be consistent with use of the "sudo" - v1 #9552 (comment) are yet to be incorporated in this one.
- Please keep your commit history clean.
jasonish
reviewed
Oct 6, 2023
| @@ -90,18 +90,20 @@ Rust support:: | |||
| Ubuntu/Debian | |||
| """"""""""""" | |||
|
|
|||
| .. Important:: The following instructions require `sudo` be installed. | |||
There was a problem hiding this comment.
This doesn't appear to be a valid Sphinx directive, whereas .. note:: is. I think we want note.
There was a problem hiding this comment.
I found it on a link(rst docs on sourceforge) I was directed to via Sphinx's docs.
And I saw that .. Important:: defines that the instruction has to be followed for the work to be successful.
But I'll change it to .. note:: now.
Thanks.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Make sure these boxes are signed before submitting your Pull Request -- thank you.
Link to redmine ticket: https://redmine.openinfosecfoundation.org/issues/5720
Previous PR: #9552
Describe changes:
Importantnotes to inform users it is required to installsudoin order to successfully follow instructions.sudocommands added to some instructions wheresudowas not needed.