[ovs-dev] [PATCH 12/23] doc: Convert INSTALL.NetBSD to rST

Stephen Finucane stephen at that.guru
Sun Oct 30 13:29:58 UTC 2016


Signed-off-by: Stephen Finucane <stephen at that.guru>
---
 INSTALL.NetBSD.md  | 38 ---------------------------------
 INSTALL.NetBSD.rst | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 INSTALL.rst        |  2 +-
 Makefile.am        |  2 +-
 4 files changed, 64 insertions(+), 40 deletions(-)
 delete mode 100644 INSTALL.NetBSD.md
 create mode 100644 INSTALL.NetBSD.rst

diff --git a/INSTALL.NetBSD.md b/INSTALL.NetBSD.md
deleted file mode 100644
index b89201a..0000000
--- a/INSTALL.NetBSD.md
+++ /dev/null
@@ -1,38 +0,0 @@
-How to Install Open vSwitch on NetBSD
-=====================================
-
-On NetBSD, you might want to install requirements from pkgsrc.
-In that case, you need at least the following packages.
-
-  * automake
-  * libtool-base
-  * gmake
-  * python27
-  * py27-six
-  * py27-xml
-  * pkg_alternatives
-
-Some components have additional requirements. (See [INSTALL.rst])
-
-Assuming you are running NetBSD/amd64 6.1.2, you can download and
-install pre-built binary packages as the following.
-(You might get some warnings about minor version mismatch.  Don't care.)
-
-    ```
-    # PKG_PATH=http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/amd64/6.1.2/All/
-    # export PKG_PATH
-    # pkg_add automake libtool-base gmake python27 py27-six py27-xml pkg_alternatives
-    ```
-
-NetBSD's `/usr/bin/make` is not GNU make.  GNU make is installed as
-`/usr/pkg/bin/gmake` by the above mentioned `gmake` package.
-
-As all executables installed with pkgsrc are placed in `/usr/pkg/bin/`
-directory, it might be a good idea to add it to your PATH.
-
-Open vSwitch on NetBSD is currently "userspace switch" implementation
-in the sense described in [INSTALL.userspace.rst] and [PORTING.rst].
-
-[INSTALL.rst]:INSTALL.rst
-[INSTALL.userspace.rst]:INSTALL.userspace.rst
-[PORTING.rst]:PORTING.rst
diff --git a/INSTALL.NetBSD.rst b/INSTALL.NetBSD.rst
new file mode 100644
index 0000000..e204c57
--- /dev/null
+++ b/INSTALL.NetBSD.rst
@@ -0,0 +1,62 @@
+..
+      Licensed under the Apache License, Version 2.0 (the "License"); you may
+      not use this file except in compliance with the License. You may obtain
+      a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+      License for the specific language governing permissions and limitations
+      under the License.
+
+      Convention for heading levels in Open vSwitch documentation:
+
+      =======  Heading 0 (reserved for the title in a document)
+      -------  Heading 1
+      ~~~~~~~  Heading 2
+      +++++++  Heading 3
+      '''''''  Heading 4
+
+      Avoid deeper levels because they do not render well.
+
+======================
+Open vSwitch on NetBSD
+======================
+
+On NetBSD, you might want to install requirements from pkgsrc.  In that case,
+you need at least the following packages.
+
+- automake
+- libtool-base
+- gmake
+- python27
+- py27-six
+- py27-xml
+- pkg_alternatives
+
+Some components have additional requirements. Refer to the `general
+installation guide <INSTALL.rst>`__.
+
+Assuming you are running NetBSD/amd64 6.1.2, you can download and install
+pre-built binary packages as the following::
+
+    $ PKG_PATH=http://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/amd64/6.1.2/All/
+    $ export PKG_PATH
+    $ pkg_add automake libtool-base gmake python27 py27-six py27-xml \
+        pkg_alternatives
+
+.. note::
+  You might get some warnings about minor version mismatch. These can be safely
+  ignored.
+
+NetBSD's ``/usr/bin/make`` is not GNU make.  GNU make is installed as
+``/usr/pkg/bin/gmake`` by the above mentioned ``gmake`` package.
+
+As all executables installed with pkgsrc are placed in ``/usr/pkg/bin/``
+directory, it might be a good idea to add it to your PATH.
+
+Open vSwitch on NetBSD is currently "userspace switch" implementation in the
+sense described in the `userspace installation guide <INSTALL.userspace.rst>`__
+and `porting guide <PORTING.rst>`__.
diff --git a/INSTALL.rst b/INSTALL.rst
index 19da164..5c40ab9 100644
--- a/INSTALL.rst
+++ b/INSTALL.rst
@@ -33,7 +33,7 @@ platform, refer to one of these installation guides:
 - `Fedora <INSTALL.Fedora.rst>`__
 - `RHEL <INSTALL.RHEL.md>`__
 - `XenServer <INSTALL.XenServer.rst>`__
-- `NetBSD <INSTALL.NetBSD.md>`__
+- `NetBSD <INSTALL.NetBSD.rst>`__
 - `Windows <INSTALL.Windows.rst>`__
 - `DPDK <INSTALL.DPDK.rst>`__
 
diff --git a/Makefile.am b/Makefile.am
index 15846d9..d032cb7 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -79,7 +79,7 @@ docs = \
 	INSTALL.Fedora.rst \
 	INSTALL.KVM.rst \
 	INSTALL.Libvirt.rst \
-	INSTALL.NetBSD.md \
+	INSTALL.NetBSD.rst \
 	INSTALL.RHEL.md \
 	INSTALL.SELinux.md \
 	INSTALL.SSL.rst \
-- 
2.7.4




More information about the dev mailing list