blob: 887a87035c81f9cdc3dacfdc595120088ce5e607 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
|
# AGENTS.md
## Project purpose
VyOS fork of Debian's `live-boot` — the initramfs/boot scripts that bring up a Debian Live system. The VyOS extensions mount the VyOS config directories during system startup (see `components/9990-vyos.sh`). Required for the entire VyOS image to boot. Ships Debian packages `live-boot`, `live-boot-doc`, `live-boot-initramfs-tools`.
## Tech stack
- POSIX shell + Roff manpages.
- Plain `Makefile` (no autotools).
- Debian packaging in `debian/`.
## Build / test / run
```sh
make # default target builds + lints scripts
make test # syntax check across backend/frontend/components scripts
dpkg-buildpackage -us -uc
```
`SCRIPTS = backend/*/* frontend/* components/*`. The `Makefile` enforces shell syntax via `sh -n` per script.
## Repository layout
- `backend/` — initramfs-tools and similar backend integration.
- `frontend/` — user-facing helpers.
- `components/` — boot-time hooks; `9990-vyos.sh` is the VyOS hook for config mount.
- `manpages/` — Roff manpages with i18n PO files under `manpages/po/`.
- `debian/` — packaging.
## Cross-repo context
Pre-dep of the live ISO. Consumed by `vyos/vyos-live-build` (the `live-build` fork) which is in turn consumed by `vyos/vyos-build` for ISO assembly. Listed in an internal repository. README explicitly notes the long-term goal of dropping this fork in favour of upstream Debian `live-build` plus added files in the `vyos-build` chroot.
## Conventions
- Default branch `rolling`. LTS branches `sagitta`/`circinus`/`equuleus` for backports.
- Commit / PR title format: `component: T12345: description` (Phorge task ID at https://vyos.dev) — enforced via `vyos/.github` reusables (see workflows below).
- Active workflows: `cla-check.yml`, `pr-mirror-repo-sync.yml`, `trigger-rebuild-repo-package.yml`. So this repo IS wired into the mirror pipeline (sends PRs to an internal repository) and the rebuild-dispatch chain (notifies `vyos-build-packages` to rebuild on merge).
## Notes for future contributors
- Long-term plan (per README): retire this fork. Don't add features here that could equally live in `vyos-build`'s chroot overlay.
- Any change touching `components/9990-vyos.sh` affects boot-time config mount on every VyOS install — coordinate with `vyos-1x` config-loading code.
|
