docs(core): Indicate dependency install scripts should be run with elevated privileges. #637
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
WalkthroughThe documentation for dependency installation guides across multiple Linux distributions (CentOS Stream 9, Ubuntu Focal, and Ubuntu Jammy) has been updated to explicitly clarify the requirement for elevated privileges when executing installation commands. The changes emphasize the need for users to run installation scripts with administrative rights, ensuring clear instructions for system dependency setup. Changes
The changes are consistent across the documentation files, focusing on improving clarity about administrative access requirements during dependency installation processes. Tip CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (3)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/src/dev-guide/components-core/ubuntu-jammy-deps-install.md (1)
13-13: LGTM! Consider adding an example with sudoThe addition of "with elevated privileges" improves clarity. However, consider adding an example command with
sudoto make it even clearer, similar to how you tested it.-To install all dependencies, run with elevated privileges: +To install all dependencies, run with elevated privileges: + +```shell +sudo ./components/core/tools/scripts/lib_install/ubuntu-jammy/install-all.sh +``` + +Or without sudo if you are already root:docs/src/dev-guide/components-core/ubuntu-focal-deps-install.md (1)
Line range hint
21-27: Add privilege requirement clarification for GCC setupThe GCC setup section should also clarify the need for elevated privileges, as
update-alternativesrequires root access.-Enable GCC 10 as the default compiler by running: +Enable GCC 10 as the default compiler by running with elevated privileges: ```shell -update-alternatives --set cc /usr/bin/gcc-10 -update-alternatives --set c++ /usr/bin/g++-10 -update-alternatives --set cpp /usr/bin/cpp-10 +sudo update-alternatives --set cc /usr/bin/gcc-10 +sudo update-alternatives --set c++ /usr/bin/g++-10 +sudo update-alternatives --set cpp /usr/bin/cpp-10</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between ddba9b95eeb3cfb9ccb3d8401d1610d42f0e3aad and 8ec3b5cb46d147e5adee461aab3e7d6414b79c93. </details> <details> <summary>📒 Files selected for processing (3)</summary> * `docs/src/dev-guide/components-core/centos-stream-9-deps-install.md` (1 hunks) * `docs/src/dev-guide/components-core/ubuntu-focal-deps-install.md` (1 hunks) * `docs/src/dev-guide/components-core/ubuntu-jammy-deps-install.md` (1 hunks) </details> <details> <summary>✅ Files skipped from review due to trivial changes (1)</summary> * docs/src/dev-guide/components-core/centos-stream-9-deps-install.md </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
docs/src/dev-guide/components-core/ubuntu-focal-deps-install.md
Outdated
Show resolved
Hide resolved
kirkrodrigues
requested changes
Dec 15, 2024
| @@ -10,7 +10,7 @@ Before you run any commands below, you should review the scripts to ensure they | |||
| any dependencies or apply any configurations that you don't expect. | |||
| ::: | |||
|
|
|||
| To install all dependencies, run: | |||
| To install all dependencies, run with elevated privileges: | |||
There was a problem hiding this comment.
Suggested change
| To install all dependencies, run with elevated privileges: | |
| To install all dependencies, run the following with elevated privileges: |
Ditto for others.
jackluo923
changed the title
kirkrodrigues
changed the title
kirkrodrigues
approved these changes
Dec 16, 2024
davidlion
pushed a commit
to Bill-hbrhbr/clp
that referenced
this pull request
Dec 20, 2024
…evated privileges. (y-scope#637)
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.
Description
Improve docs for dependency installation for ubuntu and centos by mentioning that elevated privileges is required during installation.
Validation performed
Tested
components/core/tools/scripts/lib_install/ubuntu-focal/install-all.shcommand withsudoprefix and dependency installation worked.Summary by CodeRabbit