Skip to content
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

Fixed command line in upgrading-guide.md #65

Merged
merged 1 commit into from
Sep 18, 2024
Merged

Conversation

ericbsd
Copy link
Member

@ericbsd ericbsd commented Sep 18, 2024

Summary by Sourcery

Fix the command line instructions in the upgrading guide to ensure the correct use of 'sudo pkg upgrade' for upgrading processes.

Documentation:

  • Correct the command line instructions in the upgrading guide to use 'sudo pkg upgrade' instead of 'sudo pkg update'.

@ericbsd ericbsd requested review from a team as code owners September 18, 2024 10:35
Copy link
Contributor

sourcery-ai bot commented Sep 18, 2024

Reviewer's Guide by Sourcery

This pull request corrects the command line instructions in the upgrading guide documentation. It replaces 'pkg update' with 'pkg upgrade' in two instances to provide the correct command for system upgrades.

File-Level Changes

Change Details Files
Corrected the command for system upgrades from 'pkg update' to 'pkg upgrade'
  • Changed 'sudo pkg update -f' to 'sudo pkg upgrade -f' for kernel mismatch scenarios
  • Changed 'sudo pkg update' to 'sudo pkg upgrade' for non-kernel mismatch scenarios
source/user/upgrading-guide.md
Removed placeholder text for troubleshooting section
  • Deleted the line '[Content coming soon]' from the troubleshooting section
source/user/upgrading-guide.md

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ericbsd - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 2 issues found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

source/user/upgrading-guide.md Show resolved Hide resolved
@@ -87,16 +87,16 @@ If a similar message than the above one is encounter, **sudo pkg upgrade -f** mu
### Starting the upgrade
Run the command below if there is a kernel mismatch with **update -f**.
Copy link
Contributor

Choose a reason for hiding this comment

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

issue (documentation): There's a grammatical error in the unchanged text above this line.

The phrase 'If a similar message than the above one is encounter' should be corrected to 'If a similar message to the above one is encountered'.

@ericbsd ericbsd merged commit b4f1162 into master Sep 18, 2024
2 checks passed
@ericbsd ericbsd deleted the ericbsd-patch-1 branch September 18, 2024 10:37
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