[8783] | 1 | This document describes the organization of the source tree and what |
---|
| 2 | is appropriate to put where. |
---|
| 3 | |
---|
| 4 | doc |
---|
| 5 | --- |
---|
| 6 | |
---|
| 7 | This hierarchy contains documentation related to the maintenance of |
---|
| 8 | the source tree. Documentation for specific pieces of software does |
---|
| 9 | not belong here. |
---|
| 10 | |
---|
| 11 | athena |
---|
| 12 | ------ |
---|
| 13 | |
---|
| 14 | This hierarchy contains software (running code) for which we are the |
---|
| 15 | primary maintainers. The contents of this hierarchy should not be |
---|
| 16 | highly tailored to the Athena environment (for instance, referencing |
---|
| 17 | AFS paths in the Athena cell is a no-no), and should use the Athena |
---|
| 18 | build system as documented in the file "build-system" in this |
---|
| 19 | directory. |
---|
| 20 | |
---|
| 21 | This hierarchy is divided up into "bin", "etc", and "lib" directories |
---|
| 22 | according to where the software lives. At the current time, this |
---|
| 23 | division is very rough; programs under "lib" such as Zephyr contain |
---|
| 24 | programs as well as libraries. |
---|
| 25 | |
---|
| 26 | third |
---|
| 27 | ----- |
---|
| 28 | |
---|
| 29 | This hierarchy contains software which we use which is maintained by |
---|
| 30 | other people, with changes for our build environment. Software in |
---|
| 31 | this hierarchy does not use the Athena build system; it has not yet |
---|
| 32 | been determined or documented how third-party software will be built, |
---|
| 33 | but it will attempt to require as few modifications to the original |
---|
| 34 | build system as possible. |
---|
| 35 | |
---|
| 36 | packs |
---|
| 37 | ----- |
---|
| 38 | |
---|
| 39 | This hierarchy contains "stuff" which is relevant to the construction |
---|
| 40 | of the system packs and the configuration and maintenance of an Athena |
---|
| 41 | workstation. Running code in the "packs" hierarchy is highly tailored |
---|
| 42 | to the Athena environment would generally be useless to the outside |
---|
| 43 | world except as examples. |
---|
| 44 | |
---|
| 45 | The packs hirearchy has the following subdirectories: |
---|
| 46 | |
---|
| 47 | build |
---|
| 48 | Scripts et al used to build the system packs from the |
---|
| 49 | source tree. |
---|
| 50 | |
---|
| 51 | config |
---|
| 52 | Configuration files for Athena workstations. |
---|
| 53 | |
---|
| 54 | dotfiles |
---|
| 55 | Shell scripts sourced when the user logs in, and |
---|
| 56 | their subsidiaries. |
---|
| 57 | |
---|
| 58 | maint |
---|
| 59 | Workstation maintenance software, including boot-time |
---|
| 60 | scripts, reactivate, scripts for cleaning temporary |
---|
| 61 | areas, etc.. |
---|
| 62 | |
---|
| 63 | glue |
---|
| 64 | Shell scripts and symlink generation for making the |
---|
| 65 | packs refer to software which is not built as part |
---|
| 66 | of the release. |
---|
| 67 | |
---|
| 68 | install |
---|
| 69 | The workstation installation system. |
---|
| 70 | |
---|
| 71 | update |
---|
| 72 | The workstation update system. |
---|