From c0d06785b890803a1d3994ffb001f843859440b0 Mon Sep 17 00:00:00 2001 From: Guillaume Lambert Date: Fri, 4 Jun 2021 20:38:52 +0200 Subject: [PATCH] Rework odl-parent developer guide Signed-off-by: Guillaume Lambert Change-Id: I92d033ae2e5530595248c2ee4d214a4d29095932 --- .../odl-parent-developer-guide.rst | 33 +++++++++---------- docs/spelling_wordlist.txt | 10 ++++++ 2 files changed, 26 insertions(+), 17 deletions(-) diff --git a/docs/developer-guides/odl-parent-developer-guide.rst b/docs/developer-guides/odl-parent-developer-guide.rst index 0b255f6e6..ce7e9dc91 100644 --- a/docs/developer-guides/odl-parent-developer-guide.rst +++ b/docs/developer-guides/odl-parent-developer-guide.rst @@ -73,7 +73,7 @@ It also defines two profiles which help during development: - ``q`` (``-Pq``), the quick profile, which disables tests, code coverage, Javadoc generation, code analysis, etc. — anything which - isn’t necessary to build the bundles and features (see `this blog + is not necessary to build the bundles and features (see `this blog post `__ for details); @@ -181,10 +181,9 @@ If you use any of the following libraries, you should rely on .. note:: - This list isn’t exhaustive. It’s also not cast in stone; if you’d - like to add a new dependency (or migrate a dependency), please - contact `the mailing - list `__. + This list is not exhaustive. It is also not cast in stone;if you + would like to add a new dependency (or migrate a dependency), please + contact `the mailing list `__. ``odlparent`` also enforces some Checkstyle verification rules. In particular, it enforces the common license header used in all @@ -263,8 +262,8 @@ This inherits from ``odlparent`` and enables functionality useful for Karaf features: - ``karaf-maven-plugin`` is activated, to build Karaf features — but - for OpenDaylight, projects need to use “jar” packaging (**not** - “feature” or “kar”); + for OpenDaylight, projects need to use ``“jar”`` packaging (**not** + ``“feature”`` or ``“kar”``); - ``features.xml`` files are processed from templates stored in ``src/main/features/features.xml``; @@ -272,7 +271,7 @@ Karaf features: - Karaf features are tested after build to ensure they can be activated in a Karaf container. -The ``features.xml`` processing allows versions to be ommitted from +The ``features.xml`` processing allows versions to be omitted from certain feature dependencies, and replaced with “\ ``{{version}}``\ ”. For example: @@ -299,7 +298,7 @@ For example: mvn:org.opendaylight.controller/md-sal-config/{{VERSION}}/xml/config -As illustrated, versions can be ommitted in this way for repository +As illustrated, versions can be omitted in this way for repository dependencies, bundle dependencies and configuration files. They must be specified traditionally (either hard-coded, or using Maven properties) for feature dependencies. @@ -319,10 +318,10 @@ This inherits from ``odlparent`` and enables functionality useful for Karaf 4 features: - ``karaf-maven-plugin`` is activated, to build Karaf features, typically - with “feature” packaging (“kar” is also supported); + with ``"feature"`` packaging (``"kar"`` is also supported); - ``feature.xml`` files are generated based on the compile-scope dependencies - defined in the POM, optionally initialised from a stub in + defined in the POM, optionally initialized from a stub in ``src/main/feature/feature.xml``. - Karaf features are tested after build to ensure they can be activated @@ -333,15 +332,15 @@ allows features to be defined using only the most significant dependencies (those that define the feature); other requirements are determined automatically as long as they exist as Maven dependencies. -“configfiles” need to be defined both as Maven dependencies (with the +``configfiles`` need to be defined both as Maven dependencies (with the appropriate type and classifier) and as ```` elements in the ``feature.xml`` stub. Other features which a feature depends on need to be defined as Maven dependencies with type “xml” and classifier “features” (note the plural here). -feature-repo-parent -~~~~~~~~~~~~~~~~~~~ +``feature-repo-parent`` +~~~~~~~~~~~~~~~~~~~~~~~ This inherits from ``odlparent`` and enables functionality useful for Karaf 4 feature repositories. It follows the same principles as @@ -390,11 +389,11 @@ These features are: - ``odl-guava-18`` — Guava 18; - - ``odl-guava-21`` — Guava 21 (not indended for use in Carbon); + - ``odl-guava-21`` — Guava 21 (not intended for use in Carbon); - ``odl-lmax-3`` — LMAX Disruptor; - - ``odl-triemap-0.2`` — Concurrent Trie HashMap. + - ``odl-triemap-0.2`` — Concurrent Hash-Trie Map. To use these, you need to declare a dependency on the appropriate repository in your ``features.xml`` file: @@ -460,7 +459,7 @@ Features (for Karaf 4) There are equivalent features to all the Karaf 3 features, for Karaf 4. The repositories use “features4” instead of “features”, and the features -use “odl4” instead of “odl”. +use ``odl4`` instead of ``odl``. The following new features are specific to Karaf 4: diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 5ef474a9c..305360758 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -1,6 +1,7 @@ ACL Akka Aluminium +Asciidoc Async Autorelease artefacts @@ -14,6 +15,7 @@ analytics BigInteger bugfixes boolean +Checkstyle codebase codec codecs @@ -31,6 +33,7 @@ deserialization deserialize dev downloader +EPL eg executer Gerrit @@ -38,6 +41,7 @@ Git Guice GPG getters +Hamcrest hardcoded helpdesk hostname @@ -54,10 +58,12 @@ jarfile Karaf karaf keyed +Logback lftools linter Magnesium Mockito +Netty mdsal microservice microservices @@ -77,6 +83,7 @@ overline ovs ovsdb PCE +Pax pre QoS Resolvers @@ -91,6 +98,7 @@ releng renderer rovarga runtime +Shiro scalability stateful submodule @@ -100,6 +108,7 @@ superclass switchponders TCP TSC +Trie todo tox tsc @@ -112,4 +121,5 @@ vTEP virtualenv whitespace yangtools +Xerces xml -- 2.36.6