Skip to content

Commit

Permalink
doc: Remove final markdown references
Browse files Browse the repository at this point in the history
There are some leftover Markdown references and Markdown-related
tooling. Seeing as there are no Markdown files left, we can kill it all
with fire.

Signed-off-by: Stephen Finucane <[email protected]>
Signed-off-by: Russell Bryant <[email protected]>
  • Loading branch information
stephenfin authored and russellb committed Nov 7, 2016
1 parent 673b80e commit 60230e0
Showing 5 changed files with 6 additions and 28 deletions.
2 changes: 1 addition & 1 deletion DocumentationStyle.rst
Original file line number Diff line number Diff line change
@@ -48,7 +48,7 @@ Basics
~~~~~~

Many of the basic documentation guidelines match those of the `coding style
guide <CodingStyle.md>`__.
guide <CodingStyle.rst>`__.

- Use reStructuredText (reST) for all documentation.

2 changes: 1 addition & 1 deletion INSTALL.rst
Original file line number Diff line number Diff line change
@@ -80,7 +80,7 @@ vSwitch distribution or to use the kernel module built into the Linux kernel
are not available in the Open vSwitch kernel datapath that ships as part of the
upstream Linux kernel?" for more information on this trade-off. You may also
use the userspace-only implementation, at some cost in features and performance
(see the `userspace installation guide <INSTALL.userspace.md>`__ for details).
(see the `userspace installation guide <INSTALL.userspace.rst>`__ for details).

To compile the kernel module on Linux, you must also install the
following:
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
@@ -74,7 +74,7 @@ What other documentation is available?
--------------------------------------

To install Open vSwitch on a regular Linux or FreeBSD host, please read the
`installation guide <INSTALL.md>`__. For specifics around installation on a
`installation guide <INSTALL.rst>`__. For specifics around installation on a
specific platform, please see one of the below installation guides:

- `Debian <INSTALL.Debian.rst>`__
26 changes: 2 additions & 24 deletions build-aux/dist-docs
Original file line number Diff line number Diff line change
@@ -34,7 +34,6 @@ search_path () {
exit 1
}
search_path man
search_path markdown
search_path rst2html
search_path ps2pdf

@@ -63,36 +62,15 @@ cat >&3 <<EOF
EOF

# Add top-level documentation to index.html, giving it .txt extensions so that
# the webserver doesn't serve it as Markdown/rST and make your web browser try
# to invoke some kind of external helper you don't have installed.
# the webserver doesn't serve it as rST and make your web browser try to invoke
# some kind of external helper you don't have installed.
#
# Also translate documentation to HTML.
for file
do
title=`head -1 "$srcdir/$file"`
dir=$distdir/`dirname $file`; test -d "$dir" || mkdir "$dir"
case $file in
*.md)
cp "$srcdir/$file" "$distdir/$file.txt"
ln -s $(basename "$file.txt") "$distdir/$file"
(cat <<EOF
<html><head>
<meta charset="UTF-8"></head>
<link rel="stylesheet" type="text/css" href="style.css">
<title>$file (Open vSwitch $VERSION)</title>
</head><body>
EOF
markdown "$distdir/$file.txt"
echo "</body></html>") > "$distdir/$file.html"
cat <<EOF
<tr>
<td>$file</td>
<td>$title</td>
<td><a href="$file.html">HTML</a>, <a href="$file.txt">plain text</a></td>
</tr>
EOF
;;

*.rst)
title=`grep -A 1 -e "^=" $srcdir/$file | sed -n 2p`
cp "$srcdir/$file" "$distdir/$file.txt"
2 changes: 1 addition & 1 deletion utilities/ovs-ctl.8
Original file line number Diff line number Diff line change
@@ -502,5 +502,5 @@ distribution are good examples of how to use \fBovs\-ctl\fR.
.
.SH "SEE ALSO"
.
\fBREADME.rst\fR, \fBINSTALL.Linux.md\fR, \fBovsdb\-server\fR(8),
\fBREADME.rst\fR, \fBINSTALL.Linux.rst\fR, \fBovsdb\-server\fR(8),
\fBovs\-vswitchd\fR(8).

0 comments on commit 60230e0

Please sign in to comment.