From 9e15b68b79fb967cc11fd9ce85ebc70c249417a3 Mon Sep 17 00:00:00 2001 From: NullBite Date: Sat, 30 Mar 2024 01:06:13 -0400 Subject: [PATCH] rename, update overlays/README.md --- overlays/README.md | 23 +++++++++++++++++------ overlays/{default.nix => mitigations.nix} | 0 2 files changed, 17 insertions(+), 6 deletions(-) rename overlays/{default.nix => mitigations.nix} (100%) diff --git a/overlays/README.md b/overlays/README.md index b359e1c..6d0258a 100644 --- a/overlays/README.md +++ b/overlays/README.md @@ -1,9 +1,20 @@ -# backports -This is a nixpkgs overlay that contains temporary fixes for build failures or -other issues, usually backported from the nixpkgs master branch. Each package -defined in this overlay shall automatically disable itself once a certain -condition is met, such as the upstream package being updated or the nixpkgs -modification date passing a certain time. +# Overlays +This directory contains nixpkgs overlays which each serve some specific purpose. + +## backports +This overlay defines programs that should be unconditionally backported from +nixpkgs-unstable. Packages backported in this overlay will be built using +inputs from the current system when possible, as to not unnecessarily increase +the closure size. This may result in unexpected breakages, as packages in +nixpkgs-unstable are built and tested against other such packages. + + +## mitigations +This overlay contains temporary fixes for build failures or other issues, +usually backported from the nixpkgs master branch. Each package defined in this +overlay shall automatically disable itself once a certain condition is met, +such as the upstream package being updated or the nixpkgs modification date +passing a certain time. This is in place because I am extremely forgetful; I will almost certainly forget to undo a temporary fix later, so this takes care of it for me. diff --git a/overlays/default.nix b/overlays/mitigations.nix similarity index 100% rename from overlays/default.nix rename to overlays/mitigations.nix