aboutsummaryrefslogtreecommitdiff
path: root/snag/readme.txt
diff options
context:
space:
mode:
authorJack Jamison <jackqjamison@gmail.com>2026-07-23 11:45:52 -0400
committerJack Jamison <jackqjamison@gmail.com>2026-07-23 11:45:52 -0400
commite207f7382cf23dcf88700dead255a41c817a0863 (patch)
treeba87940ac4cfd60ae80a0a194827a442997dd502 /snag/readme.txt
parenta682c2cdc499bdecab81e41200f4a28b08600bfb (diff)
clean up downloading and configure script
Diffstat (limited to 'snag/readme.txt')
-rw-r--r--snag/readme.txt22
1 files changed, 19 insertions, 3 deletions
diff --git a/snag/readme.txt b/snag/readme.txt
index d42d19c..c64ced7 100644
--- a/snag/readme.txt
+++ b/snag/readme.txt
@@ -13,7 +13,7 @@ why - list why this package is installed (manually installed, as a depe
## Important Directories
Package Database - /var/snag/pkgs/
-Install Database - /var/snag/state/
+Install Database - /var/snag/installs/
Download Database - /var/snag/downloads/
Logs/In Progress Builds - /var/snag/builds/
SNAG Configuration - /etc/snag/
@@ -31,7 +31,7 @@ Download Database - the directory where package downloads are stored and cac
- switch between cli and tui mode mid run
- build packages that aren't in the database
-## Package Description Format
+## Package Database and Description Format
Each package has a directory in the package database, named by its `id`.
Inside each package directory is the description script named `{id}.sh`
The description script should have functions for `configure`, `build`, and `install`
@@ -48,11 +48,27 @@ version - software version, in whatever format is needed. commit hashes are allo
### Snag Shell API
TBD
-## Install Description Format
+## Download Database
+TBD
+
+## Build Database
+Each build iteration gets its own directory in the build database, named "id-version-time".
+A symlink named "id-latest" will point to the newest build for that package.
+The build iteration directory contains:
+- the package source trees (if applicable)
+- a copy of the package description directory
+- the build logs
+- an executable script to rebuild
+
+## Install Database and Description Format
TBD. Will contain at least:
- date installed
- flists
- install reason
+- link to the build iteration directory
## Developer Subcommands
`validate` - check a package description and check for format errors or warnings
+
+
+https://www.labri.fr/perso/nrougier/GTD/index.html#orgfb65d8f