1.1 --- a/README.txt Wed Aug 10 00:25:44 2022 +0200
1.2 +++ b/README.txt Wed Aug 10 23:58:38 2022 +0200
1.3 @@ -1,21 +1,92 @@
1.4 +Departure
1.5 +=========
1.6 +
1.7 This is a collection of L4Re packages for providing and using filesystems and
1.8 related components.
1.9
1.10 -This directory (dstest) should be installed within the pkg directory in the
1.11 +This directory (departure) should be installed within the pkg directory in the
1.12 L4Re distribution.
1.13
1.14 +Building Fiasco and L4Re
1.15 +------------------------
1.16 +
1.17 +Although this is generally documented, the concise instructions for building
1.18 +the software have not been preserved in the L4Re distribution, requiring the
1.19 +perusal of online resources. For example:
1.20 +
1.21 +https://github.com/kernkonzept/manifest/wiki/BUILDING
1.22 +
1.23 +Some reminders are provided below to save the reader the bother of looking up
1.24 +or searching for this information, particularly if it does not continue to
1.25 +reside in the above location.
1.26 +
1.27 +First of all, the ham tool has to be obtained. This can be done as follows:
1.28 +
1.29 +git clone https://github.com/kernkonzept/ham.git
1.30 +
1.31 +It can be built as follows:
1.32 +
1.33 +cd ham
1.34 +make
1.35 +
1.36 +Returning to the parent directory, the Fiasco and L4Re distributions can be
1.37 +obtained as follows:
1.38 +
1.39 +ham/ham init -u https://github.com/kernkonzept/manifest.git
1.40 +ham/ham sync
1.41 +
1.42 +(Referencing ham within its repository avoids any need to put the program on
1.43 +the PATH, which is largely unnecessary since we will only be using it in this
1.44 +particular location and for the specific purpose of downloading the remaining
1.45 +software of interest.)
1.46 +
1.47 +Here is a quick summary of the build process for Fiasco starting at the parent
1.48 +directory of the Fiasco and L4Re distributions:
1.49 +
1.50 +cd fiasco
1.51 +make BUILDDIR=mybuild
1.52 +cd mybuild
1.53 +make config
1.54 +make
1.55 +
1.56 +The final make command can employ flags such as "-j8" or even "-j" without any
1.57 +parameter to parallelise the build.
1.58 +
1.59 +At this point, this directory (departure) can be copied into the L4Re
1.60 +distribution within the pkg directory.
1.61 +
1.62 +Here is a quick summary of the build process for L4Re, also starting at the
1.63 +parent directory of the Fiasco and L4Re distributions:
1.64 +
1.65 +cd l4
1.66 +make B=mybuild
1.67 +make O=mybuild config
1.68 +make O=mybuild
1.69 +
1.70 +Again, the final make command can employ parallelisation flags. For example:
1.71 +
1.72 +make -j8 O=mybuild
1.73 +
1.74 +Along with the usual L4Re software, this will also build the software provided
1.75 +by this distribution if it has been copied into the pkg/departure location
1.76 +within the l4 directory.
1.77 +
1.78 +Running Programs from this Distribution
1.79 +---------------------------------------
1.80 +
1.81 To make the test programs available to L4Re, add the following line to the
1.82 L4Re conf/Makeconf.boot file:
1.83
1.84 -MODULE_SEARCH_PATH += $(L4DIR_ABS)/pkg/dstest/conf
1.85 +MODULE_SEARCH_PATH += $(L4DIR_ABS)/pkg/departure/conf
1.86
1.87 It may also be necessary to add the following line as well:
1.88
1.89 -BOOTSTRAP_SEARCH_PATH += $(L4DIR_ABS)/pkg/dstest/conf
1.90 +BOOTSTRAP_SEARCH_PATH += $(L4DIR_ABS)/pkg/departure/conf
1.91
1.92 This removes any need to copy program configuration files and associated
1.93 resources to the L4Re distribution itself.
1.94
1.95 The program module lists in the conf subdirectory can either be appended to
1.96 the L4Re conf/modules.list file, or a specific .list file can be copied to the
1.97 -conf/modules.list location (potentially after taking a backup copy).
1.98 +conf/modules.list location (potentially after taking a backup copy of the
1.99 +original file).