]> git.proxmox.com Git - mirror_ovs.git/commitdiff
doc: Fix cropped what-is-ovs page.
authorIlya Maximets <i.maximets@samsung.com>
Thu, 16 May 2019 13:40:24 +0000 (16:40 +0300)
committerIlya Maximets <i.maximets@samsung.com>
Fri, 17 May 2019 06:59:04 +0000 (09:59 +0300)
Despite of comments in both files no-one ever adjusted start/end-line
in 'what-is-ovs' document. As a result, current document contains
truncated "tools" section.

Let's replace start/end-line with start-after/end-before which requires
less attention. Additionally, 'make docs-check' will fail if specified
lines will not be found, i.e it'll be harder to mess up the docs again.

"Fixes" tag points to commit that broke the lines first.

Fixes: 602e24ee189b ("doc: Remove experimental warning for DPDK.")
Signed-off-by: Ilya Maximets <i.maximets@samsung.com>
Acked-by: Stephen Finucane <stephen@that.guru>
Documentation/intro/what-is-ovs.rst
README.rst

index bf7071f7a8421fd36955660e0d7ca39cf765cb40..803ec3a0330f173c52262be0db1be829da9ebcd7 100644 (file)
@@ -33,9 +33,9 @@ What Is Open vSwitch?
 Overview
 --------
 
-.. NOTE(stephenfin): The below line numbers may need to be updated if the
-   README is modified
+.. NOTE(stephenfin): The below start-after/end-before may need to be updated
+   if the README is modified.
 
 .. include:: ../../README.rst
-   :start-line: 13
-   :end-line: 71
+   :start-after: What is Open vSwitch?
+   :end-before: What other documentation is available?
index 4c9d9edddcee52babf426fc5485e85fc1e114b5a..54d06d04bea88cace90b8a5729a69324f11c03d9 100644 (file)
@@ -1,5 +1,6 @@
-.. NOTE(stephenfin): If making changes to this file, ensure that the line
-   numbers found in 'Documentation/intro/what-is-ovs' are kept up-to-date.
+.. NOTE(stephenfin): If making changes to this file, ensure that the
+   start-after/end-before lines found in 'Documentation/intro/what-is-ovs'
+   are kept up-to-date.
 
 ============
 Open vSwitch