From 3dabcb0210d70749d2672493c1a5447708936c88 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 7 May 2026 14:31:58 +0300 Subject: general: T8595: add AGENTS.md --- .github/copilot-instructions.md | 1 + AGENTS.md | 50 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+) create mode 120000 .github/copilot-instructions.md create mode 100644 AGENTS.md diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 120000 index 0000000..be77ac8 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1 @@ +../AGENTS.md \ No newline at end of file diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..736aad1 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,50 @@ +# AGENTS.md + +## Project purpose + +VyOS fork of `biosdevname` — a Dell-originated utility that maps Linux kernel network-device names (e.g. `eth0`) to BIOS/chassis-supplied names (e.g. `Gb1`). Ships as the `vyatta-biosdevname` Debian package and is invoked by udev rules during interface naming. + +## Tech stack + +- C, GNU autotools (`configure.ac`, `Makefile.am`, `ltmain.sh`). +- Debian packaging in `debian/` (debhelper >= 5, `autotools-dev`, `libpci-dev`, `autoconf`, `automake`). +- License: GPL-2.0 (per `COPYING`). + +## Build / test / run + +```sh +autoreconf -fi +./configure +make +dpkg-buildpackage -us -uc +``` + +No in-tree test runner. + +## Repository layout + +- `src/` — main biosdevname source. +- `biosdevname.1` — man page. +- `biosdevname.rules.in` — udev rules template. +- `biosdevname.spec.fedora.in`, `biosdevname.spec.suse.in` — RPM specs (upstream). +- `debian/`. + +## Cross-repo context + +Listed in `VyOS-Networks/vyos-build-packages/repos.toml`. Pulled into the ISO via `vyos/vyos-build`. Provides predictable interface naming used throughout `vyos-1x`'s ifconfig logic. + +## Conventions + +- Default branch `current`. +- Commit / PR title format: `component: T12345: description` (Phorge task ID at https://vyos.dev). +- Active workflows: `cla-check.yml`, `trigger-rebuild-repo-package.yml` — wired into the rebuild-dispatch chain, but **not** the PR-mirror pipeline. +- Treat as upstream-vendored; minimise diffs against the original Dell biosdevname. + +## Mirror relationship + +Mirror twin: `VyOS-Networks/vyatta-biosdevname`. Canonical side is here. The VyOS-Networks twin's default branch is the experimental `git-actions` (per relations doc §8.2) — ignore for canonical state. + +## Notes for future contributors + +- Renaming the source/binary package from upstream `biosdevname` to `vyatta-biosdevname` is intentional — don't revert. +- Any change here can affect interface naming on every VyOS install; coordinate with `vyos-1x` if you change rule names. -- cgit v1.2.3 From ebb133f936e48fd5aa20a44924016b6299702c72 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 7 May 2026 19:04:36 +0300 Subject: general: T8595: clean leaked internal references --- AGENTS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/AGENTS.md b/AGENTS.md index 736aad1..2c9fbbc 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -42,7 +42,7 @@ Listed in `VyOS-Networks/vyos-build-packages/repos.toml`. Pulled into the ISO vi ## Mirror relationship -Mirror twin: `VyOS-Networks/vyatta-biosdevname`. Canonical side is here. The VyOS-Networks twin's default branch is the experimental `git-actions` (per relations doc §8.2) — ignore for canonical state. +Mirror twin: `VyOS-Networks/vyatta-biosdevname`. Canonical side is here. The VyOS-Networks twin's default branch is the experimental `git-actions` (per the cross-repo audit) — ignore for canonical state. ## Notes for future contributors -- cgit v1.2.3 From 63d431010670b640a84f7b51141a4e6a4d168f47 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 7 May 2026 19:28:20 +0300 Subject: general: T8595: scrub private-org references from public AGENTS.md --- AGENTS.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 2c9fbbc..799d902 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -31,7 +31,7 @@ No in-tree test runner. ## Cross-repo context -Listed in `VyOS-Networks/vyos-build-packages/repos.toml`. Pulled into the ISO via `vyos/vyos-build`. Provides predictable interface naming used throughout `vyos-1x`'s ifconfig logic. +Listed in an internal repository. Pulled into the ISO via `vyos/vyos-build`. Provides predictable interface naming used throughout `vyos-1x`'s ifconfig logic. ## Conventions @@ -40,10 +40,6 @@ Listed in `VyOS-Networks/vyos-build-packages/repos.toml`. Pulled into the ISO vi - Active workflows: `cla-check.yml`, `trigger-rebuild-repo-package.yml` — wired into the rebuild-dispatch chain, but **not** the PR-mirror pipeline. - Treat as upstream-vendored; minimise diffs against the original Dell biosdevname. -## Mirror relationship - -Mirror twin: `VyOS-Networks/vyatta-biosdevname`. Canonical side is here. The VyOS-Networks twin's default branch is the experimental `git-actions` (per the cross-repo audit) — ignore for canonical state. - ## Notes for future contributors - Renaming the source/binary package from upstream `biosdevname` to `vyatta-biosdevname` is intentional — don't revert. -- cgit v1.2.3