From 7a0ad0b4bbe73c3c0955b9a72e9b09c0f6f4ec09 Mon Sep 17 00:00:00 2001 From: Kevin Day Date: Sun, 11 Dec 2022 22:15:01 -0600 Subject: [PATCH] Update: Out of date build documentation. The "See: ..." files should now end in ".txt". The directory structure for both the status project and the work directory have changed since this documentation was last modified. Update documentation regarding running Featureless Make with no arguments. Remove redundant "Alternatively..." documentation that is already described elsewhere. --- build/documents/readme.bootstrap.txt | 88 ++++++++++++++++++++++++------------ build/documents/readme.build.txt | 81 +++++++++++++++++++-------------- build/documents/readme.txt | 4 +- 3 files changed, 107 insertions(+), 66 deletions(-) diff --git a/build/documents/readme.bootstrap.txt b/build/documents/readme.bootstrap.txt index c79c165..21f632c 100644 --- a/build/documents/readme.bootstrap.txt +++ b/build/documents/readme.bootstrap.txt @@ -36,61 +36,89 @@ Bootstrap Readme Documentation: cp -vR build/programs/shared/* /usr/bin/ cp -vR build/settings/* /etc/ - Alternatively, a primitive install script is provided to help install\: - ./install.sh - If one of the build sub-directories, such as includes, libraries, programs, and settings, is empty or missing after a successful build, then there are no files of that type to install. Build Tree Structure Example (using the status_code-0.7.0 project)\: build/ ├── documents ├── includes - │   └── level_3 - │   └── status_code.h + │   └── program + │   └── status_code + │   ├── fss + │   │   ├── common.h + │   │   └── status_code.h + │   └── main + │   ├── common.h + │   ├── common-print.h + │   ├── print.h + │   └── status_code.h ├── libraries │   ├── script │   ├── shared │   │   ├── libstatus_code.so -> libstatus_code.so.0 - │   │   ├── libstatus_code.so.0 -> libstatus_code.so.0.7.0 + │   │   ├── libstatus_code.so.0 -> libstatus_code.so.0.7 + │   │   ├── libstatus_code.so.0.7 -> libstatus_code.so.0.7.0 │   │   └── libstatus_code.so.0.7.0 │   └── static │   └── libstatus_code.a ├── objects - │   ├── private-status_code.o - │   └── status_code.o + │   ├── config.o + │   ├── fss + │   │   ├── common.o + │   │   └── status_code.o + │   ├── main + │   │   ├── common.o + │   │   ├── common-print.o + │   │   ├── print.o + │   │   ├── private-status_code.o + │   │   └── status_code.o + │   ├── script + │   ├── shared + │   └── static ├── programs │   ├── script │   ├── shared + │   │   ├── fss_status_code │   │   └── status_code │   └── static + │   ├── fss_status_code │   └── status_code ├── settings └── stage - ├── libraries_shared.built - ├── libraries_static.built - ├── objects_static.built - ├── programs_shared.built - ├── programs_static.built - ├── skeleton.built - ├── sources_headers.built - ├── sources_script.built - └── sources_settings.built - + ├── library_shared-settings.built + ├── library_static-settings.built + ├── objects_static-settings.built + ├── program_shared-settings.fss.built + ├── program_shared-settings.main.built + ├── skeleton-settings.built + ├── skeleton-settings.fss.built + ├── skeleton-settings.main.built + ├── sources_headers-settings.built + ├── sources_script-settings.built + ├── sources_script-settings.fss.built + ├── sources_script-settings.main.built + ├── sources_settings-settings.built + ├── sources_settings-settings.fss.built + └── sources_settings-settings.main.built Work Tree Structure Example at /tmp/work (using the status_code-0.7.0 project)\: /tmp/work/ ├── includes - │   └── level_3 - │   └── status_code.h - ├── libraries - │   ├── shared - │   │   ├── libstatus_code.so -> libstatus_code.so.0 - │   │   ├── libstatus_code.so.0 -> libstatus_code.so.0.7.0 - │   │   └── libstatus_code.so.0.7.0 - │   └── static - │   └── libstatus_code.a - └── programs + │   └── program + │   └── status_code + │   ├── fss + │   │   ├── common.h + │   │   └── status_code.h + │   └── main + │   ├── common.h + │   ├── common-print.h + │   ├── print.h + │   └── status_code.h + └── libraries ├── shared - │   └── status_code + │   ├── libstatus_code.so -> libstatus_code.so.0 + │   ├── libstatus_code.so.0 -> libstatus_code.so.0.7 + │   ├── libstatus_code.so.0.7 -> libstatus_code.so.0.7.0 + │   └── libstatus_code.so.0.7.0 └── static - └── status_code + └── libstatus_code.a diff --git a/build/documents/readme.build.txt b/build/documents/readme.build.txt index de2157f..4aa409c 100644 --- a/build/documents/readme.build.txt +++ b/build/documents/readme.build.txt @@ -25,61 +25,74 @@ Build Readme Documentation: fake build Build Example, using "make"\: + fake + + Build Example, explicitly using "make"\: fake make - Build Tree Structure Example (using the status_code-0.7.0 project)\: + Build Tree Structure Example (using the FLL status_code-0.7.0 project)\: build/ ├── documents ├── includes - │   └── level_3 - │   └── status_code.h + │   └── program + │   └── status_code + │   ├── fss + │   │   ├── common.h + │   │   └── status_code.h + │   └── main + │   ├── common.h + │   ├── common-print.h + │   ├── print.h + │   └── status_code.h ├── libraries │   ├── script │   ├── shared │   │   ├── libstatus_code.so -> libstatus_code.so.0 - │   │   ├── libstatus_code.so.0 -> libstatus_code.so.0.7.0 + │   │   ├── libstatus_code.so.0 -> libstatus_code.so.0.7 + │   │   ├── libstatus_code.so.0.7 -> libstatus_code.so.0.7.0 │   │   └── libstatus_code.so.0.7.0 │   └── static │   └── libstatus_code.a ├── objects - │   ├── private-status_code.o - │   └── status_code.o + │   ├── config.o + │   ├── fss + │   │   ├── common.o + │   │   └── status_code.o + │   ├── main + │   │   ├── common.o + │   │   ├── common-print.o + │   │   ├── print.o + │   │   ├── private-status_code.o + │   │   └── status_code.o + │   ├── script + │   ├── shared + │   └── static ├── programs │   ├── script │   ├── shared + │   │   ├── fss_status_code │   │   └── status_code │   └── static + │   ├── fss_status_code │   └── status_code ├── settings └── stage - ├── libraries_shared.built - ├── libraries_static.built - ├── objects_static.built - ├── programs_shared.built - ├── programs_static.built - ├── skeleton.built - ├── sources_headers.built - ├── sources_script.built - └── sources_settings.built - - Work Tree Structure Example at '/tmp/work' (using the status_code-0.7.0 project)\: - /tmp/work/ - ├── includes - │   └── level_3 - │   └── status_code.h - ├── libraries - │   ├── shared - │   │   ├── libstatus_code.so -> libstatus_code.so.0 - │   │   ├── libstatus_code.so.0 -> libstatus_code.so.0.7.0 - │   │   └── libstatus_code.so.0.7.0 - │   └── static - │   └── libstatus_code.a - └── programs - ├── shared - │   └── status_code - └── static - └── status_code + ├── library_shared-settings.built + ├── library_static-settings.built + ├── objects_static-settings.built + ├── program_shared-settings.fss.built + ├── program_shared-settings.main.built + ├── skeleton-settings.built + ├── skeleton-settings.fss.built + ├── skeleton-settings.main.built + ├── sources_headers-settings.built + ├── sources_script-settings.built + ├── sources_script-settings.fss.built + ├── sources_script-settings.main.built + ├── sources_settings-settings.built + ├── sources_settings-settings.fss.built + └── sources_settings-settings.main.built See: FLL Fake project documents for further details on how to use the Fake system. See: FLL Fake project specifications for how to configure the build FSS files and make FSS files. - See: readme.bootstrap for notes on installing. + See: readme.bootstrap.txt for notes on installing. diff --git a/build/documents/readme.txt b/build/documents/readme.txt index b229441..7670e58 100644 --- a/build/documents/readme.txt +++ b/build/documents/readme.txt @@ -49,5 +49,5 @@ Readme Documentation: Use it as an example or explicitly call it (such as: "bash build/scripts/bootstrap-example.sh monolithic 0.7.0"). See: dependencies for specific dependencies of this project. - See: readme.bootstrap for bootstrap compiling (or just regular compiling) any part of the FLL and notes on installing. - See: readme.build for Featureless Make compiling and notes on installing. + See: readme.bootstrap.txt for bootstrap compiling (or just regular compiling) any part of the FLL and notes on installing. + See: readme.build.txt for Featureless Make compiling and notes on installing. -- 1.8.3.1