diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-14 01:29:27 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-14 01:29:27 +0300 |
| commit | 8556c14f4cc54b11cb5434288494210f22b56b49 (patch) | |
| tree | 7caa8527caf0b9facafe887d1ead7452b94c1049 /docs/_include | |
| parent | cbbec9ed09e23bfcbc36c06ed08db63a53f90faa (diff) | |
| download | vyos-documentation-8556c14f4cc54b11cb5434288494210f22b56b49.tar.gz vyos-documentation-8556c14f4cc54b11cb5434288494210f22b56b49.zip | |
fix(includes): break the RST `.. include::` chain that pulls need_improvement.txt on sagitta
`_include/interface-vlan-8021ad.txt` started with
`.. include:: /_include/need_improvement.txt`. After PR #2008 the
`{cmdincludemd}` directive parses included `.txt` content as RST, so
the three MD pages that consume interface-vlan-8021ad.txt
(ethernet.md:161, virtual-ethernet.md:46, wireless.md:485) reach
need_improvement.txt through an RST parser.
`need_improvement.txt` is now MyST (`::::{only} not latex / :::{admonition}`),
so the RST parser would render those directives as literal text on
three interface pages.
Rolling does not have this regression — rolling's
`_include/interface-vlan-8021ad.txt` is MyST/MD content and does not
include need_improvement.txt at all. The sagitta file is older
RST-shape content with the include chain at the top, an artifact of the
mid-migration state on sagitta.
Strip line 1 (`.. include:: /_include/need_improvement.txt`) and the
blank line that follows. The QinQ overview content below is untouched
and still parses as RST under `{cmdincludemd}`.
Spotted by Copilot inline review on #2026.
🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to 'docs/_include')
| -rw-r--r-- | docs/_include/interface-vlan-8021ad.txt | 2 |
1 files changed, 0 insertions, 2 deletions
diff --git a/docs/_include/interface-vlan-8021ad.txt b/docs/_include/interface-vlan-8021ad.txt index ad808880..f3b4aec0 100644 --- a/docs/_include/interface-vlan-8021ad.txt +++ b/docs/_include/interface-vlan-8021ad.txt @@ -1,5 +1,3 @@ -.. include:: /_include/need_improvement.txt - IEEE 802.1ad_ was an Ethernet networking standard informally known as QinQ as an amendment to IEEE standard 802.1q VLAN interfaces as described above. 802.1ad was incorporated into the base 802.1q_ standard in 2011. The technique |