diff options
| author | Ilya Maximets <i.maximets@samsung.com> | 2019-05-16 16:40:24 +0300 |
|---|---|---|
| committer | Ilya Maximets <i.maximets@samsung.com> | 2019-05-17 09:59:04 +0300 |
| commit | cb82799bc248a284f530a96bfa0a6d475a729dd6 (patch) | |
| tree | ee1acb3fe535226ae771855086c9e487a11890f2 /README.rst | |
| parent | 6d414025da0cfd51d24e7ad8dae828578285ff19 (diff) | |
| download | openvswitch-cb82799bc248a284f530a96bfa0a6d475a729dd6.tar.gz | |
doc: Fix cropped what-is-ovs page.
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>
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/README.rst b/README.rst index 4c9d9eddd..54d06d04b 100644 --- a/README.rst +++ b/README.rst @@ -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 |