1.1 --- a/README.txt Tue Jul 03 20:38:40 2018 +0200
1.2 +++ b/README.txt Sat Aug 25 19:24:28 2018 +0200
1.3 @@ -250,6 +250,65 @@
1.4
1.5 Plenty of other hardware support should be introduced.
1.6
1.7 +Tools and Utilities
1.8 +===================
1.9 +
1.10 +The tools directory contains a number of programs useful when developing this
1.11 +software:
1.12 +
1.13 +checkconfig.sh - initialises files used to control run-time linking for the
1.14 + configured device
1.15 +
1.16 +install.sh - installs the software in a L4Re source distribution
1.17 +
1.18 +listlibs.sh - lists library modules for inclusion in .list files
1.19 +
1.20 +makecontrol.sh - updates the Control file for a package directory with
1.21 + details of the provided "virtual" packages employed by the
1.22 + build system for dependency resolution
1.23 +
1.24 +makefonts.sh - generate binary font files from source data
1.25 +
1.26 +readfont.py - convert GNU Unifont source files to binary form
1.27 +
1.28 +Identifying Library Modules
1.29 +---------------------------
1.30 +
1.31 +The listlibs.sh tool is intended to inspect an existing .list file, analyse
1.32 +executable programs mentioned in that file that have already been built, and
1.33 +to generate a list of shared libraries needed by those executables such that
1.34 +the .list file describes all required modules for deployment.
1.35 +
1.36 +In the l4 subdirectory of the L4Re source distribution, the tool is run as
1.37 +follows:
1.38 +
1.39 +$LANDFALL/tools/listlibs.sh conf/landfall-examples/$EXAMPLE.list mybuild
1.40 +
1.41 +(Here, $LANDFALL needs to expand to the location of this distribution whereas
1.42 +$EXAMPLE indicates an example name.)
1.43 +
1.44 +For example:
1.45 +
1.46 +~/L4/Landfall/tools/listlibs.sh \
1.47 + conf/landfall-examples/mips-qi_lb60-keypad.list mybuild
1.48 +
1.49 +This will output a list of modules for inclusion in the .list file. It can be
1.50 +advisable to make this change to the .list file in the Landfall distribution
1.51 +and to then install the file into the L4Re source distribution, potentially
1.52 +using the install.sh script.
1.53 +
1.54 +At this point, it is important to remember that the conf/modules.list file
1.55 +will need updating to include these new details. For example:
1.56 +
1.57 +cp conf/landfall-examples/mips-qi_lb60-keypad.list conf/modules.list
1.58 +
1.59 +Finally, the command to build a payload can be run:
1.60 +
1.61 +make O=mybuild uimage E=mips-qi_lb60-keypad-example
1.62 +
1.63 +This should consult conf/modules.list and update the contents of the generated
1.64 +image to include any newly-added shared libraries.
1.65 +
1.66 Dependencies/Prerequisites
1.67 ==========================
1.68