From 47d6e94999a9a69a82331acd90391d83900d4d8e Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 7 May 2026 14:30:07 +0300 Subject: general: T8595: add AGENTS.md --- AGENTS.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 AGENTS.md (limited to 'AGENTS.md') diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..974f236 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,55 @@ +# AGENTS.md + +## Project purpose + +Hypervisor-detection CLI tool for UNIX-like systems. Reports which hypervisor (KVM, Xen, VMware, Hyper-V, …) the host is running on without requiring root privileges. Used at boot/runtime by VyOS to tailor behaviour per virtualisation environment. + +## Tech stack + +- Ada 2005 (designed for that — README: "Single high level language. Even if certain things require more code."). +- Build: GNAT 4.x+ via `gprbuild` (`hvinfo.gpr` project file). GNU `make` is the user-facing entry point (`Makefile` calls `gprbuild`/`gprclean`; installs via standard Unix `install`). +- Configuration generated by `mkconfig.sh` and `mkdefs.sh` (shell) using `gnatprep`. +- Debian packaging under `debian/` (`changelog`, `control`, `rules`, `copyright`). + +## Build / test / run + +``` +gmake # builds via gprbuild into build/ +gmake install PREFIX= +# Debian package +dpkg-buildpackage -uc -us -tc -b +``` + +No automated test suite; the binary itself is the test (run on each target hypervisor). + +## Repository layout + +- `src/` — Ada sources. +- `hvinfo.gpr` — GNAT project file. +- `hvinfo.def` — gnatprep preprocessor directives file (committed). +- `config.def` — generated by `mkdefs.sh`; listed in `.gitignore`. +- `mkconfig.sh`, `mkdefs.sh` — generators called from `Makefile`. +- `Makefile` — user-facing build wrapper. +- `debian/` — Debian packaging. +- `VERSION`, `README.md`, `LICENSE` (GPL-2). + +## Cross-repo context + +One of the canonical 14 VyOS-image build packages, listed in `VyOS-Networks/vyos-build-packages/repos.toml`. Built into VyOS images by `vyos-build` and consumed at runtime by `vyos-1x` to detect virtualisation context. Native-package category — no application-level test runner beyond `dpkg-buildpackage`. + +## Conventions + +- Commit / PR title format: `component: T12345: description` (Phorge task ID at https://vyos.dev mandatory). Enforced by `vyos/.github` reusable workflows where consumed. +- Branch model: `current` (rolling), `circinus` (1.5 LTS), `sagitta` (1.4 LTS), `equuleus` (1.3 LTS). +- Author: Daniil Baturin; one of the very few Ada packages in the VyOS ecosystem. +- License: GPL-2-or-later. + +## Mirror relationship + +Mirror twin: `VyOS-Networks/hvinfo`. Canonical side is **here** (`vyos/hvinfo`). Per the relations doc §8.4, `VyOS-Networks/hvinfo` has its workflows on the `git-actions` branch — that is **not** the canonical state; defer to this repo. + +## Notes for future contributors + +- Build needs Ada 2005 toolchain (`gnat`, `gprbuild`, `gnatprep`) — uncommon in modern dev environments. +- Adding a new hypervisor signature: extend the relevant Ada module under `src/` and bump `VERSION`. +- License: GPL-2. -- cgit v1.2.3 From 3070c3722390ddd1a96c57c5787f284512aa198d Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 7 May 2026 14:38:05 +0300 Subject: general: T8595: incorporate dmbaturin feedback (3 suggestions) --- AGENTS.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'AGENTS.md') diff --git a/AGENTS.md b/AGENTS.md index 974f236..19ae348 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -2,7 +2,7 @@ ## Project purpose -Hypervisor-detection CLI tool for UNIX-like systems. Reports which hypervisor (KVM, Xen, VMware, Hyper-V, …) the host is running on without requiring root privileges. Used at boot/runtime by VyOS to tailor behaviour per virtualisation environment. +Hypervisor detection CLI tool for UNIX-like systems. Reports which hypervisor (KVM, Xen, VMware, Hyper-V, …) the host is running on without requiring root privileges. ## Tech stack @@ -40,7 +40,6 @@ One of the canonical 14 VyOS-image build packages, listed in `VyOS-Networks/vyos ## Conventions - Commit / PR title format: `component: T12345: description` (Phorge task ID at https://vyos.dev mandatory). Enforced by `vyos/.github` reusable workflows where consumed. -- Branch model: `current` (rolling), `circinus` (1.5 LTS), `sagitta` (1.4 LTS), `equuleus` (1.3 LTS). - Author: Daniil Baturin; one of the very few Ada packages in the VyOS ecosystem. - License: GPL-2-or-later. @@ -50,6 +49,6 @@ Mirror twin: `VyOS-Networks/hvinfo`. Canonical side is **here** (`vyos/hvinfo`). ## Notes for future contributors -- Build needs Ada 2005 toolchain (`gnat`, `gprbuild`, `gnatprep`) — uncommon in modern dev environments. +- Build needs Ada 2005 toolchain (`gnat`, `gprbuild`, `gnatprep`). - Adding a new hypervisor signature: extend the relevant Ada module under `src/` and bump `VERSION`. - License: GPL-2. -- cgit v1.2.3 From a402cfc4483bc214ce85fd7c1ef0eaffaf0e9c52 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 7 May 2026 19:03:36 +0300 Subject: general: T8595: clean leaked internal references --- AGENTS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'AGENTS.md') diff --git a/AGENTS.md b/AGENTS.md index 19ae348..a9d4815 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -45,7 +45,7 @@ One of the canonical 14 VyOS-image build packages, listed in `VyOS-Networks/vyos ## Mirror relationship -Mirror twin: `VyOS-Networks/hvinfo`. Canonical side is **here** (`vyos/hvinfo`). Per the relations doc §8.4, `VyOS-Networks/hvinfo` has its workflows on the `git-actions` branch — that is **not** the canonical state; defer to this repo. +Mirror twin: `VyOS-Networks/hvinfo`. Canonical side is **here** (`vyos/hvinfo`). Per the cross-repo audit §8.4, `VyOS-Networks/hvinfo` has its workflows on the `git-actions` branch — that is **not** the canonical state; defer to this repo. ## Notes for future contributors -- cgit v1.2.3 From bd3a4e9005c2d02f88307f3961332021f866db9a Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 7 May 2026 19:27:04 +0300 Subject: general: T8595: scrub private-org references from public AGENTS.md --- AGENTS.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) (limited to 'AGENTS.md') diff --git a/AGENTS.md b/AGENTS.md index a9d4815..4cdc2a3 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -35,7 +35,7 @@ No automated test suite; the binary itself is the test (run on each target hyper ## Cross-repo context -One of the canonical 14 VyOS-image build packages, listed in `VyOS-Networks/vyos-build-packages/repos.toml`. Built into VyOS images by `vyos-build` and consumed at runtime by `vyos-1x` to detect virtualisation context. Native-package category — no application-level test runner beyond `dpkg-buildpackage`. +One of the canonical 14 VyOS-image build packages, listed in an internal repository. Built into VyOS images by `vyos-build` and consumed at runtime by `vyos-1x` to detect virtualisation context. Native-package category — no application-level test runner beyond `dpkg-buildpackage`. ## Conventions @@ -43,10 +43,6 @@ One of the canonical 14 VyOS-image build packages, listed in `VyOS-Networks/vyos - Author: Daniil Baturin; one of the very few Ada packages in the VyOS ecosystem. - License: GPL-2-or-later. -## Mirror relationship - -Mirror twin: `VyOS-Networks/hvinfo`. Canonical side is **here** (`vyos/hvinfo`). Per the cross-repo audit §8.4, `VyOS-Networks/hvinfo` has its workflows on the `git-actions` branch — that is **not** the canonical state; defer to this repo. - ## Notes for future contributors - Build needs Ada 2005 toolchain (`gnat`, `gprbuild`, `gnatprep`). -- cgit v1.2.3