https://github.com/blitz/kernel-dev

Instant Linux kernel development environments via Nix devShells
https://github.com/blitz/kernel-dev

flakes linux nix rust

Last synced: 1 day ago
JSON representation

Instant Linux kernel development environments via Nix devShells

• Host: GitHub
• URL: https://github.com/blitz/kernel-dev
• Owner: blitz
• License: mit
• Created: 2024-03-25T14:37:11.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-10-24T13:29:03.000Z (14 days ago)
• Last Synced: 2024-10-24T20:39:04.855Z (14 days ago)
• Topics: flakes, linux, nix, rust
• Language: Nix
• Homepage:
• Size: 32.2 KB
• Stars: 12
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Linux Kernel Development Environment via Nix

Welcome to a streamlined Linux kernel development setup using Nix

flakes. This project simplifies the process of setting up a

development environment for the Linux kernel, ensuring that you have

all the necessary dependencies, including specific versions of Rust

and bindgen, preinstalled in a devShell.

## Quick Start

Getting started with your kernel development environment is incredibly

simple. If you're aiming to develop for Linux version 6.8, all you

need is a single command:

```shell

linux$ nix develop github:blitz/kernel-dev#linux_6_8

```

This will drop you into a shell with all the dependencies required for

working on the Linux 6.8 kernel preinstalled.

### Features

- **Simplicity**: Forget about the hassle of managing multiple

  dependencies and their versions. One command is all it takes.

- **Reproducibility**: With Nix flakes, your development environment

  is reproducible, ensuring that your setup is always consistent and

  predictable.

- **Version-specific environments**: Tailored development environments

  for specific Linux kernel versions, starting with Linux 6.8.

- **Rust and LLVM-enabled**: Ready for the future of kernel development!

### Requirements

- Nix package manager with flake support enabled.

## Usage

To start developing for a different version of the Linux kernel, use

the following pattern, replacing linux_6_8 with the target version

(note: versions are added based on community contributions and

demand):

```shell

$ nix develop github:blitz/kernel-dev#linux__

```

This will drop you in a shell with `clang` and `rustc` matching the

kernel version. If you need a `gcc`-based environment, use:

```shell

$ nix develop github:blitz/kernel-dev#linux___gcc

```

If you don't find the exact version that you need, one that is close

_might_ work as well.

## Contributing

Contributions are welcome! Whether it's adding support for new kernel

versions, improving the setup process, or documentation - feel free to

fork the project and submit a pull request.

## License

This project is open source and available under the MIT License.