Skip to content

nixos/boot.kernelPatches: description update #392641

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

2hexed
Copy link
Member

@2hexed 2hexed commented Mar 24, 2025

can we remove the big chunk of example as isn't formatted correctly on the search page and we already show it as an example

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.

can we remove the big chunk of example as isn't [formatted correctly](https://search.nixos.org/options?channel=24.11&show=boot.kernelPatches&from=0&size=50&sort=relevance&type=packages&query=kernel+parameters) on the search page and we already show it as an example
@github-actions github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. labels Mar 24, 2025
@2hexed 2hexed requested a review from K900 March 25, 2025 19:56
@K900
Copy link
Contributor

K900 commented Mar 26, 2025

It would be nice to move the description of the options into the example then.

@2hexed
Copy link
Member Author

2hexed commented Mar 26, 2025

It would be nice to move the description of the options into the example then.

I agree, and it is already in the example which was also the reason why I removed it from the description, does everything with my PR look alright :D

@K900
Copy link
Contributor

K900 commented Mar 26, 2025

No it isn't? The example doesn't have a full description of all possible suboptions.

added possible options as well as their description in the "description" section
@2hexed
Copy link
Member Author

2hexed commented Mar 26, 2025

No it isn't? The example doesn't have a full description of all possible suboptions.

So I'm not very good with kernelPatches option yet and don't know what options are available, so instead I improved the old description just formatted it in a better way, is that alright?

@nixpkgs-ci nixpkgs-ci bot added the 2.status: merge conflict This PR has merge conflicts with the target branch label Aug 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.status: merge conflict This PR has merge conflicts with the target branch 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants