release/picobsd/README.luigi

   1 In this file i try to document the overall architecture of PicoBSD
   2 source tree.
   3
   4     ./          Per-image directory-tree and generic trees.
   5
   6     build/      Main build scripts and Makefiles.
   7         build:  main build script
   8         stage1: invoked by build
   9         clean:  to clean up previous compilations
  10         Makefile.conf
  11                 makefile to edit config file and build kernel
  12         Makefile.mfs
  13                 makefile to create the memory filesystem
  14         Makefile.crunch
  15                 makefile to handle the crunched directory
  16         mfs.mtree
  17                 mtree cmd -- structure of the mfs tree
  18
  19     floppy.tree/
  20         Default files to fill the floppy and mfs trees.
  21         Can be overridden by listing files to be removed in
  22         ${TYPE}/floppy.tree.exclude, and putting files to be replaced
  23         in ${TYPE}/floppy.tree/
  24
  25     doc/
  26         documentation (unchanged from original)
  27
  28     help/
  29         help files in various languages. The suffix is the two letter
  30         country code for the language. Currently only .en and .pl
  31         used.
  32
  33     tinyware/
  34         various small programs used instead of the corresponding
  35         full-blown utilities.
  36
  37     $TYPE/      source and config files for the various image types.
  38
  39 Structure of each image type is as follows:
  40
  41     Makefile.mfs
  42         Makefile used to build/populate the MFS. Only needs two
  43         lines typically:
  44
  45         MY_DEVS=std ....
  46         .include "../build/Makefile.mfs"
  47
  48     PICOBSD
  49         kernel config file. One line is required
  50
  51             #PicoBSD  mfs_size init_name mfs_inodes floppy_inodes
  52         e.g.
  53             #PicoBSD  2400      init    4096    32768
  54
  55     crunch1/
  56         Directory with crunched config etc. Main files:
  57         crunch.conf     main config file for crunchgen
  58         crunch.inc      (optional) file included in crunchgen
  59                         Makefiles, used e.g. to set make variables
  60                         such as RELEASE_CRUNCH or similar.
  61
  62     floppy.tree/
  63         local files to be put into the floppy/mfs trees instead
  64         of the ones in ../build/floppy.tree
  65
  66     floppy.tree.exclude
  67         list of files to be omitted in the copy from ../build/floppy.tree
  68
  69     floppy.tree.${SITE}/
  70         site-specific files which update the ones taken from one
  71         of the two places above. Typically they are passwd, hosts,
  72         rc.conf, rc.firewall things to go in /etc
  73
  74     lang/
  75         language-dependant files (trimmed from the original one)
  76
  77