From a59d0d7b890e987eb1185256c322b28254cdc811 Mon Sep 17 00:00:00 2001 From: Robert Varga Date: Mon, 21 Jan 2019 22:18:12 +0100 Subject: [PATCH] Add mdsal-docs artifact Rather than doing javadoc:aggregate, use the docs directory to prepare documentation, which includes sources as well as javadocs. This cuts down the build time in half while providing a better javadoc result due to our ability to heavily customize. Change-Id: If39191f179265240e7a5d3700fcea32e10897220 Signed-off-by: Robert Varga --- artifacts/pom.xml | 26 +- docs/assembly/guides.xml | 15 + docs/pom.xml | 687 ++++++++++++++++++ .../asciidoc/contributor/introduction.adoc | 13 - pom.xml | 28 +- 5 files changed, 729 insertions(+), 40 deletions(-) create mode 100644 docs/assembly/guides.xml create mode 100644 docs/pom.xml delete mode 100644 docs/src/main/asciidoc/contributor/introduction.adoc diff --git a/artifacts/pom.xml b/artifacts/pom.xml index 6a7a05b5c6..1c72ef266e 100644 --- a/artifacts/pom.xml +++ b/artifacts/pom.xml @@ -682,11 +682,6 @@ ietf-topology-ospf 2013.10.21.15.6-SNAPSHOT - - org.opendaylight.mdsal.model - ietf-topology-l3-unicast - 2013.10.21.15.6-SNAPSHOT - org.opendaylight.mdsal.model ietf-lisp-address-types-2015-11-05 @@ -870,6 +865,27 @@ features xml + + + + org.opendaylight.yangtools + yangtools-docs + 2.0.9-SNAPSHOT + zip + guides + + + org.opendaylight.yangtools + yangtools-docs + 2.0.9-SNAPSHOT + javadoc + + + org.opendaylight.yangtools + yangtools-docs + 2.0.9-SNAPSHOT + sources + diff --git a/docs/assembly/guides.xml b/docs/assembly/guides.xml new file mode 100644 index 0000000000..1db9dbde7f --- /dev/null +++ b/docs/assembly/guides.xml @@ -0,0 +1,15 @@ + + guides + + zip + + + + ${project.build.directory}/generated-docs + / + + + diff --git a/docs/pom.xml b/docs/pom.xml new file mode 100644 index 0000000000..1f14cbb2ee --- /dev/null +++ b/docs/pom.xml @@ -0,0 +1,687 @@ + + + + + 4.0.0 + + org.opendaylight.mdsal + dom-parent + 3.0.6-SNAPSHOT + ../dom/dom-parent + + + mdsal-docs + jar + ${project.artifactId} + MD-SAL documentation + + + + org.opendaylight.mdsal + mdsal-common-api + + + org.opendaylight.mdsal + mdsal-common-util + + + org.opendaylight.mdsal + mdsal-dom-api + + + org.opendaylight.mdsal + mdsal-dom-spi + + + org.opendaylight.mdsal + mdsal-dom-broker + + + org.opendaylight.mdsal + mdsal-dom-schema-service-osgi + + + org.opendaylight.mdsal + mdsal-dom-inmemory-datastore + + + org.opendaylight.mdsal + maven-sal-api-gen-plugin + + + org.opendaylight.mdsal + mdsal-binding-generator-api + + + org.opendaylight.mdsal + mdsal-binding-generator-util + + + org.opendaylight.mdsal + mdsal-binding-generator-impl + + + org.opendaylight.mdsal + mdsal-binding-java-api-generator + + + org.opendaylight.mdsal + yang-binding + + + org.opendaylight.mdsal + mdsal-binding-spec-util + + + + + org.opendaylight.mdsal + mdsal-binding-api + + + org.opendaylight.mdsal + mdsal-binding-dom-adapter + + + + org.opendaylight.mdsal + mdsal-binding-dom-codec + + + org.opendaylight.mdsal + mdsal-binding-dom-codec-osgi + + + org.opendaylight.mdsal + mdsal-binding-spi + + + org.opendaylight.mdsal + mdsal-binding-util + + + org.opendaylight.mdsal + mdsal-binding-test-utils + provided + + + + org.opendaylight.mdsal.model + yang-ext + + + org.opendaylight.mdsal.model + general-entity + + + + org.opendaylight.mdsal + mdsal-eos-common-api + + + org.opendaylight.mdsal + mdsal-eos-common-spi + + + org.opendaylight.mdsal + mdsal-eos-dom-api + + + org.opendaylight.mdsal + mdsal-eos-dom-simple + + + org.opendaylight.mdsal + mdsal-eos-binding-api + + + org.opendaylight.mdsal + mdsal-eos-binding-adapter + + + org.opendaylight.mdsal + mdsal-singleton-common-api + + + org.opendaylight.mdsal + mdsal-singleton-dom-impl + + + + org.opendaylight.mdsal + mdsal-trace-api + + + org.opendaylight.mdsal + mdsal-trace-cli + + + org.opendaylight.mdsal + mdsal-trace-impl + + + + org.opendaylight.mdsal.model + opendaylight-l2-types + + + org.opendaylight.mdsal.binding.model.ietf + rfc6991 + + + org.opendaylight.mdsal.binding.model.ietf + rfc6991-ietf-inet-types + + + org.opendaylight.mdsal.binding.model.ietf + rfc6991-ietf-yang-types + + + org.opendaylight.mdsal.model + ietf-type-util + + + org.opendaylight.mdsal.binding.model.ietf + rfc7223 + + + org.opendaylight.mdsal.binding.model.iana + iana-if-type + + + org.opendaylight.mdsal.binding.model.iana + rfc7224-20180703-iana-if-type + + + org.opendaylight.mdsal.binding.model.ietf + rfc7277 + + + org.opendaylight.mdsal.binding.model.ietf + rfc7895 + + + org.opendaylight.mdsal.binding.model.ietf + rfc7952 + + + org.opendaylight.mdsal.binding.model.ietf + rfc8294 + + + org.opendaylight.mdsal.binding.model.ietf + rfc8294-ietf-routing-types + + + org.opendaylight.mdsal.binding.model.iana + iana-routing-types + + + org.opendaylight.mdsal.binding.model.ietf + rfc8342 + + + org.opendaylight.mdsal.binding.model.ietf + rfc8342-ietf-datastores + + + org.opendaylight.mdsal.binding.model.ietf + rfc8342-ietf-origin + + + org.opendaylight.mdsal.binding.model.ietf + rfc8343 + + + org.opendaylight.mdsal.binding.model.ietf + rfc8344 + + + org.opendaylight.mdsal.binding.model.ietf + rfc8345 + + + org.opendaylight.mdsal.binding.model.ietf + rfc8345-ietf-network + + + org.opendaylight.mdsal.binding.model.ietf + rfc8345-ietf-network-state + + + org.opendaylight.mdsal.binding.model.ietf + rfc8345-ietf-network-topology + + + org.opendaylight.mdsal.binding.model.ietf + rfc8345-ietf-network-topology-state + + + org.opendaylight.mdsal.binding.model.ietf + rfc8348 + + + org.opendaylight.mdsal.binding.model.ietf + rfc8348-ietf-hardware + + + org.opendaylight.mdsal.binding.model.ietf + rfc8348-ietf-hardware-state + + + org.opendaylight.mdsal.binding.model.iana + iana-hardware + + + org.opendaylight.mdsal.binding.model.ietf + rfc8349 + + + org.opendaylight.mdsal.binding.model.ietf + rfc8349-ietf-routing + + + org.opendaylight.mdsal.binding.model.ietf + rfc8349-ietf-ipv4-unicast-routing + + + org.opendaylight.mdsal.binding.model.ietf + rfc8349-ietf-ipv6-unicast-routing + + + org.opendaylight.mdsal.model + ietf-restconf + + + org.opendaylight.mdsal.model + ietf-ted + + + org.opendaylight.mdsal.model + ietf-topology + + + org.opendaylight.mdsal.model + ietf-topology-isis + + + org.opendaylight.mdsal.model + ietf-topology-l3-unicast-igp + + + org.opendaylight.mdsal.model + ietf-topology-ospf + + + org.opendaylight.mdsal.model + ietf-lisp-address-types-2015-11-05 + + + + org.opendaylight.mdsal.model + ietf-packet-fields + + + org.opendaylight.mdsal.model + ietf-access-control-list + + + org.opendaylight.mdsal.model + iana-afn-safi + + + + + javax.inject + javax.inject + + + org.apache.karaf.shell + org.apache.karaf.shell.core + provided + + + org.apache.maven + maven-core + provided + + + org.sonatype.plexus + plexus-build-api + provided + + + org.immutables + value + provided + + + org.kohsuke.metainf-services + metainf-services + provided + + + org.osgi + org.osgi.core + provided + + + junit + junit + provided + + + + + + + org.asciidoctor + asciidoctor-maven-plugin + 1.5.7.1 + + + output-html + generate-resources + + process-asciidoc + + + coderay + html + + + false + + + + + + + ${project.version} + ${maven.build.timestamp} + ${project.organization.name} + + + + + + org.apache.maven.plugins + maven-assembly-plugin + + assembly/guides.xml + + + + package + + single + + + + + + + maven-jar-plugin + + + default-jar + none + + + + + maven-dependency-plugin + + + unpack-sources + prepare-package + + unpack-dependencies + + + true + sources + org/opendaylight/** + org.opendaylight.mdsal + ${project.build.directory}/src + + + + + + + org.codehaus.mojo + build-helper-maven-plugin + + + add-source + + process-classes + + add-source + + + + ${project.build.directory}/src + + + + + + + + maven-source-plugin + + + attach-sources + + prepare-package + + jar-no-fork + + + + + + + maven-clean-plugin + + + remove-undocumented-sources + + prepare-package + + clean + + + true + + + ${project.build.directory}/src + + **/$YangModelBindingProvider.java + **/$YangModuleInfoImpl.java + + + + + + + + + maven-javadoc-plugin + + 3.0.0 + + + attach-javadocs + + jar + + + + + + + https://static.javadoc.io/junit/junit/4.11/ + http://hamcrest.org/JavaHamcrest/javadoc/1.3/ + http://google.github.io/truth/api/0.42/ + https://www.slf4j.org/apidocs/ + https://xerces.apache.org/xerces2-j/javadocs/api/ + https://google.github.io/guava/releases/25.1-jre/api/docs/ + http://doc.akka.io/japi/akka/2.5.19/ + http://netty.io/4.1/api/ + https://commons.apache.org/proper/commons-lang/javadocs/api-2.6/ + https://commons.apache.org/proper/commons-lang/javadocs/api-3.8.1/ + https://commons.apache.org/proper/commons-codec/apidocs/ + + + + Common interfaces + org.opendaylight.mdsal.common* + + + Low-level (DOM) MD-SAL + org.opendaylight.mdsal.dom* + + + Type-safe (Binding) MD-SAL + org.opendaylight.mdsal.binding*:org.opendaylight.yangtools.yang.binding* + + + Entity Ownership Service + org.opendaylight.mdsal.eos*:org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.core.general.entity* + + + Cluster Singleton Service + org.opendaylight.mdsal.singleton* + + + MD-SAL Tracing Utilities + org.opendaylight.mdsal.trace*:org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsaltrace* + + + Java Bindings for iana-afn-safi.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana.afn.safi* + + + Java Bindings for iana-hardware.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana.hardware* + + + Java Bindings for iana-if-type.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type* + + + Java Bindings for iana-routing-type.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana.routing.type* + + + Java Bindings for ietf-access-control-list.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list* + + + Java Bindings for ietf-datastores.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.datastores* + + + Java Bindings for ietf-hardware.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware* + + + Java Bindings for ietf-inet-types.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types* + + + Java Bindings for ietf-interfaces.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces* + + + Java Bindings for ietf-ip.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev* + + + Java Bindings for ietf-lisp-address-types.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.* + + + Java Bindings for ietf-network.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev* + + + Java Bindings for ietf-network-topology.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev* + + + Java Bindings for ietf-network-state.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.state* + + + Java Bindings for ietf-network-topology-state.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.state* + + + Java Bindings for ietf-origin.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.origin* + + + Java Bindings for ietf-packet-fields.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.packet.fields* + + + Java Bindings for ietf-ipv4-unicast-routing.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv4.unicast.routing* + + + Java Bindings for ietf-ipv6-unicast-routing.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv6.unicast.routing* + + + Java Bindings for ietf-routing.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.rev* + + + Java Bindings for ietf-restconf.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf* + + + Java Bindings for ietf-routing-types.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.types* + + + Java Bindings for ietf-yang-library.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library* + + + Java Bindings for ietf-yang-types.yang + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types* + + + Java Bindings for opendaylight-l2-types.yang + org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types* + + + Other model-driven Java Bindings + org.opendaylight.yang.gen.v1* + + + + + + + diff --git a/docs/src/main/asciidoc/contributor/introduction.adoc b/docs/src/main/asciidoc/contributor/introduction.adoc deleted file mode 100644 index 6378e84b91..0000000000 --- a/docs/src/main/asciidoc/contributor/introduction.adoc +++ /dev/null @@ -1,13 +0,0 @@ -= Contributor Guide - -== Architecture - -== Design - -=== Design considerations - -=== Design decisions - -== Common concepts - -== Recomendations diff --git a/pom.xml b/pom.xml index aaa52d9e44..f48aa1f558 100644 --- a/pom.xml +++ b/pom.xml @@ -26,6 +26,7 @@ artifacts common + docs features dom binding @@ -37,29 +38,12 @@ trace + + true + true + + - - aggregate-javadoc - - true - - - - - maven-javadoc-plugin - - - aggregate - package - - aggregate-jar - - - - - - - sonar-jacoco-aggregate -- 2.36.6