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: add notes on additional drivers or firmware #168306

Merged
merged 1 commit into from
Apr 16, 2022

Conversation

flokli
Copy link
Contributor

@flokli flokli commented Apr 11, 2022

This describes how to build your own installer medium with some custom
firmware/drivers, using an Intel MacBook as an example - on which WiFi
doesn't work out of the box, due to it being nonfree.

Fixes #15162.

Things done
  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
  • 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/)
  • 22.05 Release Notes (or backporting 21.11 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
    • (Release notes changes) Ran nixos/doc/manual/md-to-db.sh to update generated release notes
  • Fits CONTRIBUTING.md.

Copy link
Member

@roberth roberth left a comment

Choose a reason for hiding this comment

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

This is a good addition.

installer, might want to need to extend these configurations.

For example, to build the GNOME graphical installer ISO, but with support for
certain WiFi adapters present in some MacBooks, you can create the following
Copy link
Member

Choose a reason for hiding this comment

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

It seems that we could provide this module profile as part of nixpkgs as well.

I guess you have two goals here

  • describe how to build a custom installer
  • help out macbook owners

Not sure what to do. Integrate the hardware repo?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The goal for this PR was mostly to document how to build an installer with some custom bits, yes - and using the macbook one as an example.

I explicitly didn't want to introduce this one profile. I'd be much more open to integrating nixos-hardware.

This has already been tried once, but reverted - see #91160 (comment) for details.

Maybe the RFC that has been opened as a followup should be resurrected: NixOS/rfcs#70.

IMHO, shipping these profiles in nixpkgs would be a huge UX benefit, and people would have plenty of examples for various types of hardware to take inspiration from :-)

Copy link
Member

Choose a reason for hiding this comment

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

I hope the RFC can be revived. I've made a small contribution.

Clearly this is out of scope, but I'll leave the conversation unresolved for discoverability later.

nixos/doc/manual/development/building-nixos.chapter.md Outdated Show resolved Hide resolved
This describes how to build your own installer medium with some custom
firmware/drivers, using an Intel MacBook as an example - on which WiFi
doesn't work out of the box, due to it being nonfree.

Fixes NixOS#15162.

Co-authored-by: Lucas Hoffmann <lucc@users.noreply.github.com>
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
@flokli flokli force-pushed the nixos-doc-installer-drivers branch from 8a9fb22 to 9ff1ab4 Compare April 12, 2022 10:43
@flokli flokli merged commit b2383b6 into NixOS:master Apr 16, 2022
@flokli flokli deleted the nixos-doc-installer-drivers branch April 16, 2022 13:03
flokli added a commit to flokli/nixpkgs that referenced this pull request Apr 16, 2022
This section mostly describes how to build various installer images, so
it fits better in that chapter.

Proposed in NixOS#168306 (comment)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing WiFi driver while installing NixOS 16.03 on my Mac Mini 7,1
3 participants