We're going to convert all docs to reStructuredText, so the "legacy documents" warning is going to become outdated rather quickly. Simply remove it.
Signed-off-by: Stephen Finucane <step...@that.guru> --- DocumentationStyle.rst | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/DocumentationStyle.rst b/DocumentationStyle.rst index 4b36618..d563284 100644 --- a/DocumentationStyle.rst +++ b/DocumentationStyle.rst @@ -28,7 +28,9 @@ Open vSwitch Documentation Style ================================ This file describes the documentation style used in all documentation found in -Open vSwitch. All documents should follow this guide. +Open vSwitch. Documentation includes any documents found in ``Documentation`` +along with any ``README``, ``INSTALL``, or generally ``rst`` suffixed documents +found in the project tree. reStructuredText vs. Sphinx --------------------------- @@ -53,10 +55,6 @@ guide <CodingStyle.md>`__. Sphinx extensions can be used, but only for documentation in the ``Documentation`` folder. - .. note:: - Some legacy documents may exist in other formats. When time allows, these - should be converted to reST. - - Limit lines at 79 characters. .. note:: @@ -169,7 +167,7 @@ Graphic tables +--------------+---------------+ .. note:: - The ``table`` role (`` .. table:: <name>``) can be safely omitted. + The ``table`` role - ``.. table:: <name>`` - can be safely omitted. List tables +++++++++++ -- 2.7.4 _______________________________________________ dev mailing list dev@openvswitch.org http://openvswitch.org/mailman/listinfo/dev