treewide: update comments and module descriptions

This commit is contained in:
Gabriel Arazas 2024-06-10 13:26:14 +08:00
parent 4590be0d3d
commit 3907d83781
No known key found for this signature in database
GPG Key ID: 62104B43D00AA360
10 changed files with 37 additions and 12 deletions

View File

@ -90,7 +90,9 @@
nix-index-database.url = "github:nix-community/nix-index-database"; nix-index-database.url = "github:nix-community/nix-index-database";
nix-index-database.inputs.nixpkgs.follows = "nixpkgs"; nix-index-database.inputs.nixpkgs.follows = "nixpkgs";
# Make a default.nix compatible stuff. # Make a default.nix compatible stuff. Take note, we're giving this a
# unique suffix since there are other flake inputs that uses the same flake
# and we want our `default.nix` to refer to our version.
flake-compat-fds.url = "https://flakehub.com/f/edolstra/flake-compat/1.tar.gz"; flake-compat-fds.url = "https://flakehub.com/f/edolstra/flake-compat/1.tar.gz";
# Someone had the idea to make the flake outputs be configured as a Nix # Someone had the idea to make the flake outputs be configured as a Nix

View File

@ -88,8 +88,8 @@ let
default = "nixpkgs"; default = "nixpkgs";
example = "nixos-unstable-small"; example = "nixos-unstable-small";
description = '' description = ''
The nixpkgs branch to be used for evaluating the NixOS configuration. The nixpkgs branch to be used for evaluating the home-manager
By default, it will use the `nixpkgs` flake input. configuration. By default, it will use the `nixpkgs` flake input.
::: {.note} ::: {.note}
This is based from your flake inputs and not somewhere else. If you This is based from your flake inputs and not somewhere else. If you

View File

@ -201,6 +201,7 @@ let
}; };
home-manager = { home-manager = {
# Extending it with more NixOS-specific user options.
users = lib.mkOption { users = lib.mkOption {
type = with lib.types; attrsOf (submodule homeManagerUserType); type = with lib.types; attrsOf (submodule homeManagerUserType);
}; };
@ -337,6 +338,9 @@ let
# overlay list is constructed. However, this is much more # overlay list is constructed. However, this is much more
# preferable than letting a massive list with duplicated # preferable than letting a massive list with duplicated
# overlays from different home-manager users to be applied. # overlays from different home-manager users to be applied.
#
# Anyways, all I'm saying is that this is a massive hack
# because it isn't correct.
lib.lists.unique overlays; lib.lists.unique overlays;
}) })
@ -549,9 +553,8 @@ in
( (
let let
deployConfig = cfg.configs.${name}.deploy; deployConfig = cfg.configs.${name}.deploy;
deployConfig' = lib.attrsets.removeAttrs deployConfig [ "profiles" ];
in in
deployConfig' deployConfig
// { // {
profiles = profiles =
cfg.configs.${name}.deploy.profiles { cfg.configs.${name}.deploy.profiles {

View File

@ -64,7 +64,6 @@ let
pkgs: with pkgs; [ pkgs: with pkgs; [
(wrapNeovim neovim-unwrapped { }) (wrapNeovim neovim-unwrapped { })
neovim-nightly neovim-nightly
neovide
] ]
''; '';
description = '' description = ''
@ -104,7 +103,8 @@ in
sharedModules = modulesOption // { sharedModules = modulesOption // {
description = '' description = ''
A list of NixVim modules to be shared across all of the NixVim A list of NixVim modules to be shared across all of the NixVim
configurations. configurations. This is also to be shared among wider-scoped
environments when NixVim-specific integrations has been enabled.
''; '';
}; };
standaloneConfigModules = modulesOption' "standalone configuration"; standaloneConfigModules = modulesOption' "standalone configuration";

View File

@ -1,3 +1,6 @@
# A deploy-rs submodule to be shared among other deploy-rs-related options in
# different environments. Take note this is supposed to be imported inside of a
# deploy-rs-related option, not in the top-level `configs` option.
{ lib, ... }: { { lib, ... }: {
options = { options = {
fastConnection = fastConnection =

View File

@ -9,6 +9,16 @@
default = [ ]; default = [ ];
description = '' description = ''
A list of workflows to be enabled. A list of workflows to be enabled.
Each workflow basically represents a way to interact with your computer
such as a typical complete desktop environment or a minimalistic desktop
featuring a standalone window manager with a custom status bar.
While there's no set convention as to what each workflow should be,
workflows usually contain a complete graphical session configured inside
of it. A couple of exceptions are, for example, a complete standalone
tmux configuration where it can be used inside of a TTY or something like
that.
''; '';
example = [ example = [
"a-happy-gnome" "a-happy-gnome"

View File

@ -21,6 +21,9 @@
}; };
# This is based from https://jackaudio.org/faq/linux_rt_config.html. # This is based from https://jackaudio.org/faq/linux_rt_config.html.
#
# Anyways, this enables several audio-related software requiring realtime
# scheduling to work such as Sonic Pi.
security.pam.loginLimits = [ security.pam.loginLimits = [
{ {
domain = "@audio"; domain = "@audio";

View File

@ -23,7 +23,7 @@
monaspace monaspace
jetbrains-mono jetbrains-mono
# Noto font family # Noto font family with the MR. WORLDWIDE settings.
noto-fonts noto-fonts
noto-fonts-cjk noto-fonts-cjk
noto-fonts-cjk-sans noto-fonts-cjk-sans

View File

@ -10,7 +10,8 @@
# Don't replace it mid-way! DON'T TURN LEFT!!!! # Don't replace it mid-way! DON'T TURN LEFT!!!!
security.protectKernelImage = true; security.protectKernelImage = true;
# Hardened config equals hardened kernel. # Hardened config equals hardened kernel equals hardened co--approval from the
# security-minded people.
boot.kernelPackages = lib.mkOverride 500 pkgs.linuxKernel.packages.linux_6_6_hardened; boot.kernelPackages = lib.mkOverride 500 pkgs.linuxKernel.packages.linux_6_6_hardened;
# Disable system console entirely. We don't need it so get rid of it. # Disable system console entirely. We don't need it so get rid of it.

View File

@ -8,13 +8,16 @@
"${modulesPath}/profiles/headless.nix" "${modulesPath}/profiles/headless.nix"
]; ];
# So does sounds... # Sounds? We don't need in this void world of OURS!
sound.enable = lib.mkDefault false; sound.enable = lib.mkDefault false;
# ...and Bluetooth because it's so insecure. # Bluetooth is so 2000s, my wireless earbuds are scratching all to hell.
hardware.bluetooth.enable = lib.mkDefault false; hardware.bluetooth.enable = lib.mkDefault false;
# And other devices... # You can draw from your imagination instead.
hardware.opentabletdriver.enable = lib.mkDefault false; hardware.opentabletdriver.enable = lib.mkDefault false;
# Printers? In our godforsaken headless setups. (Ok there are servers that
# handle this but you know...)
services.printing.enable = lib.mkDefault false; services.printing.enable = lib.mkDefault false;
} }