karaf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jbono...@apache.org
Subject [08/10] karaf git commit: KARAF-3928: connect up generated doc from Modello.
Date Tue, 24 Nov 2015 19:50:51 GMT
KARAF-3928: connect up generated doc from Modello.


Project: http://git-wip-us.apache.org/repos/asf/karaf/repo
Commit: http://git-wip-us.apache.org/repos/asf/karaf/commit/6bc4817a
Tree: http://git-wip-us.apache.org/repos/asf/karaf/tree/6bc4817a
Diff: http://git-wip-us.apache.org/repos/asf/karaf/diff/6bc4817a

Branch: refs/heads/master
Commit: 6bc4817ae587562042f09144f6e0ca7f2a9a4919
Parents: 3c2afb2
Author: Benson Margulies <benson@basistech.com>
Authored: Sun Sep 13 11:57:39 2015 -0400
Committer: Benson Margulies <benson@basistech.com>
Committed: Sun Sep 13 11:59:14 2015 -0400

----------------------------------------------------------------------
 tooling/karaf-maven-plugin/pom.xml              |   4 +-
 .../org/apache/karaf/tooling/AssemblyMojo.java  |   5 +-
 .../xdoc/karaf-property-instructions-model.xml  | 156 +++++++++++++++++++
 tooling/utils/src/main/mdo/edits.mdo            |   2 +-
 4 files changed, 163 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/karaf/blob/6bc4817a/tooling/karaf-maven-plugin/pom.xml
----------------------------------------------------------------------
diff --git a/tooling/karaf-maven-plugin/pom.xml b/tooling/karaf-maven-plugin/pom.xml
index 67998e4..d5bfcce 100644
--- a/tooling/karaf-maven-plugin/pom.xml
+++ b/tooling/karaf-maven-plugin/pom.xml
@@ -218,8 +218,8 @@
                     <!--<localRepositoryPath>${project.build.directory}/system</localRepositoryPath>-->
                     <!--<settingsFile>src/it/settings.xml</settingsFile>-->
                     <mavenOpts>-Djava.io.tmpdir=${project.build.directory}</mavenOpts>
-                    <skipInstallation>${skipTests}</skipInstallation>
-                    <skipInvocation>${skipTests}</skipInvocation>
+                    <skipInstallation>${invoker.skip}</skipInstallation>
+                    <skipInvocation>${invoker.skip}</skipInvocation>
                     <goals>
                         <goal>package</goal>
                     </goals>

http://git-wip-us.apache.org/repos/asf/karaf/blob/6bc4817a/tooling/karaf-maven-plugin/src/main/java/org/apache/karaf/tooling/AssemblyMojo.java
----------------------------------------------------------------------
diff --git a/tooling/karaf-maven-plugin/src/main/java/org/apache/karaf/tooling/AssemblyMojo.java
b/tooling/karaf-maven-plugin/src/main/java/org/apache/karaf/tooling/AssemblyMojo.java
index ff634ee..2f2f5c1 100644
--- a/tooling/karaf-maven-plugin/src/main/java/org/apache/karaf/tooling/AssemblyMojo.java
+++ b/tooling/karaf-maven-plugin/src/main/java/org/apache/karaf/tooling/AssemblyMojo.java
@@ -180,7 +180,10 @@ public class AssemblyMojo extends MojoSupport {
 
     /**
      * Specify an XML file that instructs this goal to apply edits to
-     * one or more standard Karaf property files. This allows you to
+     * one or more standard Karaf property files.
+     * The contents of this file are documented in detail on
+     * <a href="karaf-property-instructions-model.html">this page</a>.
+     * This allows you to
      * customize these files without making copies in your resources
      * directories. Here's a simple example:
      * <pre>

http://git-wip-us.apache.org/repos/asf/karaf/blob/6bc4817a/tooling/karaf-maven-plugin/src/site/xdoc/karaf-property-instructions-model.xml
----------------------------------------------------------------------
diff --git a/tooling/karaf-maven-plugin/src/site/xdoc/karaf-property-instructions-model.xml
b/tooling/karaf-maven-plugin/src/site/xdoc/karaf-property-instructions-model.xml
new file mode 100644
index 0000000..1b8a5a4
--- /dev/null
+++ b/tooling/karaf-maven-plugin/src/site/xdoc/karaf-property-instructions-model.xml
@@ -0,0 +1,156 @@
+<?xml version="1.0"?>
+    <!--
+
+        Licensed to the Apache Software Foundation (ASF) under one or more
+        contributor license agreements.  See the NOTICE file distributed with
+        this work for additional information regarding copyright ownership.
+        The ASF licenses this file to You under the Apache License, Version 2.0
+        (the "License"); you may not use this file except in compliance with
+        the License.  You may obtain a copy of the License at
+
+           http://www.apache.org/licenses/LICENSE-2.0
+
+        Unless required by applicable law or agreed to in writing, software
+        distributed under the License is distributed on an "AS IS" BASIS,
+        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+        See the License for the specific language governing permissions and
+        limitations under the License.
+    -->
+
+
+
+<!-- =================== DO NOT EDIT THIS FILE ====================         -->
+<!-- Generated by Modello 1.8.3,                                            -->
+<!-- any modifications will be overwritten.                                 -->
+<!-- ==============================================================         -->
+<document>
+  <properties>
+    <title>KarafPropertyInstructionsModel</title>
+  </properties>
+  <body>
+    <section name="KarafPropertyInstructionsModel">
+      <p>
+        Specifications for how to modify Karaf property files to customize an installation.
+    </p>
+      <source>
+&lt;<a href="#class_property-edits">property-edits</a> xmlns="http://karaf.apache.org/tools/property-edits/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://karaf.apache.org/tools/property-edits/1.0.0 <a href="http://karaf.apache.org/xsd/property-edits-1.0.0.xsd">http://karaf.apache.org/xsd/property-edits-1.0.0.xsd</a>"&gt;
+  &lt;edits&gt;
+    &lt;<a href="#class_edit">edit</a>&gt;
+      &lt;<a href="#class_operation">operation</a> prepend=.. /&gt;
+      &lt;file/&gt;
+      &lt;key/&gt;
+      &lt;value/&gt;
+    &lt;/edit&gt;
+  &lt;/edits&gt;
+&lt;/property-edits&gt;
+</source>
+      <a name="class_property-edits"/>
+      <subsection name="property-edits">
+        <p>
+                A collection instructions. Each instruction is either a 'put' or an 'edit',
+                and calls out a file, a property name, and a property value.
+            </p>
+        <table>
+          <tr>
+            <th>Element</th>
+            <th>Type</th>
+            <th>Description</th>
+          </tr>
+          <tr>
+            <td>
+              <code>edits/<a href="#class_edit">edit</a>*</code>
+            </td>
+            <td>
+              <code>List&lt;KarafPropertyEdit&gt;</code>
+            </td>
+            <td><b>(Many)</b> The list of edits to perform.</td>
+          </tr>
+        </table>
+      </subsection>
+      <a name="class_edit"/>
+      <subsection name="edit">
+        <p>
+                A single property edit.
+            </p>
+        <table>
+          <tr>
+            <th>Element</th>
+            <th>Type</th>
+            <th>Description</th>
+          </tr>
+          <tr>
+            <td>
+              <code>
+                <a href="#class_operation">operation</a>
+              </code>
+            </td>
+            <td>
+              <code>Operation</code>
+            </td>
+            <td>
+                        The operation to perform: 'put' or 'extend'.
+                    </td>
+          </tr>
+          <tr>
+            <td>
+              <code>file</code>
+            </td>
+            <td>
+              <code>String</code>
+            </td>
+            <td>
+                        The pathname, relative to the the Karaf etc directory, of the file
to manipulate.
+                    </td>
+          </tr>
+          <tr>
+            <td>
+              <code>key</code>
+            </td>
+            <td>
+              <code>String</code>
+            </td>
+            <td>
+                        The property key.
+                    </td>
+          </tr>
+          <tr>
+            <td>
+              <code>value</code>
+            </td>
+            <td>
+              <code>String</code>
+            </td>
+            <td>
+                        The property value.
+                    </td>
+          </tr>
+        </table>
+      </subsection>
+      <a name="class_operation"/>
+      <subsection name="operation">
+        <p>No description.</p>
+        <p>
+          <b>Element Content: </b>
+                        'extend' to extend the existing value, 'put' to replace.
+                    </p>
+        <table>
+          <tr>
+            <th>Attribute</th>
+            <th>Type</th>
+            <th>Description</th>
+          </tr>
+          <tr>
+            <td>
+              <code>prepend</code>
+            </td>
+            <td>
+              <code>boolean</code>
+            </td>
+            <td>for the 'extend' operation, indicates that the value should be placed
at the head of the list.<br/><strong>Default value is</strong>: <code>false</code>.</td>
+          </tr>
+        </table>
+      </subsection>
+    </section>
+  </body>
+</document>

http://git-wip-us.apache.org/repos/asf/karaf/blob/6bc4817a/tooling/utils/src/main/mdo/edits.mdo
----------------------------------------------------------------------
diff --git a/tooling/utils/src/main/mdo/edits.mdo b/tooling/utils/src/main/mdo/edits.mdo
index b0d3f86..c8072ae 100644
--- a/tooling/utils/src/main/mdo/edits.mdo
+++ b/tooling/utils/src/main/mdo/edits.mdo
@@ -35,7 +35,7 @@
         <class rootElement="true" xml.tagName="property-edits">
             <description>
                 A collection instructions. Each instruction is either a 'put' or an 'edit',
-                and calls out a file and a series of name/value pairs.
+                and calls out a file, a property name, and a property value.
             </description>
             <name>KarafPropertyEdits</name>
             <version>1.0.0+</version>


Mime
View raw message