FreeCalypso > hg > freecalypso-tools

annotate doc/opt-freecalypso-tree @ 833:625bee54ed34

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