kernel-janitor

Helper for building, installing, and cleaning kernel installations. Specifically made to deal with Gentoo although it shouldn't require it. The only dependency is the tooling you need to build the Linux kernel.

I could use sys-kernel/genkernel but instead I rolled my own. Originally it was fairly easy to build/install/cleanup but then I wanted to automate more. I wrote a script in Python that became beefier and now I'm rewriting it in Rust.

Usage

First, copy kernel-janitor-example.conf as to either ./kernel-janitor.conf or /etc/kernel-janitor.conf.

Examine the conf file to see that it matches your system. Once that's done, you can start using it.

List installed kernels

user $ cargo run --release -- --list

Pretend to execute upgrade and clean (dry-run)

user $ cargo run --release -- --pretend

Run upgrade and clean (must be root)

root $ cargo run --release

Run upgrade and clean, skip copying of config in case manual edits were made. Expects an updated .config to exist in the kernel source directory

root $ cargo run --release --manual-edit

Tasklist

• Implement kernel version ordering
  • tested
• Implement kernel version searching
  • use builder pattern to create configurable search
  • tested
• Parse command line input
  • handle flags
  • print out help
  • tested
• Parse config files
  • impl ini parsing
  • Parse entry
  • [ ] Parse section
    • not really needed
  • Parse file
  • Use enum to allow parse error, comment, entry
  • ignore comments
  • search for config files
  • tested
• Use try_main
  • reference https://benhoyt.com/writings/count-words/
• Handle parsing version from module names which won't have 'linux-' prepended
• impl InstalledItem and use it instead of a (KernelVersion, InstalledItemKind, PathBuf) tuple
• Verions that are old shouldn't expect source dirs or module dirs with .old on them
• update.rs
  • copy config
  • building kernel
  • gen grub cfg or run portage commands
  • Logic for deleting old kernels and related files
  • Check exit code of commands
  • tested
    • only tested manually so far, no unit tests
• Use program specific error class instead of Box<dyn std::error::Error>
  • using error::JanitorError
• If the latest version only has a source directory, that's fine since it'll happen whenever a new version is downloaded
  • is this still an issue?
  • Seems fixed
• Print subcommand output as it runs
• Create Command wrapper that allows for easier running of pretend
• Deal with symlinks in conf file search
• Grab HOME from environment variable, unsure why this wasn't working
• Actions should be optionally interactive
  • test
• Create macro for making a JanitorError with formatted input
  • a wrapper for format!
• Fix interactive prompt since it just hangs
• Interactive prompt doesn't execute for kenel deletions
• By default, run --pretend and then prompt for confirmation to run for real
• Allow for testing of interactive actions
  • use dependency injection to pass in stdin/stdout
• Allow deletion of specific kernel versions
  • just use a hash map that maps chars to InstalledKernels
• Only use a single config file in /etc/ since there shouldn't be per-user settings

Ideas

• Allow for using trash-cli or just moving files to trash folder
• Create move func that can move directories or files. Either copy and remove the content or use mv as a Command. Renaming won't work across mount points.
• Add getter for InstalledKernel that returns paths without options if none are missing