logo

live-bootstrap

Mirror of <https://github.com/fosslinux/live-bootstrap>

DEVEL.md (2843B)

    

  1. <!--
  2. SPDX-FileCopyrightText: 2021 fosslinux <fosslinux@aussies.space>
  4. SPDX-License-Identifier: CC-BY-SA-4.0
  5. -->
  7. # Development Guidelines
  9. ## Testing
  11. Before making a PR, please test your change locally. It is OK to develop outside
  12. of the live environment, but please be sure to test inside the live environment
  13. and that a full build completes.
  15. ## Structure
  17. ```
  18. seed
  19. ├── seed.kaem
  20. ├── script-generator.c
  21. ├── ...
  22. └── stage0-posix
  24. steps
  25. ├── manifest
  26. ├── any-global-files
  27. ├── jump
  28. │   └── linux.sh
  29. ├── improve
  30. │   └── x.sh
  31. ├── somepackage-version
  32. │   ├── pass1.kaem
  33. │   ├── pass2.sh
  34. │   ├── files
  35. │   ├── simple-patches
  36. │   ├── mk
  37. │   └── patches
  38. ```
  40. The `seed` directory contains everything required for `script-generator` to be
  41. run.
  43. In the `steps` directory, the bootstrap process is defined in `manifest`.
  44. Each package to be built is named `package-version`.
  45. Each subsequent build of a package is the nth pass. Scripts are named
  46. accordingly; eg, the first build would be called `pass1.sh`, the second would be
  47. `pass2.sh`, etc.
  48. Scripts run in kaem era should be denoted as such in their filename;
  49. `pass1.kaem`, for example. Pass numbers do not reset after kaem, ie, you cannot
  50. have both `pass1.kaem` and `pass1.sh`.
  52. In this folder, there are other folders/files. `*.checksums` are
  53. required for early packages that are build with kaem, others are optional.
  55. Permissible folders/files:
  57. - `files`: auxiliary files required for the build distributed by live-bootstrap.
  58. - `mk`: makefiles.
  59. - `patches`: patches for the source.
  60. - `simple-patches`: patches for the source that use the before/after convention of simple-patch.c
  61. - `*.checksums`: files containing the checksums for the resulting binaries and
  62. libraries that are compiled and installed.
  63.   - Otherwise, the package's checksum is in SHA256SUMS.pkgs.
  64. - compilation script(s)
  66. ## Conventions
  68. - **Patches:**
  69.   - all patches are relative to the directory where the tarball is extracted
  70.     - thus, no patch lines for `a/file.c`, but `coreutils-9.4/file.c`
  71.   - all patches begin with a patch header
  72. - **parts.rst:**
  73.   - all packages are explained in `parts.rst`
  74. - **General:**
  75.   - Where possible, all blocks of text should be limited to a length of 80
  76.     characters.
  77.   - There is no character limit for code, the reasons for this are two-fold:
  78.     - Often harms readability.
  79.     - Often impossible/hard in early bootstrap stages.
  80. - **Licensing:**
  81.   - Generally, the project is licensed under the GNU GPL v3.0 (or any later
  82.     version).
  83.   - Documentation is licensed under CC-BY-SA-4.0.
  84.   - Patches are licensed under the license of the project which they are
  85.     patching.
  86.   - All files (excluding files within submodules) must comply with REUSE v3.0.