diff options
| author | Craig Jennings <c@cjennings.net> | 2026-05-24 16:13:01 -0500 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2026-05-24 16:13:01 -0500 |
| commit | 2d83f8f55977dbf69f4f80e490ed0b96aeea4eee (patch) | |
| tree | 32c5ad0e360e0e15fed1ec83cd967991149b5cc3 /modules/user-constants.el | |
| parent | 9a0560e87867dc2a23767f66940ba4fb4d5a5c20 (diff) | |
| download | dotemacs-2d83f8f55977dbf69f4f80e490ed0b96aeea4eee.tar.gz dotemacs-2d83f8f55977dbf69f4f80e490ed0b96aeea4eee.zip | |
docs(load-graph): seed module inventory and annotate foundation headers
I started the init.el load-graph classification with the foundation batch. I added docs/design/module-inventory.org as the living per-module inventory and annotated the seven foundation modules (system-lib, user-constants, host-environment, system-defaults, keyboard-compat, keybindings, config-utilities) with the load-graph header contract: layer, category, load shape, eager reason, top-level side effects, runtime requires, and direct-test-load safety.
I changed no load order, so init.el keeps its current eager order. The inventory records one hidden dependency for Phase 2: system-defaults uses host-environment and user-constants symbols at load while declaring them eval-when-compile, so the compiled module cannot load standalone.
Diffstat (limited to 'modules/user-constants.el')
| -rw-r--r-- | modules/user-constants.el | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/modules/user-constants.el b/modules/user-constants.el index 2cc4a50c..293bc806 100644 --- a/modules/user-constants.el +++ b/modules/user-constants.el @@ -1,7 +1,17 @@ ;;; user-constants.el --- User Constants -*- lexical-binding: t; coding: utf-8; -*- ;; author: Craig Jennings <c@cjennings.net> ;;; Commentary: - +;; +;; Layer: 1 (Foundation). +;; Category: F. +;; Load shape: eager. +;; Eager reason: defines the path constants referenced across the config and +;; creates the required directories/files before other modules load. +;; Top-level side effects: file writes — creates configured directories and +;; stub files via `cj/initialize-user-directories-and-files' at load. +;; Runtime requires: none. +;; Direct test load: conditional (touches the filesystem on load). +;; ;; This module defines important file and directory paths used throughout the ;; Emacs configuration, and ensures they exist during startup. ;; |
