From de80d27d34d372ca8d39589df1173760ea9ccd9c Mon Sep 17 00:00:00 2001 From: CyberLeo Date: Sun, 20 Feb 2011 01:31:15 -0600 Subject: [PATCH] docs: documentation goes here --- docs/spec | 38 ++++++++++++++++++++++++++++++++++++++ todo => docs/todo | 0 2 files changed, 38 insertions(+) create mode 100644 docs/spec rename todo => docs/todo (100%) diff --git a/docs/spec b/docs/spec new file mode 100644 index 0000000..abfcfa2 --- /dev/null +++ b/docs/spec @@ -0,0 +1,38 @@ +docs/ - Project documentation + spec - Specification +script/ - Build scripts + lib/ - Script libraries (shlib compatible) + burn - Burn a firmware to a card (uses misc/clpbar for status) + gencard - Assemble everything into a card image + geniso - Assemble root filesystem into an iso9660 image (requires sysutils/cdrtools) + gentree - Assemble filesystem from world, pkgs, and overlay; carve out confpacks + genufs - Create a UFS filesystem and populate it with files (superseded by makefs) + genuzip - Compress iso9660 image into geom_uzip image + loadconf - I'm not sure... + makepkg - Libraries to build packages against a specific world + makeworld - Script to build a world from a seed and src + push - Push source tree to build server (requires net/rsync) +src/ - Going away +targets/ - Contains system targets + amd64/ - Arch-specific targets + GENERIC/ - Generic target, relies on worlds/amd64/GENERIC + i386/ - Arch-specific targets + GENERIC/ - Generic target, relies on worlds/i386/GENERIC +worlds/ - Contains worlds (config and root tree of a given base system build) + amd64/ - Arch-specific worlds + GENERIC/ - Generic world (Empty src.conf, GENERIC kernel config file) + i386/ - Arch-specific worlds + GENERIC/ - Generic world (Empty src.conf, GENERIC kernel config file) +seed/ - Contains seed builds for building a world + base/ - Location of base tarballs + amd64/ - Arch-specific seed + i386/ - Arch-specific seed + distfiles/ - Distfile tarballs for port builds +Makefile - Makefile to build it all + + +seed/ is used to seed the initial chroot for building a world. + +A world is a set of config files (src.conf, kernconf) that generates a particular base system build, along with the base system build generated by those config files. These are built off of whatever is in /usr/src at the moment. + +A target is a set of config files (make.conf, leaf_ports, port_options) and a system overlay that takes a given world and transforms it into a viable system, which is then carved up and packaged into a firmware. diff --git a/todo b/docs/todo similarity index 100% rename from todo rename to docs/todo -- 2.42.0