From: Numan Siddique <nusid...@redhat.com> This was missing when OVN was split from OVS.
Signed-off-by: Numan Siddique <nusid...@redhat.com> --- Makefile.am | 17 +-------- TODO_SPLIT.rst | 6 --- automake.mk | 84 +++++++++++++++++++++++++++++++++++++++++ ovn-nb.xml | 2 +- rhel/ovn-fedora.spec.in | 6 +-- 5 files changed, 89 insertions(+), 26 deletions(-) create mode 100644 automake.mk diff --git a/Makefile.am b/Makefile.am index f3df733a1..97dc309e3 100644 --- a/Makefile.am +++ b/Makefile.am @@ -488,22 +488,7 @@ dist-docs: .PHONY: dist-docs -# Version checking for ovn-nb.ovsschema. -ALL_LOCAL += ovn-nb.ovsschema.stamp -ovn-nb.ovsschema.stamp: ovn-nb.ovsschema - $(srcdir)/build-aux/cksum-schema-check $? $@ -CLEANFILES += ovn-nb.ovsschema.stamp - -# Version checking for ovn-sb.ovsschema. -ALL_LOCAL += ovn-sb.ovsschema.stamp -ovn-sb.ovsschema.stamp: ovn-sb.ovsschema - $(srcdir)/build-aux/cksum-schema-check $? $@ - -pkgdata_DATA += ovn-nb.ovsschema -pkgdata_DATA += ovn-sb.ovsschema - -CLEANFILES += ovn-sb.ovsschema.stamp - +include automake.mk include Documentation/automake.mk include m4/automake.mk include lib/automake.mk diff --git a/TODO_SPLIT.rst b/TODO_SPLIT.rst index bb8657eb1..933534084 100644 --- a/TODO_SPLIT.rst +++ b/TODO_SPLIT.rst @@ -35,12 +35,6 @@ Immediate tasks * Someone with a decent ability to write should give the README.rst file some polish (or even just rewrite it. I won't be offended). -* After the split, the below things are missing during compilation - - OVN northbound/southbound E-R diagram - - OVN northbound/southbound schema documentation - - ovn-architecture manpage generation. - This needs to be fixed. - * Cleanup the acinclude.m4 and m4 folder Immediate to Short-term tasks diff --git a/automake.mk b/automake.mk new file mode 100644 index 000000000..ad801f1e5 --- /dev/null +++ b/automake.mk @@ -0,0 +1,84 @@ +man_MANS += ovn-architecture.7 +EXTRA_DIST += ovn-architecture.7.xml +CLEANFILES += ovn-architecture.7 + +# OVN northbound E-R diagram +# +# If "python" or "dot" is not available, then we do not add graphical diagram +# to the documentation. +if HAVE_PYTHON +if HAVE_DOT +OVSDB_DOT = $(run_python) ${OVSDIR}/ovsdb/ovsdb-dot.in +ovn-nb.gv: ${OVSDIR}/ovsdb/ovsdb-dot.in $(srcdir)/ovn-nb.ovsschema + $(AM_V_GEN)$(OVSDB_DOT) --no-arrows $(srcdir)/ovn-nb.ovsschema > $@ +ovn-nb.pic: ovn-nb.gv ${OVSDIR}/ovsdb/dot2pic + $(AM_V_GEN)(dot -T plain < ovn-nb.gv | $(PYTHON) ${OVSDIR}/ovsdb/dot2pic -f 3) > $@.tmp && \ + mv $@.tmp $@ +OVN_NB_PIC = ovn-nb.pic +OVN_NB_DOT_DIAGRAM_ARG = --er-diagram=$(OVN_NB_PIC) +CLEANFILES += ovn-nb.gv ovn-nb.pic +endif +endif + +# OVN northbound schema documentation +EXTRA_DIST += ovn-nb.xml +CLEANFILES += ovn-nb.5 +man_MANS += ovn-nb.5 + +OVSDB_DOC = $(run_python) ${OVSDIR}/ovsdb/ovsdb-doc +ovn-nb.5: \ + ${OVSDIR}/ovsdb/ovsdb-doc $(srcdir)/ovn-nb.xml $(srcdir)/ovn-nb.ovsschema $(OVN_NB_PIC) + $(AM_V_GEN)$(OVSDB_DOC) \ + $(OVN_NB_DOT_DIAGRAM_ARG) \ + --version=$(VERSION) \ + $(srcdir)/ovn-nb.ovsschema \ + $(srcdir)/ovn-nb.xml > $@.tmp && \ + mv $@.tmp $@ + +# OVN southbound E-R diagram +# +# If "python" or "dot" is not available, then we do not add graphical diagram +# to the documentation. +if HAVE_PYTHON +if HAVE_DOT +ovn-sb.gv: ${OVSDIR}/ovsdb/ovsdb-dot.in $(srcdir)/ovn-sb.ovsschema + $(AM_V_GEN)$(OVSDB_DOT) --no-arrows $(srcdir)/ovn-sb.ovsschema > $@ +ovn-sb.pic: ovn-sb.gv ${OVSDIR}/ovsdb/dot2pic + $(AM_V_GEN)(dot -T plain < ovn-sb.gv | $(PYTHON) ${OVSDIR}/ovsdb/dot2pic -f 3) > $@.tmp && \ + mv $@.tmp $@ +OVN_SB_PIC = ovn-sb.pic +OVN_SB_DOT_DIAGRAM_ARG = --er-diagram=$(OVN_SB_PIC) +CLEANFILES += ovn-sb.gv ovn-sb.pic +endif +endif + +# OVN southbound schema documentation +EXTRA_DIST += ovn-sb.xml +CLEANFILES += ovn-sb.5 +man_MANS += ovn-sb.5 + +ovn-sb.5: \ + ${OVSDIR}/ovsdb/ovsdb-doc $(srcdir)/ovn-sb.xml $(srcdir)/ovn-sb.ovsschema $(OVN_SB_PIC) + $(AM_V_GEN)$(OVSDB_DOC) \ + $(OVN_SB_DOT_DIAGRAM_ARG) \ + --version=$(VERSION) \ + $(srcdir)/ovn-sb.ovsschema \ + $(srcdir)/ovn-sb.xml > $@.tmp && \ + mv $@.tmp $@ + + +# Version checking for ovn-nb.ovsschema. +ALL_LOCAL += ovn-nb.ovsschema.stamp +ovn-nb.ovsschema.stamp: ovn-nb.ovsschema + $(srcdir)/build-aux/cksum-schema-check $? $@ +CLEANFILES += ovn-nb.ovsschema.stamp + +# Version checking for ovn-sb.ovsschema. +ALL_LOCAL += ovn-sb.ovsschema.stamp +ovn-sb.ovsschema.stamp: ovn-sb.ovsschema + $(srcdir)/build-aux/cksum-schema-check $? $@ + +pkgdata_DATA += ovn-nb.ovsschema +pkgdata_DATA += ovn-sb.ovsschema + +CLEANFILES += ovn-sb.ovsschema.stamp diff --git a/ovn-nb.xml b/ovn-nb.xml index 442e5cb60..b41b57906 100644 --- a/ovn-nb.xml +++ b/ovn-nb.xml @@ -1535,7 +1535,7 @@ address. </p> </column> - <column name="options" key="mcast_relay" type'{"type": "boolean"}'> + <column name="options" key="mcast_relay" type='{"type": "boolean"}'> <p> Enables/disables IP multicast relay between logical switches connected to the logical router. Default: False. diff --git a/rhel/ovn-fedora.spec.in b/rhel/ovn-fedora.spec.in index 9ee807fab..447b4fe6e 100644 --- a/rhel/ovn-fedora.spec.in +++ b/rhel/ovn-fedora.spec.in @@ -442,10 +442,10 @@ fi %{_mandir}/man8/ovn-trace.8* %{_mandir}/man1/ovn-detrace.1* %{_mandir}/man8/ovn-appctl.8* -#%{_mandir}/man7/ovn-architecture.7* - Uncomment this once the manpage is fixed +%{_mandir}/man7/ovn-architecture.7* %{_mandir}/man8/ovn-sbctl.8* -#%{_mandir}/man5/ovn-nb.5* - Uncomment this once the manpage is fixed -#%{_mandir}/man5/ovn-sb.5* - Uncomment this once the manpage is fixed +%{_mandir}/man5/ovn-nb.5* +%{_mandir}/man5/ovn-sb.5* %{_prefix}/lib/ocf/resource.d/ovn/ovndb-servers %config(noreplace) %{_sysconfdir}/logrotate.d/ovn -- 2.21.0 _______________________________________________ dev mailing list d...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-dev