tfgrid/zosbuilder
11
0
Fork 1
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(TODO): use relative links from docs/ to ../scripts and ../config so links work in GitHub and VS Code

Browse Source
This commit is contained in:
Jan De Landtsheer
2025-10-02 11:44:41 +02:00
parent d5e9bf2d9a
commit 818f5037f4
1 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
docs/TODO.md
View File

@@ -4,11 +4,11 @@ This canonical checklist is the single source of truth for ongoing work. It mirr
## High-level ## High-level
- [x] Regenerate repository function index: [scripts/functionlist.md](scripts/functionlist.md) - [x] Regenerate repository function index: [scripts/functionlist.md](../scripts/functionlist.md)
- [x] Refresh NOTES with jump-points and roadmap: [docs/NOTES.md](docs/NOTES.md) - [x] Refresh NOTES with jump-points and roadmap: [docs/NOTES.md](NOTES.md)
- [x] Extend RFS design with RESP/DB-style backend: [docs/rfs-flists.md](docs/rfs-flists.md) - [x] Extend RFS design with RESP/DB-style backend: [docs/rfs-flists.md](rfs-flists.md)
- [x] Make Rust components Git fetch non-destructive: [bash.components_download_git()](scripts/lib/components.sh:72) - [x] Make Rust components Git fetch non-destructive: [bash.components_download_git()](../scripts/lib/components.sh:72)
- [ ] Update zinit config for "zosception" workflow: [config/zinit/](config/zinit/) - [ ] Update zinit config for "zosception" workflow: [config/zinit/](../config/zinit/)
- [ ] Add zosstorage to the initramfs (package/build/install + zinit unit) - [ ] Add zosstorage to the initramfs (package/build/install + zinit unit)
- [ ] Validate via minimal rebuild and boot tests; refine depmod/udev docs - [ ] Validate via minimal rebuild and boot tests; refine depmod/udev docs
- [ ] Commit and push documentation and configuration updates (post-zosception/zosstorage) - [ ] Commit and push documentation and configuration updates (post-zosception/zosstorage)
@@ -17,56 +17,56 @@ This canonical checklist is the single source of truth for ongoing work. It mirr
- [ ] Define service graph changes and ordering constraints - [ ] Define service graph changes and ordering constraints
- Reference current triggers: - Reference current triggers:
- Early coldplug: [config/zinit/udev-trigger.yaml](config/zinit/udev-trigger.yaml) - Early coldplug: [config/zinit/udev-trigger.yaml](../config/zinit/udev-trigger.yaml)
- Network readiness: [config/zinit/network.yaml](config/zinit/network.yaml) - Network readiness: [config/zinit/network.yaml](../config/zinit/network.yaml)
- Post-mount coldplug: [config/zinit/udev-rfs.yaml](config/zinit/udev-rfs.yaml) - Post-mount coldplug: [config/zinit/udev-rfs.yaml](../config/zinit/udev-rfs.yaml)
- [ ] Add/update units under [config/zinit/](config/zinit/) with proper after/needs/wants - [ ] Add/update units under [config/zinit/](../config/zinit/) with proper after/needs/wants
- [ ] Validate with stage runner and logs - [ ] Validate with stage runner and logs
- Stage runner: [bash.stage_run()](scripts/lib/stages.sh:99) - Stage runner: [bash.stage_run()](../scripts/lib/stages.sh:99)
- Main flow: [bash.main_build_process()](scripts/build.sh:214) - Main flow: [bash.main_build_process()](../scripts/build.sh:214)
## ZOS Storage in initramfs ## ZOS Storage in initramfs
- [ ] Decide delivery mechanism: - [ ] Decide delivery mechanism:
- [ ] APK via [config/packages.list](config/packages.list) - [ ] APK via [config/packages.list](../config/packages.list)
- [ ] Source build via [bash.components_parse_sources_conf()](scripts/lib/components.sh:13) with a new build function - [ ] Source build via [bash.components_parse_sources_conf()](../scripts/lib/components.sh:13) with a new build function
- [ ] Copy/install into initramfs - [ ] Copy/install into initramfs
- Components copy: [bash.initramfs_copy_components()](scripts/lib/initramfs.sh:102) - Components copy: [bash.initramfs_copy_components()](../scripts/lib/initramfs.sh:102)
- Zinit setup: [bash.initramfs_setup_zinit()](scripts/lib/initramfs.sh:13) - Zinit setup: [bash.initramfs_setup_zinit()](../scripts/lib/initramfs.sh:13)
- [ ] Create zinit unit(s) for zosstorage startup and ordering - [ ] Create zinit unit(s) for zosstorage startup and ordering
- Place after network and before RFS if it provides storage used by rfs - Place after network and before RFS if it provides storage used by rfs
- [ ] Add smoke command to confirm presence in image (e.g., which/--version) during [bash.initramfs_validate()](scripts/lib/initramfs.sh:820) - [ ] Add smoke command to confirm presence in image (e.g., which/--version) during [bash.initramfs_validate()](../scripts/lib/initramfs.sh:820)
## RFS backends — implementation follow-up (beyond design) ## RFS backends — implementation follow-up (beyond design)
- [ ] RESP uploader shim for packers (non-breaking) - [ ] RESP uploader shim for packers (non-breaking)
- Packers entrypoints: [scripts/rfs/pack-modules.sh](scripts/rfs/pack-modules.sh), [scripts/rfs/pack-firmware.sh](scripts/rfs/pack-firmware.sh) - Packers entrypoints: [scripts/rfs/pack-modules.sh](../scripts/rfs/pack-modules.sh), [scripts/rfs/pack-firmware.sh](../scripts/rfs/pack-firmware.sh)
- Config loader: [bash.rfs_common_load_rfs_s3_config()](scripts/rfs/common.sh:82) → extend to parse RESP_* (non-breaking) - Config loader: [bash.rfs_common_load_rfs_s3_config()](../scripts/rfs/common.sh:82) → extend to parse RESP_* (non-breaking)
- Store URI builder (S3 exists): [bash.rfs_common_build_s3_store_uri()](scripts/rfs/common.sh:137) - Store URI builder (S3 exists): [bash.rfs_common_build_s3_store_uri()](../scripts/rfs/common.sh:137)
- Manifest patching remains: - Manifest patching remains:
- Stores table: [bash.rfs_common_patch_flist_stores()](scripts/rfs/common.sh:385) - Stores table: [bash.rfs_common_patch_flist_stores()](../scripts/rfs/common.sh:385)
- route.url: [bash.rfs_common_patch_flist_route_url()](scripts/rfs/common.sh:494) - route.url: [bash.rfs_common_patch_flist_route_url()](../scripts/rfs/common.sh:494)
- [ ] Connectivity checks and retries for RESP path - [ ] Connectivity checks and retries for RESP path
- [ ] Local cache for pack-time (optional) - [ ] Local cache for pack-time (optional)
## Validation and boot tests ## Validation and boot tests
- [ ] Minimal rebuild after zinit/units/edit - [ ] Minimal rebuild after zinit/units/edit
- Helper: [scripts/rebuild-after-zinit.sh](scripts/rebuild-after-zinit.sh) - Helper: [scripts/rebuild-after-zinit.sh](../scripts/rebuild-after-zinit.sh)
- [ ] Validate contents before CPIO - [ ] Validate contents before CPIO
- Create: [bash.initramfs_create_cpio()](scripts/lib/initramfs.sh:691) - Create: [bash.initramfs_create_cpio()](../scripts/lib/initramfs.sh:691)
- Validate: [bash.initramfs_validate()](scripts/lib/initramfs.sh:820) - Validate: [bash.initramfs_validate()](../scripts/lib/initramfs.sh:820)
- [ ] QEMU / cloud-hypervisor smoke tests - [ ] QEMU / cloud-hypervisor smoke tests
- Test suite: [bash.testing_run_all()](scripts/lib/testing.sh:299) - Test suite: [bash.testing_run_all()](../scripts/lib/testing.sh:299)
- [ ] Kernel embed path and versioning sanity - [ ] Kernel embed path and versioning sanity
- Embed config: [bash.kernel_modify_config_for_initramfs()](scripts/lib/kernel.sh:130) - Embed config: [bash.kernel_modify_config_for_initramfs()](../scripts/lib/kernel.sh:130)
- Full version logic: [bash.kernel_get_full_version()](scripts/lib/kernel.sh:14) - Full version logic: [bash.kernel_get_full_version()](../scripts/lib/kernel.sh:14)
## Operational conventions (keep) ## Operational conventions (keep)
- [ ] Diagnostics-first changes; add logs before fixes - [ ] Diagnostics-first changes; add logs before fixes
- [ ] Absolute path normalization respected - [ ] Absolute path normalization respected
- Normalization: [scripts/lib/common.sh](scripts/lib/common.sh:244) - Normalization: [scripts/lib/common.sh](../scripts/lib/common.sh:244)
Notes Notes
- Keep this file in sync with the live tracker. Reference it in PR descriptions. - Keep this file in sync with the live tracker. Reference it in PR descriptions.