Skip to content

Commit d4cb478

Browse files
jnohlgardsmira
jnohlgard
authored and
smira
committed
docs: improve field description for BridgeSTP, BridgeVLAN
Add more clarifying notes. Signed-off-by: Joakim Nohlgård <[email protected]> Signed-off-by: Andrey Smirnov <[email protected]>
1 parent 7329824 commit d4cb478

File tree

5 files changed

+26
-26
lines changed

5 files changed

+26
-26
lines changed

‎pkg/machinery/config/schemas/config.schema.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -901,16 +901,16 @@
901901
"stp": {
902902
"$ref": "#/$defs/v1alpha1.STP",
903903
"title": "stp",
904-
"description": "A bridge option.\nPlease see the official kernel documentation.\n",
905-
"markdownDescription": "A bridge option.\nPlease see the official kernel documentation.",
906-
"x-intellij-html-description": "\u003cp\u003eA bridge option.\nPlease see the official kernel documentation.\u003c/p\u003e\n"
904+
"description": "Enable STP on this bridge.\nPlease see the official kernel documentation.\n",
905+
"markdownDescription": "Enable STP on this bridge.\nPlease see the official kernel documentation.",
906+
"x-intellij-html-description": "\u003cp\u003eEnable STP on this bridge.\nPlease see the official kernel documentation.\u003c/p\u003e\n"
907907
},
908908
"vlan": {
909909
"$ref": "#/$defs/v1alpha1.BridgeVLAN",
910910
"title": "vlan",
911-
"description": "A bridge option.\nPlease see the official kernel documentation.\n",
912-
"markdownDescription": "A bridge option.\nPlease see the official kernel documentation.",
913-
"x-intellij-html-description": "\u003cp\u003eA bridge option.\nPlease see the official kernel documentation.\u003c/p\u003e\n"
911+
"description": "Enable VLAN-awareness on this bridge.\nPlease see the official kernel documentation.\n",
912+
"markdownDescription": "Enable VLAN-awareness on this bridge.\nPlease see the official kernel documentation.",
913+
"x-intellij-html-description": "\u003cp\u003eEnable VLAN-awareness on this bridge.\nPlease see the official kernel documentation.\u003c/p\u003e\n"
914914
}
915915
},
916916
"additionalProperties": false,

‎pkg/machinery/config/types/v1alpha1/v1alpha1_types.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1997,11 +1997,11 @@ type Bridge struct {
19971997
// description: The interfaces that make up the bridge.
19981998
BridgedInterfaces []string `yaml:"interfaces"`
19991999
// description: |
2000-
// A bridge option.
2000+
// Enable STP on this bridge.
20012001
// Please see the official kernel documentation.
20022002
BridgeSTP *STP `yaml:"stp,omitempty"`
20032003
// description: |
2004-
// A bridge option.
2004+
// Enable VLAN-awareness on this bridge.
20052005
// Please see the official kernel documentation.
20062006
BridgeVLAN *BridgeVLAN `yaml:"vlan,omitempty"`
20072007
}

‎pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎website/content/v1.9/reference/configuration/v1alpha1/config.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ network:
200200
# interfaces:
201201
# - enxda4042ca9a51
202202
# - enxae2a6774c259
203-
# # A bridge option.
203+
# # Enable STP on this bridge.
204204
# stp:
205205
# enabled: true # Whether Spanning Tree Protocol (STP) is enabled.
206206

@@ -771,7 +771,7 @@ machine:
771771
# interfaces:
772772
# - enxda4042ca9a51
773773
# - enxae2a6774c259
774-
# # A bridge option.
774+
# # Enable STP on this bridge.
775775
# stp:
776776
# enabled: true # Whether Spanning Tree Protocol (STP) is enabled.
777777

@@ -882,7 +882,7 @@ interfaces:
882882
# interfaces:
883883
# - enxda4042ca9a51
884884
# - enxae2a6774c259
885-
# # A bridge option.
885+
# # Enable STP on this bridge.
886886
# stp:
887887
# enabled: true # Whether Spanning Tree Protocol (STP) is enabled.
888888

@@ -1002,7 +1002,7 @@ machine:
10021002
# interfaces:
10031003
# - enxda4042ca9a51
10041004
# - enxae2a6774c259
1005-
# # A bridge option.
1005+
# # Enable STP on this bridge.
10061006
# stp:
10071007
# enabled: true # Whether Spanning Tree Protocol (STP) is enabled.
10081008

@@ -1094,7 +1094,7 @@ bridge:
10941094
interfaces:
10951095
- enxda4042ca9a51
10961096
- enxae2a6774c259
1097-
# A bridge option.
1097+
# Enable STP on this bridge.
10981098
stp:
10991099
enabled: true # Whether Spanning Tree Protocol (STP) is enabled.
11001100
{{< /highlight >}}</details> | |
@@ -1352,7 +1352,7 @@ machine:
13521352
interfaces:
13531353
- enxda4042ca9a51
13541354
- enxae2a6774c259
1355-
# A bridge option.
1355+
# Enable STP on this bridge.
13561356
stp:
13571357
enabled: true # Whether Spanning Tree Protocol (STP) is enabled.
13581358
{{< /highlight >}}
@@ -1361,8 +1361,8 @@ machine:
13611361
| Field | Type | Description | Value(s) |
13621362
|-------|------|-------------|----------|
13631363
|`interfaces` |[]string |The interfaces that make up the bridge. | |
1364-
|`stp` |<a href="#Config.machine.network.interfaces..bridge.stp">STP</a> |<details><summary>A bridge option.</summary>Please see the official kernel documentation.</details> | |
1365-
|`vlan` |<a href="#Config.machine.network.interfaces..bridge.vlan">BridgeVLAN</a> |<details><summary>A bridge option.</summary>Please see the official kernel documentation.</details> | |
1364+
|`stp` |<a href="#Config.machine.network.interfaces..bridge.stp">STP</a> |<details><summary>Enable STP on this bridge.</summary>Please see the official kernel documentation.</details> | |
1365+
|`vlan` |<a href="#Config.machine.network.interfaces..bridge.vlan">BridgeVLAN</a> |<details><summary>Enable VLAN-awareness on this bridge.</summary>Please see the official kernel documentation.</details> | |
13661366

13671367

13681368

‎website/content/v1.9/schemas/config.schema.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -901,16 +901,16 @@
901901
"stp": {
902902
"$ref": "#/$defs/v1alpha1.STP",
903903
"title": "stp",
904-
"description": "A bridge option.\nPlease see the official kernel documentation.\n",
905-
"markdownDescription": "A bridge option.\nPlease see the official kernel documentation.",
906-
"x-intellij-html-description": "\u003cp\u003eA bridge option.\nPlease see the official kernel documentation.\u003c/p\u003e\n"
904+
"description": "Enable STP on this bridge.\nPlease see the official kernel documentation.\n",
905+
"markdownDescription": "Enable STP on this bridge.\nPlease see the official kernel documentation.",
906+
"x-intellij-html-description": "\u003cp\u003eEnable STP on this bridge.\nPlease see the official kernel documentation.\u003c/p\u003e\n"
907907
},
908908
"vlan": {
909909
"$ref": "#/$defs/v1alpha1.BridgeVLAN",
910910
"title": "vlan",
911-
"description": "A bridge option.\nPlease see the official kernel documentation.\n",
912-
"markdownDescription": "A bridge option.\nPlease see the official kernel documentation.",
913-
"x-intellij-html-description": "\u003cp\u003eA bridge option.\nPlease see the official kernel documentation.\u003c/p\u003e\n"
911+
"description": "Enable VLAN-awareness on this bridge.\nPlease see the official kernel documentation.\n",
912+
"markdownDescription": "Enable VLAN-awareness on this bridge.\nPlease see the official kernel documentation.",
913+
"x-intellij-html-description": "\u003cp\u003eEnable VLAN-awareness on this bridge.\nPlease see the official kernel documentation.\u003c/p\u003e\n"
914914
}
915915
},
916916
"additionalProperties": false,

0 commit comments

Comments
 (0)