| Message ID | 20161208125530.17283-12-stephen@that.guru |
|---|---|
| State | Accepted |
| Headers | show |
> From: "Stephen Finucane" <stephen@that.guru> > To: dev@openvswitch.org > Sent: Thursday, December 8, 2016 7:55:30 AM > Subject: [ovs-dev] [PATCH v2 11/11] doc: Remove documentation from distdoc target > > Basic Sphinx integration is now complete. Remove the documentation > aspects of the 'dist-docs' target in favor of the htmldocs target. > > Signed-off-by: Stephen Finucane <stephen@that.guru> > --- > Documentation/automake.mk | 4 +--- > Makefile.am | 7 +------ > build-aux/dist-docs | 50 > +---------------------------------------------- > debian/rules.modules | 2 +- > third-party/automake.mk | 5 +++-- > 5 files changed, 7 insertions(+), 61 deletions(-) > > diff --git a/Documentation/automake.mk b/Documentation/automake.mk > index 58cd650..6657b70 100644 > --- a/Documentation/automake.mk > +++ b/Documentation/automake.mk > @@ -1,7 +1,5 @@ > -docs += \ > - Documentation/group-selection-method-property.txt > - With the initialization of "docs" gone, "make dist-docs" now fails. Is this intentional? $ make dist-docs VERSION=2.6.90 MAKE='make' ./build-aux/dist-docs . ./build-aux/dist-docs: HTML documentation generator for Open vSwitch usage: ./build-aux/dist-docs srcdir docfile... The VERSION environment variable should be set to the Open vSwitch version. Must be invoked from an Open vSwitch build directory. Most conveniently invoked via "make dist-docs". Makefile:6103: recipe for target 'dist-docs' failed make: *** [dist-docs] Error 1
On Tue, Dec 13, 2016 at 3:01 PM, Lance Richardson <lrichard@redhat.com> wrote: > > From: "Stephen Finucane" <stephen@that.guru> > > To: dev@openvswitch.org > > Sent: Thursday, December 8, 2016 7:55:30 AM > > Subject: [ovs-dev] [PATCH v2 11/11] doc: Remove documentation from > distdoc target > > > > Basic Sphinx integration is now complete. Remove the documentation > > aspects of the 'dist-docs' target in favor of the htmldocs target. > > > > Signed-off-by: Stephen Finucane <stephen@that.guru> > > --- > > Documentation/automake.mk | 4 +--- > > Makefile.am | 7 +------ > > build-aux/dist-docs | 50 > > +---------------------------------------------- > > debian/rules.modules | 2 +- > > third-party/automake.mk | 5 +++-- > > 5 files changed, 7 insertions(+), 61 deletions(-) > > > > diff --git a/Documentation/automake.mk b/Documentation/automake.mk > > index 58cd650..6657b70 100644 > > --- a/Documentation/automake.mk > > +++ b/Documentation/automake.mk > > @@ -1,7 +1,5 @@ > > -docs += \ > > - Documentation/group-selection-method-property.txt > > - > > With the initialization of "docs" gone, "make dist-docs" now fails. Is > this intentional? > > $ make dist-docs > VERSION=2.6.90 MAKE='make' ./build-aux/dist-docs . > ./build-aux/dist-docs: HTML documentation generator for Open vSwitch > usage: ./build-aux/dist-docs srcdir docfile... > > The VERSION environment variable should be set to the Open vSwitch version. > Must be invoked from an Open vSwitch build directory. > Most conveniently invoked via "make dist-docs". > Makefile:6103: recipe for target 'dist-docs' failed > make: *** [dist-docs] Error 1 We still need the dist-docs target for rendering all of the man pages, right?
On Tue, Dec 13, 2016 at 03:07:00PM -0500, Russell Bryant wrote: > On Tue, Dec 13, 2016 at 3:01 PM, Lance Richardson <lrichard@redhat.com> > wrote: > > > > From: "Stephen Finucane" <stephen@that.guru> > > > To: dev@openvswitch.org > > > Sent: Thursday, December 8, 2016 7:55:30 AM > > > Subject: [ovs-dev] [PATCH v2 11/11] doc: Remove documentation from > > distdoc target > > > > > > Basic Sphinx integration is now complete. Remove the documentation > > > aspects of the 'dist-docs' target in favor of the htmldocs target. > > > > > > Signed-off-by: Stephen Finucane <stephen@that.guru> > > > --- > > > Documentation/automake.mk | 4 +--- > > > Makefile.am | 7 +------ > > > build-aux/dist-docs | 50 > > > +---------------------------------------------- > > > debian/rules.modules | 2 +- > > > third-party/automake.mk | 5 +++-- > > > 5 files changed, 7 insertions(+), 61 deletions(-) > > > > > > diff --git a/Documentation/automake.mk b/Documentation/automake.mk > > > index 58cd650..6657b70 100644 > > > --- a/Documentation/automake.mk > > > +++ b/Documentation/automake.mk > > > @@ -1,7 +1,5 @@ > > > -docs += \ > > > - Documentation/group-selection-method-property.txt > > > - > > > > With the initialization of "docs" gone, "make dist-docs" now fails. Is > > this intentional? > > > > $ make dist-docs > > VERSION=2.6.90 MAKE='make' ./build-aux/dist-docs . > > ./build-aux/dist-docs: HTML documentation generator for Open vSwitch > > usage: ./build-aux/dist-docs srcdir docfile... > > > > The VERSION environment variable should be set to the Open vSwitch version. > > Must be invoked from an Open vSwitch build directory. > > Most conveniently invoked via "make dist-docs". > > Makefile:6103: recipe for target 'dist-docs' failed > > make: *** [dist-docs] Error 1 > > > We still need the dist-docs target for rendering all of the man pages, > right? Yes. I sent out a fix: https://mail.openvswitch.org/pipermail/ovs-dev/2016-December/326198.html
diff --git a/Documentation/automake.mk b/Documentation/automake.mk index 58cd650..6657b70 100644 --- a/Documentation/automake.mk +++ b/Documentation/automake.mk @@ -1,7 +1,5 @@ -docs += \ - Documentation/group-selection-method-property.txt - EXTRA_DIST += \ + Documentation/group-selection-method-property.txt Documentation/_static/logo.png \ Documentation/conf.py \ Documentation/index.rst \ diff --git a/Makefile.am b/Makefile.am index 1385eff..95dc553 100644 --- a/Makefile.am +++ b/Makefile.am @@ -63,15 +63,11 @@ CLEAN_LOCAL = DISTCLEANFILES = PYCOV_CLEAN_FILES = build-aux/check-structs,cover -# A list of Markdown- or reStructuredText-formatted documentation that will -# automatically be included in the "make dist-docs" output. -docs = \ +EXTRA_DIST = \ AUTHORS.rst \ CONTRIBUTING.rst \ MAINTAINERS.rst \ README.rst -EXTRA_DIST = \ - $(docs) \ NOTICE \ .travis.yml \ .travis/linux-build.sh \ @@ -83,7 +79,6 @@ EXTRA_DIST = \ build-aux/cccl \ build-aux/cksum-schema-check \ build-aux/calculate-schema-cksum \ - build-aux/dist-docs \ build-aux/sodepends.pl \ build-aux/soexpand.pl \ build-aux/xml2nroff \ diff --git a/build-aux/dist-docs b/build-aux/dist-docs index 1d7eeb5..d2d11d7 100755 --- a/build-aux/dist-docs +++ b/build-aux/dist-docs @@ -34,7 +34,6 @@ search_path () { exit 1 } search_path man -search_path rst2html search_path ps2pdf # Create dist-docs directory. @@ -56,54 +55,7 @@ cat >&3 <<EOF <link rel="stylesheet" type="text/css" href="style.css"> <title>Open vSwitch $VERSION Documentation</title> </head><body> -<h1>Open vSwitch $VERSION Documentation</h1> -<h2>Documents</h2> -<table> -EOF - -# Add top-level documentation to index.html, giving it .txt extensions so that -# 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 - *.rst) - title=`grep -A 1 -e "^=" $srcdir/$file | sed -n 2p` - cp "$srcdir/$file" "$distdir/$file.txt" - ln -s $(basename "$file.txt") "$distdir/$file" - rst2html "$distdir/$file.txt" --stylesheet-path="style.css" \ - --link-stylesheet --title="$file (Open vSwitch $VERSION)" \ - > "$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 - ;; - - *) - cp "$srcdir/$file" "$distdir/$file" - cat <<EOF -<tr> - <td>$file</td> - <td>$title</td> - <td><a href="$file">plain text</a></td> -</tr> -EOF - ;; - esac -done >&3 - -# Add header for manpages to index.html. -cat >&3 <<EOF -</table> -<h2>Manpages</h2> +<h1>Open vSwitch $VERSION Manpages</h1> <table> EOF diff --git a/debian/rules.modules b/debian/rules.modules index 7ea8b1b..b0c6cdc 100755 --- a/debian/rules.modules +++ b/debian/rules.modules @@ -8,7 +8,7 @@ MA_DIR ?= /usr/share/modass DATAPATH_CONFIGURE_OPTS = kdist_clean: - dh_testdir + dh_testdir dh_testroot dh_clean rm -rf openvswitch diff --git a/third-party/automake.mk b/third-party/automake.mk index 9eaf02f..dd7bf41 100644 --- a/third-party/automake.mk +++ b/third-party/automake.mk @@ -1,2 +1,3 @@ -docs += third-party/README.rst -EXTRA_DIST += third-party/ofp-tcpdump.patch +EXTRA_DIST += \ + third-party/ofp-tcpdump.patch \ + third-party/README.rst
Basic Sphinx integration is now complete. Remove the documentation aspects of the 'dist-docs' target in favor of the htmldocs target. Signed-off-by: Stephen Finucane <stephen@that.guru> --- Documentation/automake.mk | 4 +--- Makefile.am | 7 +------ build-aux/dist-docs | 50 +---------------------------------------------- debian/rules.modules | 2 +- third-party/automake.mk | 5 +++-- 5 files changed, 7 insertions(+), 61 deletions(-)