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

nixos/doc: Fix outdated references in the NixOS manual #391626

Merged
merged 1 commit into from
Mar 25, 2025

Conversation

OluchiTheAnalyst
Copy link

@OluchiTheAnalyst OluchiTheAnalyst commented Mar 20, 2025

Fixed outdated references in the NixOS Manual

The previous manual contained outdated references to 'make' and incorrect shell prompts.
This commit updates the formatting to improve readability and ensure accuracy.

Fixes:
Fixed outdated references from make to devmode, corrected shell prompts from nix-shell$ to [nix-shell:~]$

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 25.05 Release Notes (or backporting 24.11 and 25.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

@github-actions github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: documentation This PR adds or changes documentation labels Mar 20, 2025
@OluchiTheAnalyst
Copy link
Author

hello @fricklerhandwerk please could you review this?

@NixOSInfra NixOSInfra added the 12. first-time contribution This PR is the author's first one; please be gentle! label Mar 20, 2025
@github-actions github-actions bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 labels Mar 20, 2025
Copy link
Contributor

@drupol drupol left a comment

Choose a reason for hiding this comment

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

Hello!

Congratulations for your first PR !

I added a minor comment, also, make sure to format the PR title according to the user contributor guide, the commit messages should also be reworked accordingly.

@OluchiTheAnalyst OluchiTheAnalyst changed the title Fix nixos manual Fix outdated references and formatting inconsistencies Mar 22, 2025
Copy link
Contributor

@drupol drupol left a comment

Choose a reason for hiding this comment

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

The commit log messages of your commits are not really formatted correctly and must be updated. Have you checked the contributing guide? Have a look at other PR to get some inspiration. Thanks.

@OluchiTheAnalyst
Copy link
Author

Hi @drupol I have gone through the commit convention. when you say "commits are not really formatted" do you mean i should remove whitespaces?

nixpkgs Outdated
@@ -0,0 +1 @@
Subproject commit b64ec1944ea40d9f3920f938e17ed39a9978c6c7
Copy link
Contributor

Choose a reason for hiding this comment

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

This seems to be an editing artifact that needs to go away.

Copy link
Author

Choose a reason for hiding this comment

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

@fricklerhandwerk Fixed! I removed the unintended submodule change. Thanks for catching that! Let me know if anything else needs adjustment

@OluchiTheAnalyst OluchiTheAnalyst force-pushed the fix-nixos-manual branch 2 times, most recently from 827f750 to fbbd029 Compare March 23, 2025 14:14
@OluchiTheAnalyst OluchiTheAnalyst changed the title Fix outdated references and formatting inconsistencies Doc: Fix outdated references in the NixOS manual Mar 23, 2025
@OluchiTheAnalyst
Copy link
Author

Hi @drupol I have gone through the commit convention. when you say "commits are not really formatted" do you mean i should remove whitespaces?

Thanks for the feedback @drupol I've updated the commit messages to follow the correct format. Please have a look at it and let me know if any further adjustments are needed.

@drupol
Copy link
Contributor

drupol commented Mar 24, 2025

Have a look at this PR to get some inspiration: #392831

@OluchiTheAnalyst OluchiTheAnalyst changed the title Doc: Fix outdated references in the NixOS manual nixos/doc: Fix outdated references in the NixOS manual Mar 25, 2025
@OluchiTheAnalyst
Copy link
Author

Have a look at this PR to get some inspiration: #392831

Hi @drupol fixed the commit log message, please have a look, thank you!

Copy link
Contributor

@drupol drupol left a comment

Choose a reason for hiding this comment

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

LGTM, thanks !

@wegank wegank added the 12.approvals: 1 This PR was reviewed and approved by one reputable person label Mar 25, 2025
@fricklerhandwerk fricklerhandwerk merged commit a6f14a6 into NixOS:master Mar 25, 2025
36 of 40 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: documentation This PR adds or changes documentation 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 12.approvals: 1 This PR was reviewed and approved by one reputable person 12. first-time contribution This PR is the author's first one; please be gentle!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants