On Thu, 2019-05-16 at 16:40 +0300, Ilya Maximets wrote: > 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.maxim...@samsung.com>
Good call. Acked-by: Stephen Finucane <step...@that.guru> > --- > Documentation/intro/what-is-ovs.rst | 8 ++++---- > README.rst | 5 +++-- > 2 files changed, 7 insertions(+), 6 deletions(-) > > diff --git a/Documentation/intro/what-is-ovs.rst > b/Documentation/intro/what-is-ovs.rst > index bf7071f7a..002e1b063 100644 > --- a/Documentation/intro/what-is-ovs.rst > +++ b/Documentation/intro/what-is-ovs.rst > @@ -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? > 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 _______________________________________________ dev mailing list d...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-dev