blob: 545b6f1e1063c91f3b454106699f1870d2204e40 (
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
45
46
|
# 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 an internal repository. Pulled into the ISO via `vyos/vyos-build`. Provides predictable interface naming used throughout `vyos-1x`'s ifconfig logic.
## Conventions
- Default branch `rolling`.
- 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.
## 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.
|
