From 06eb0ff5d39ce8b96716a821deb035eefc25ac88 Mon Sep 17 00:00:00 2001
From: Pavel Cahyna <pcahyna@users.noreply.github.com>
Date: Fri, 9 Mar 2018 15:01:56 +0100
Subject: [PATCH] doc: document the ethernet specific options.

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index 4f63fdc..56f5d67 100644
--- a/README.md
+++ b/README.md
@@ -317,6 +317,25 @@ be deleted by the role.
 
 Slaves to bridge/bond/team devices cannot specify `ip` settings.
 
+### `type: ethernet`
+
+Ethernet-specific options can be set using the connection profile variable `ethernet`. This
+variable should be specified as a dictionary with the following items (options): `autoneg`, `speed` and `duplex`,
+which correspond to the settings of the `ethtool` utility with the same name. `speed` is an
+integer giving the speed in Mb/s, the valid values of `duplex` are `half` and `full` and
+`autoneg` accepts a boolean value.
+
+```yaml
+network_connections:
+  - name: "eth0"
+    type: "ethernet"
+
+    ethernet:
+      autoneg: false
+      speed: 1000
+      duplex: full
+```
+
 ### Virtual types and Slaves
 
 Device types like `bridge`, `bond`, `team` work similar: