FreeCalypso > hg > freecalypso-tools

comparison doc/opt-freecalypso-tree @ 435:0a01e1c4ea54

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
documentation: added some notes about the importance of preserving our /opt/freecalypso private directory hierarchy
author Mychaela Falconia <falcon@freecalypso.org>
date Sun, 04 Nov 2018 21:55:19 +0000
parents
children 519689d3e1c7
comparison
equal deleted inserted replaced
434:3ec8ef8b2d37 435:0a01e1c4ea54
1 The /opt/freecalypso host directory tree used by the present FC host tools
2 package and by various add-ons to it does NOT follow the traditional Unix/Linux
3 file system hierarchy standard (FHS), instead it is a highly specialized
4 directory tree that is meant to be private to FreeCalypso, with its structure
5 defined solely by the Mother and no one else. The following subdirectories are
6 currently defined:
7
8 aud-*: these directories appear if you install our optional
9 fc-audio-config package, and contain subtrees to be uploaded by
10 production line scripts into target device FFS under /aud via fc-fsio.
11
12 batteries and charging: these subtrees come from fc-battery-conf
13 (optional just like fc-audio-config) and are meant to be used with
14 fc-fsio write-battery-table and write-charging-config commands.
15
16 bin and include are the only subdirectories under /opt/freecalypso
17 which follow traditional UNIX directory layout; include was added so
18 that packages external to the core FC host tools package like
19 fc-rfcal-tools and freecalypso-ui-dev can use rvinterf headers.
20
21 gcc: the recommend install location for our ARM7 gcc toolchain is
22 /opt/freecalypso/gcc.
23
24 helpfiles subdir contains help files for those FC host utilities which
25 implement a help command.
26
27 loadtools subdir contains hardware parameter files and init scripts
28 which underlie the all-important -h option to fc-loadtool, fc-iram and
29 fc-xram, collectively known as loadtools.
30
31 rfcal subdir only appears if you are doing RF calibration and install
32 fc-rfcal-tools, and some of the necessary config files under that
33 subdir you have to create yourself using your own RF knowledge specific
34 to your particular setup.
35
36 target-bin contains ARM7 target binaries used under the hood by
37 loadtools.
38
39 The basic minimal form of the /opt/freecalypso tree is populated when
40 you install FC host tools, but it is further enriched if and when you
41 install further add-ons (fc-audio-config, fc-battery-conf,
42 fc-rfcal-tools) which are more specialized and not required for all
43 users. I expect to have more additions in the future: for example,
44 when we start using the Melody E1 mechanism in our planned FC Libre
45 Dumbphone, there will be a FreeCalypso ringtones package that will
46 install E1-format melody files somewhere under /opt/freecalyso, to be
47 subsequently uploaded into the actual phones via fc-fsio, initially at
48 production time and optionally by end users.