Skip to content

Commit 66b5874

Browse files
silopoliscathay4t
authored andcommitted
docs: fix wording and grammar in gen_conf.md
Signed-off-by: Jérémie Tarot (@silopolis) <[email protected]>
1 parent 4798942 commit 66b5874

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

features/gen_conf.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,19 @@
22

33
New feature in nmstate 1.0.2.
44

5-
When you have no access to the host network stack but would like nmstate
6-
to generate the network configuration files for you save it. You may use
7-
* Python API: `libnmstate.generate_configurations(desired_state)`
8-
* CLI: `nmstatectl gc <path_to_state_json_or_yaml_file>`
5+
When you have no access to the host network stack, but would like nmstate
6+
to generate the network configuration files for you to save it, you may use:
97

10-
This function will not access network stack, so user have to provide
11-
full network states and no merge action will be done against current
12-
network status. If any undefined interface mentioned as port of
13-
bond/bridge/team/vlan and etc, nmstate is assuming undefined interface is
14-
with type of `ethernet`.
8+
* Python API: `libnmstate.generate_configurations(desired_state)`
9+
* CLI: `nmstatectl gc <path_to_state_json_or_yaml_file>`
1510

16-
The output would like in the format like:
11+
This function will not access the network stack, so the user has to provide
12+
full network states, and no merge action will be done against current
13+
network status. If any undefined interface is mentioned as port of
14+
bond/bridge/team/vlan/etc, nmstate assumes the undefined interface is
15+
of type `ethernet`.
16+
17+
The output should follow the format below:
1718

1819
```python
1920
{
@@ -39,7 +40,7 @@ interfaces:
3940
```
4041

4142
The STDOUT of `nmstatectl gc bond.yml` will contain below information
42-
for you to saved the configuration into NetworkManager folder by your own
43+
for you to save into the NetworkManager configuration folder by your own
4344
tools:
4445

4546

0 commit comments

Comments
 (0)