vyos-documentation.git/docs/contributing, branch build-vyos-fixesVyOS readthedocs (mirror of https://github.com/vyos/vyos-documentation.git)
https://git.amelek.net/vyos/vyos-documentation.git/atom?h=build-vyos-fixes2026-11-07T06:38:37+00:00docs: build-vyos: document build.py kernel build wrapper2026-11-07T06:38:37+00:00Christian Breunigchristian@breunig.cc2026-11-07T06:38:37+00:00urn:sha1:792617899e4f2f82fe1bc2dde71d62cee1ac5d4c
build-kernel.sh only builds the kernel. The build.py wrapper in
scripts/package-build/linux-kernel installs the build dependencies,
fetches and verifies the kernel source, builds the kernel and all
firmware and out-of-tree modules defined in package.toml.
- Document build.py usage and its --packages and
--install-dependencies options.
- Update paths from packages/linux-kernel to
scripts/package-build/linux-kernel and from data/defaults.json to
data/defaults.toml; drop references to the removed Jenkinsfile.
- Update the out-of-tree module list to match package.toml.
- Drop the per-module build instructions which referenced renamed or
removed helper scripts, and the no longer existing ADD_FW_FILES.
docs: build-vyos: update kernel version examples to 6.18.602026-11-07T06:38:37+00:00Christian Breunigchristian@breunig.cc2026-11-07T06:38:37+00:00urn:sha1:3a065de9d52f3756d6c1758bb1ad5e28e70f9ec2docs: build-vyos: add macOS notes for Docker builds2026-11-07T06:38:37+00:00Christian Breunigchristian@breunig.cc2026-11-07T06:38:37+00:00urn:sha1:963820bd103b0a4788c96dcdb5d05637023b4d80
On macOS a Docker volume must be used instead of a bind mount from
the user's home. Also warn about case-insensitive macOS file systems
which break Linux kernel source checkouts.
docs: build-vyos: refer to official Docker install guide2026-11-07T06:38:37+00:00Christian Breunigchristian@breunig.cc2026-11-07T06:38:37+00:00urn:sha1:d60acd171b7f16f0a4fb8635a54679687084990f
The inlined Docker installation steps go stale with every Docker
release. Link to the upstream Debian installation guide instead.
docs: build-vyos: clone vyos-build before it is used2026-11-07T06:38:37+00:00Christian Breunigchristian@breunig.cc2026-11-07T06:38:37+00:00urn:sha1:a567e5435379d88fb9133f6cfd492a50ae50c4dd
The prerequisites assumed an existing vyos-build checkout, but the
repository was only cloned in the "Build ISO" section, and the native
build section showed build commands under a "clone" heading.
- Add a "Get the Source Code" step at the start of the prerequisites
and drop the duplicate clones from "Build from source" and
"Build ISO".
- List Docker before the native build, as it is the recommended way.
- Native build now refers to the "Build ISO" commands.
- Rename the ISO "Packages" subsection to "Custom Packages" and move
the build_custom_packages label to it, as referenced from "Install".
- Group "ISO Build Issues" and the APT verbosity patch under
"Troubleshooting".
- Minor fixes: MyST inline code, list lead-in, kernel checkout path,
stale VyOS 1.3 comment.
T3871: bind interface names to hardware slots instead of hw-id (#2246)2026-10-31T10:53:23+00:00Christian Breunigchristian@breunig.cc2026-10-31T10:53:23+00:00urn:sha1:f939f4eb05f55e7e4c81e1b5dc954c3fc06d2389
* docs: T3871: describe how interface names are assigned
Names are no longer derived from the hw-id node. They are bound to the slot
the hardware occupies and recorded in a mapping file, so document what
decides a name, what happens when a card is replaced or added, and how to
rename an interface.
The troubleshooting page said to pin a MAC with hw-id when interfaces were
renamed after a VM migration or a clone. That node no longer exists and the
situation it describes no longer arises, so replace it with a pointer to the
new section and a note on where to look when an interface really is missing.
* docs: T3871: drop hw-id from the example output
The node is gone from the CLI, so example configuration dumps which still
show it no longer match what a reader sees on their own system. Remove it
from the shown output only; no prose changes. The comparison shown on the
testing page is rewritten rather than trimmed, as deleting the lines would
have left an edit level behind with nothing under it.docs: Remove stale CLI output examples from build-vyos.md2026-06-09T21:49:22+00:00MilaNadl.nadolina@vyos.io2026-06-09T21:49:22+00:00urn:sha1:36e330a9e23ca8614ec0625127a4d359bfdb6c07Update default Git branch in build-vyos.md (#2088)2026-06-09T12:39:47+00:00Quill69414602+teslazonda@users.noreply.github.com2026-06-09T12:39:47+00:00urn:sha1:c4f53a58992bfd9cad39008ed63da358c36814dd
Update the default Git branch in build-vyos.md from 'current' to 'rolling'docs: hard-wrap pre-existing long prose lines to satisfy doc-linter2026-05-11T19:57:57+00:00Claudenoreply@anthropic.com2026-05-11T19:57:57+00:00urn:sha1:a1d046a346e9ec4d0f93cafb7ebf967f636edabe
scripts/doc-linter.py enforces an 80-character limit outside fenced code
blocks and treats any finding as a failure. Wrap long paragraphs in
files that this PR touched so CI passes:
- docs/configuration/protocols/ospf.md: wrap the WireGuard cost note.
- docs/configuration/protocols/traffic-engineering.md: wrap the IS-IS/
OSPF note.
- docs/contributing/debugging.md: wrap the Phabricator paragraph, and
guard the long [bootchart.conf]/[vyatta-cfg] link references at EOF
with `% stop_vyoslinter`/`% start_vyoslinter`.
- docs/vpp/configuration/ipsec.md: wrap the integration, requirements,
algorithm, ACL, VTI example, troubleshooting paragraphs.
Pure reformatting; no semantic changes.
https://claude.ai/code/session_01RDpSBDLSWLKMGnyPCaKECB
docs: fix typos across configuration, contributing, and vpp docs2026-05-11T19:35:04+00:00Claudenoreply@anthropic.com2026-05-11T19:35:04+00:00urn:sha1:d9212421139416f1feb454ea71cfca75fa1ab2b8
Corrections include: adresses->addresses, oder->other, Them->The,
criterias->criteria, seeting->setting, carefull->careful,
beeing->being, reenable->re-enable, wich->which, derection->direction,
Whith->With, assosiate->associate, fpr->for, bootup->boot, trough->through.
https://claude.ai/code/session_01RDpSBDLSWLKMGnyPCaKECB