andrius
/
live-bootstrap
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
live-bootstrap/DEVEL.md

2.2 KiB
Raw Blame History

Development Guidelines

Testing

Before making a PR, please test your change locally. It is OK to develop outside of the live environment, but please be sure to test inside the live environment and that a full build completes.

Structure

Each system corresponds to a reboot of the live environment. There is only one appropriate structure as shown below (eg for sysa):

sysa
├── any-global-files.sh
├── somepackage-version
│   ├── somepackage-version.kaem (or .sh)
│   ├── files
│   ├── mk
│   ├── patches
│   └── src
└── tmp

Global scripts that drive the entire system go directly under sysx. tmp contains the temporary system used for QEMU or a chroot.

Then, each package is in its own specific directory, named package-version. It then diverges based upon which driver is being used:

  • kaem: A file named package-version.kaem is called by the master script.
  • bash: The build function from helper.sh is called from the master script. There are default functions run which can be overridden by an optional script package-version.sh within the package-specific directory.

In this folder, there are other folders. src is required, others are optional. Permissable folders:

  • files: auxiliary files required for the build distributed by live-bootstrap.
  • mk: makefiles.
  • patches: patches for the source.
  • src: the upstream unmodified source code. This may be either a submodule or nonexistant.

Conventions

  • Patches:
    • all patches are -p0
    • all patches begin with a patch header
  • README:
    • all stages are explained in README
  • General:
    • Where possible, all blocks of text should be limited to a length of 80 characters.
    • There is no character limit for code, the reasons for this are two-fold:
      • Often harms readability.
      • Often impossible/hard in early bootstrap stages.

git

All changes must be submitted as PRs. Pushing to master is disallowed, even if push access is granted to a user. Only pushes to master should be merging of patches into master.