doc: Convert DESIGN to rST

This is a top-level document, so plain old rST is preferred. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Russell Bryant <russell@ovn.org>
openvswitch · Nov 3, 2016 · 368ed58 · 368ed58
1 parent 23bca5a
commit 368ed58
Show file tree

Hide file tree

Showing 9 changed files with 1,170 additions and 1,100 deletions.
diff --git a/DESIGN.md b/DESIGN.md
diff --git a/DESIGN.rst b/DESIGN.rst
diff --git a/Makefile.am b/Makefile.am
@@ -68,7 +68,7 @@ PYCOV_CLEAN_FILES = build-aux/check-structs,cover
 docs = \
 	CONTRIBUTING.rst \
 	CodingStyle.rst \
-	DESIGN.md \
+	DESIGN.rst \
 	DocumentationStyle.rst \
 	FAQ.rst \
 	INSTALL.rst \

diff --git a/include/openvswitch/ofp-util.h b/include/openvswitch/ofp-util.h
@@ -813,7 +813,7 @@ struct ofputil_table_features {
      * supported, otherwise 0.  For other versions, they are decoded as -1 and
      * ignored for encoding.
      *
-     * See the section "OFPTC_* Table Configuration" in DESIGN.md for more
+     * See the section "OFPTC_* Table Configuration" in DESIGN.rst for more
      * details of how OpenFlow has changed in this area.
      */
     enum ofputil_table_miss miss_config; /* OF1.1 and 1.2 only. */

diff --git a/lib/ofp-util.c b/lib/ofp-util.c
@@ -5675,7 +5675,7 @@ ofputil_encode_table_config(enum ofputil_table_miss miss,
                             enum ofp_version version)
 {
     uint32_t config = 0;
-    /* See the section "OFPTC_* Table Configuration" in DESIGN.md for more
+    /* See the section "OFPTC_* Table Configuration" in DESIGN.rst for more
      * information on the crazy evolution of this field. */
     switch (version) {
     case OFP10_VERSION:

diff --git a/ovn/controller/pinctrl.c b/ovn/controller/pinctrl.c
@@ -732,7 +732,7 @@ pinctrl_recv(const struct ofp_header *oh, enum ofptype type)
         queue_msg(make_echo_reply(oh));
     } else if (type == OFPTYPE_GET_CONFIG_REPLY) {
         /* Enable asynchronous messages (see "Asynchronous Messages" in
-         * DESIGN.md for more information). */
+         * DESIGN.rst for more information). */
         struct ofputil_switch_config config;
 
         ofputil_decode_get_config_reply(oh, &config);

diff --git a/ovn/ovn-architecture.7.xml b/ovn/ovn-architecture.7.xml
@@ -342,7 +342,7 @@
       It's possible, however, for some other bridge in the same system to have
       an in-band remote controller, and in that case this suppresses the flows
       that in-band control would ordinarily set up.  See <code>In-Band
-      Control</code> in <code>DESIGN.md</code> for more information.
+      Control</code> in <code>DESIGN.rst</code> for more information.
     </dd>
   </dl>
 

diff --git a/rhel/openvswitch-fedora.spec.in b/rhel/openvswitch-fedora.spec.in
@@ -474,7 +474,7 @@ fi
 %{_mandir}/man8/ovs-vswitchd.8*
 %{_mandir}/man8/ovs-parse-backtrace.8*
 %{_mandir}/man8/ovs-testcontroller.8*
-%doc COPYING DESIGN.md INSTALL.SSL.md NOTICE README.rst WHY-OVS.rst
+%doc COPYING DESIGN.rst INSTALL.SSL.md NOTICE README.rst WHY-OVS.rst
 %doc FAQ.rst NEWS INSTALL.DPDK.rst rhel/README.RHEL
 /var/lib/openvswitch
 /var/log/openvswitch

diff --git a/rhel/openvswitch.spec.in b/rhel/openvswitch.spec.in
@@ -247,7 +247,7 @@ exit 0
 /usr/share/openvswitch/scripts/sysconfig.template
 /usr/share/openvswitch/vswitch.ovsschema
 /usr/share/openvswitch/vtep.ovsschema
-%doc COPYING DESIGN.md INSTALL.SSL.md NOTICE README.rst WHY-OVS.rst FAQ.rst NEWS
+%doc COPYING DESIGN.rst INSTALL.SSL.md NOTICE README.rst WHY-OVS.rst FAQ.rst NEWS
 %doc INSTALL.DPDK.rst rhel/README.RHEL README-native-tunneling.rst
 /var/lib/openvswitch
 /var/log/openvswitch