From 3cf7acec9315a671c9a0b64f6e0567120970c924 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 14 May 2026 07:39:30 +0300 Subject: docs: drop unused {include} /_include/common-references.txt from debugging --- docs/contributing/debugging.md | 4 ---- 1 file changed, 4 deletions(-) (limited to 'docs/contributing') diff --git a/docs/contributing/debugging.md b/docs/contributing/debugging.md index 73b622c6..cdcd8bf6 100644 --- a/docs/contributing/debugging.md +++ b/docs/contributing/debugging.md @@ -183,9 +183,5 @@ you can use the `/opt/vyatta/sbin/priority.pl` script which lists to you the execution order of the scripts. -```{include} /_include/common-references.txt -``` - - [bootchart.conf]: https://github.com/vyos/vyos-build/blob/current/data/live-build-config/includes.chroot/etc/systemd/bootchart.conf [vyatta-cfg]: https://github.com/vyos/vyatta-cfg -- cgit v1.2.3 From c3d8953388715f6fd7c4341a5787017e63013fdd Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 14 May 2026 07:39:34 +0300 Subject: docs: drop unused {include} /_include/common-references.txt from development --- docs/contributing/development.md | 4 ---- 1 file changed, 4 deletions(-) (limited to 'docs/contributing') diff --git a/docs/contributing/development.md b/docs/contributing/development.md index dcfe257a..b72895cb 100644 --- a/docs/contributing/development.md +++ b/docs/contributing/development.md @@ -678,10 +678,6 @@ to our Debian repository which is used during build time. It is located here: . -```{include} /_include/common-references.txt -``` - - [dockerhub]: https://hub.docker.com/u/vyos/ [ipv4, ipv6]: https://github.com/vyos/vyos-1x/blob/current/interface-definitions/include/interface/address-ipv4-ipv6.xml.i [ipv4, ipv6 and dhcp(v6)]: https://github.com/vyos/vyos-1x/blob/current/interface-definitions/include/interface/address-ipv4-ipv6-dhcp.xml.i -- cgit v1.2.3 From 8f01cebebdcae8ee0bac3bd75ee0dc253278640f Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 14 May 2026 07:39:38 +0300 Subject: docs: drop unused {include} /_include/common-references.txt from issues-features --- docs/contributing/issues-features.md | 2 -- 1 file changed, 2 deletions(-) (limited to 'docs/contributing') diff --git a/docs/contributing/issues-features.md b/docs/contributing/issues-features.md index 6a748f36..7c5d52cb 100644 --- a/docs/contributing/issues-features.md +++ b/docs/contributing/issues-features.md @@ -65,8 +65,6 @@ please search [Phabricator] if there is already a request pending. You can enhance it or if you don't find one, create a new one by use the quick link in the left side under the specific project. -```{include} /_include/common-references.txt -``` [documentation]: https://docs.vyos.io [forum]: https://forum.vyos.io -- cgit v1.2.3 From 272b32f2bf382705a92f198a98f31841f4b49164 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 14 May 2026 07:39:42 +0300 Subject: docs: drop unused {include} /_include/common-references.txt from testing --- docs/contributing/testing.md | 3 --- 1 file changed, 3 deletions(-) (limited to 'docs/contributing') diff --git a/docs/contributing/testing.md b/docs/contributing/testing.md index b2929936..4ac98fe1 100644 --- a/docs/contributing/testing.md +++ b/docs/contributing/testing.md @@ -209,6 +209,3 @@ can be applied - you will get a commit error otherwise. If you are interested how those preconditions are fulfilled check the [vyos-build] repository and the `scripts/check-qemu-install` file. ::: - -```{include} /_include/common-references.txt -``` -- cgit v1.2.3 From 2d2bb46e21fcb3469f5d1f03d25b6950b0671987 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 14 May 2026 07:48:20 +0300 Subject: docs: rewrap long prose lines in debugging to fit 80-char limit --- docs/contributing/debugging.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/contributing') diff --git a/docs/contributing/debugging.md b/docs/contributing/debugging.md index cdcd8bf6..4671c748 100644 --- a/docs/contributing/debugging.md +++ b/docs/contributing/debugging.md @@ -183,5 +183,7 @@ you can use the `/opt/vyatta/sbin/priority.pl` script which lists to you the execution order of the scripts. +% stop_vyoslinter [bootchart.conf]: https://github.com/vyos/vyos-build/blob/current/data/live-build-config/includes.chroot/etc/systemd/bootchart.conf +% start_vyoslinter [vyatta-cfg]: https://github.com/vyos/vyatta-cfg -- cgit v1.2.3 From 63159a85d1c138e216334b736eebd2548c360c01 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 14 May 2026 07:48:26 +0300 Subject: docs: rewrap long prose lines in development to fit 80-char limit --- docs/contributing/development.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) (limited to 'docs/contributing') diff --git a/docs/contributing/development.md b/docs/contributing/development.md index b72895cb..42a1bb97 100644 --- a/docs/contributing/development.md +++ b/docs/contributing/development.md @@ -99,7 +99,8 @@ It is also worth reading Limits: -- We only accept bugfixes in packages other than +- We only accept bugfixes in packages other than + as no new functionality should use the old style templates (`node.def` and Perl/BASH code. Use the new style XML/Python interface instead. @@ -158,8 +159,8 @@ record them in your created Git commit: Follow the above steps on how to "Fork repository to submit a Patch". Instead of uploading "pushing" your changes to GitHub you can export the patches/ -commits and send it to or attach it directly to the bug -(preferred over email) +commits and send it to or attach it +directly to the bug (preferred over email) - Export last commit to patch file: `git format-patch` or export the last two commits into its appropriate patch files: `git format-patch -2` @@ -651,6 +652,7 @@ C++ backend library \[vyatta-cfg\](). This section is a reference of common CLI commands and the respective entry point in the C/C++ code. +% stop_vyoslinter - `set` - @@ -659,6 +661,7 @@ in the C/C++ code. - `commit` - +% start_vyoslinter ## Continuous Integration @@ -679,12 +682,18 @@ to our Debian repository which is used during build time. It is located here: [dockerhub]: https://hub.docker.com/u/vyos/ +% stop_vyoslinter [ipv4, ipv6]: https://github.com/vyos/vyos-1x/blob/current/interface-definitions/include/interface/address-ipv4-ipv6.xml.i [ipv4, ipv6 and dhcp(v6)]: https://github.com/vyos/vyos-1x/blob/current/interface-definitions/include/interface/address-ipv4-ipv6-dhcp.xml.i +% start_vyoslinter [jenkins]: https://jenkins.io/ [jinja2]: https://jinja.palletsprojects.com/ +% stop_vyoslinter [mac address]: https://github.com/vyos/vyos-1x/blob/current/interface-definitions/include/interface/mac.xml.i +% start_vyoslinter [process]: https://blog.vyos.io/vyos-development-digest-10 +% stop_vyoslinter [vlan (vif)]: https://github.com/vyos/vyos-1x/blob/current/interface-definitions/include/interface/vif.xml.i +% start_vyoslinter [vyconf]: https://github.com/vyos/vyconf/tree/master/data/schemata [vyos-1x]: https://github.com/vyos/vyos-1x/tree/current/schema -- cgit v1.2.3 From 03d9ca059285bf85d39d1687e2ece7df3ba64dfc Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 14 May 2026 07:48:32 +0300 Subject: docs: rewrap long prose lines in testing to fit 80-char limit --- docs/contributing/testing.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) (limited to 'docs/contributing') diff --git a/docs/contributing/testing.md b/docs/contributing/testing.md index 4ac98fe1..5ef8b919 100644 --- a/docs/contributing/testing.md +++ b/docs/contributing/testing.md @@ -155,8 +155,9 @@ as member ports. ## Config Load Tests -The other part of our tests are called "config load tests". The config load tests -will load - one after another - arbitrary configuration files to test if the +The other part of our tests are called "config load tests". The config +load tests will load - one after another - arbitrary configuration +files to test if the configuration migration scripts work as designed and that a given set of functionality still can be loaded with a fresh VyOS ISO image. @@ -165,8 +166,9 @@ as a testcase but also as reference if one wants to enable a certain feature. The configurations can be found here: -The entire test is controlled by the main wrapper script `/usr/bin/vyos-configtest` -which behaves in the same way as the main smoketest script. It scans the folder +The entire test is controlled by the main wrapper script +`/usr/bin/vyos-configtest` which behaves in the same way as the main +smoketest script. It scans the folder for potential configuration files and issues a `load` command one after another. ### Manual config load test -- cgit v1.2.3