1.1 --- a/README.txt Fri Aug 12 16:41:47 2022 +0200
1.2 +++ b/README.txt Fri Aug 12 16:42:33 2022 +0200
1.3 @@ -1,5 +1,5 @@
1.4 -Departure
1.5 -=========
1.6 +Introduction
1.7 +============
1.8
1.9 This is a collection of L4Re packages for providing and using filesystems and
1.10 related components.
1.11 @@ -7,12 +7,37 @@
1.12 This directory (departure) should be installed within the pkg directory in the
1.13 L4Re distribution.
1.14
1.15 -Building Fiasco and L4Re
1.16 -------------------------
1.17 +Prerequisites
1.18 +=============
1.19 +
1.20 +This software requires some other software to be useful:
1.21 +
1.22 + * The Fiasco.OC microkernel and L4Re distribution
1.23 + * The idl4re distribution
1.24 +
1.25 +Obtaining and Building idl4re
1.26 +=============================
1.27 +
1.28 +The idl4re distribution provides a tool called idl that generates source files
1.29 +from interface descriptions. It can be obtained as follows:
1.30 +
1.31 +hg clone https://hg.boddie.org.uk/L4Re/idl4re
1.32
1.33 -Although this is generally documented, the concise instructions for building
1.34 -the software have not been preserved in the L4Re distribution, requiring the
1.35 -perusal of online resources. For example:
1.36 +The software can be built as follows:
1.37 +
1.38 +cd idl4re
1.39 +make
1.40 +
1.41 +When building the Departure software within the L4Re build system, the idl4re
1.42 +directory will need to be present in the appropriate location, this being
1.43 +inside the l4 directory. See below for more details.
1.44 +
1.45 +Obtaining and Building Fiasco.OC and L4Re
1.46 +=========================================
1.47 +
1.48 +Although the build processes for Fiasco.OC and L4Re are generally documented,
1.49 +the concise instructions for building the software have not been preserved in
1.50 +the L4Re distribution, requiring the perusal of online resources. For example:
1.51
1.52 https://github.com/kernkonzept/manifest/wiki/BUILDING
1.53
1.54 @@ -29,7 +54,7 @@
1.55 cd ham
1.56 make
1.57
1.58 -Returning to the parent directory, the Fiasco and L4Re distributions can be
1.59 +Returning to the parent directory, the Fiasco.OC and L4Re distributions can be
1.60 obtained as follows:
1.61
1.62 ham/ham init -u https://github.com/kernkonzept/manifest.git
1.63 @@ -40,8 +65,8 @@
1.64 particular location and for the specific purpose of downloading the remaining
1.65 software of interest.)
1.66
1.67 -Here is a quick summary of the build process for Fiasco starting at the parent
1.68 -directory of the Fiasco and L4Re distributions:
1.69 +Here is a quick summary of the build process for Fiasco.OC starting at the
1.70 +parent directory of the Fiasco.OC and L4Re distributions:
1.71
1.72 cd fiasco
1.73 make BUILDDIR=mybuild
1.74 @@ -53,10 +78,11 @@
1.75 parameter to parallelise the build.
1.76
1.77 At this point, this directory (departure) can be copied into the L4Re
1.78 -distribution within the pkg directory.
1.79 +distribution within the pkg directory. Also, the idl4re distribution should be
1.80 +made available within the l4 directory itself.
1.81
1.82 Here is a quick summary of the build process for L4Re, also starting at the
1.83 -parent directory of the Fiasco and L4Re distributions:
1.84 +parent directory of the Fiasco.OC and L4Re distributions:
1.85
1.86 cd l4
1.87 make B=mybuild
1.88 @@ -71,11 +97,18 @@
1.89 by this distribution if it has been copied into the pkg/departure location
1.90 within the l4 directory.
1.91
1.92 -Running Programs from this Distribution
1.93 ----------------------------------------
1.94 +Defining the L4Re Configuration
1.95 +===============================
1.96
1.97 -To make the test programs available to L4Re, add the following line to the
1.98 -L4Re conf/Makeconf.boot file:
1.99 +An example configuration file is provided as conf/Makeconf.boot within this
1.100 +distribution. Where no such existing file has been deployed, this example file
1.101 +can be copied into a suitable location from within the l4 directory as
1.102 +follows:
1.103 +
1.104 +cp pkg/departure/conf/Makeconf.boot conf/Makeconf.boot
1.105 +
1.106 +Otherwise, with an existing conf/Makeconf.boot file, to make the test programs
1.107 +available to L4Re, add the following line to such a file:
1.108
1.109 MODULE_SEARCH_PATH += $(L4DIR_ABS)/pkg/departure/conf
1.110
1.111 @@ -86,7 +119,22 @@
1.112 This removes any need to copy program configuration files and associated
1.113 resources to the L4Re distribution itself.
1.114
1.115 +Defining the Module Lists
1.116 +=========================
1.117 +
1.118 The program module lists in the conf subdirectory can either be appended to
1.119 the L4Re conf/modules.list file, or a specific .list file can be copied to the
1.120 conf/modules.list location (potentially after taking a backup copy of the
1.121 -original file).
1.122 +original file). For example, from within the l4 directory:
1.123 +
1.124 +cp conf/modules.list conf/modules.list.orig
1.125 +cp pkg/departure/conf/dstest_test.list conf/modules.list
1.126 +
1.127 +Running Programs from this Distribution
1.128 +=======================================
1.129 +
1.130 +With configuration measures in place, a program can be run in QEMU as follows:
1.131 +
1.132 +make O=mybuild qemu E=dstest_test
1.133 +
1.134 +The particular program used above is a short concurrency test.