You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2016/06/09 13:42:06 UTC

camel git commit: Camel catalog should not warn certain components lack of docs.

Repository: camel
Updated Branches:
  refs/heads/master 1c49b5226 -> 9491da8f3


Camel catalog should not warn certain components lack of docs.


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/9491da8f
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/9491da8f
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/9491da8f

Branch: refs/heads/master
Commit: 9491da8f393fa95fb33cf3afcb65dab88be63f86
Parents: 1c49b52
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Jun 9 15:41:55 2016 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Jun 9 15:41:55 2016 +0200

----------------------------------------------------------------------
 .../camel/maven/packaging/PrepareCatalogMojo.java      | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/9491da8f/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
----------------------------------------------------------------------
diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
index e45ee8b..0035c64 100644
--- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
+++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
@@ -50,6 +50,8 @@ public class PrepareCatalogMojo extends AbstractMojo {
 
     public static final int BUFFER_SIZE = 128 * 1024;
 
+    private static final String[] EXCLUDE_DOC_FILES = {"camel-core-osgi", "camel-core-xml", "camel-http-common", "camel-jetty-common"};
+
     private static final Pattern LABEL_PATTERN = Pattern.compile("\\\"label\\\":\\s\\\"([\\w,]+)\\\"");
 
     private static final int UNUSED_LABELS_WARN = 15;
@@ -708,7 +710,7 @@ public class PrepareCatalogMojo extends AbstractMojo {
             File[] components = componentsDir.listFiles();
             if (components != null) {
                 for (File dir : components) {
-                    if (dir.isDirectory() && !"target".equals(dir.getName()) && !dir.getName().startsWith(".")) {
+                    if (dir.isDirectory() && !"target".equals(dir.getName()) && !dir.getName().startsWith(".") && !excludeDocumentDir(dir.getName())) {
                         File target = new File(dir, "src/main/docs");
 
                         int before = adocFiles.size();
@@ -1134,4 +1136,13 @@ public class PrepareCatalogMojo extends AbstractMojo {
         }
     }
 
+    private static boolean excludeDocumentDir(String name) {
+        for (String exclude : EXCLUDE_DOC_FILES) {
+            if (exclude.equals(name)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
 }
\ No newline at end of file


Re: camel git commit: Camel catalog should not warn certain components lack of docs.

Posted by Claus Ibsen <cl...@gmail.com>.
On Thu, Jun 9, 2016 at 3:43 PM, Andrea Cosentino
<an...@yahoo.com.invalid> wrote:
> Maybe camel-jetty too?
>

Ah yeah you can add to excluded, as its camel-jetty9 that has the documentation.

> Don't know. I believe is a particular kind a component.
>  --
> Andrea Cosentino
> ----------------------------------
> Apache Camel PMC Member
> Apache Karaf Committer
> Apache Servicemix Committer
> Email: ancosen1985@yahoo.com
> Twitter: @oscerd2
> Github: oscerd
>
>
>
> On Thursday, June 9, 2016 3:42 PM, "davsclaus@apache.org" <da...@apache.org> wrote:
> Repository: camel
> Updated Branches:
>   refs/heads/master 1c49b5226 -> 9491da8f3
>
>
> Camel catalog should not warn certain components lack of docs.
>
>
> Project: http://git-wip-us.apache.org/repos/asf/camel/repo
> Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/9491da8f
> Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/9491da8f
> Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/9491da8f
>
> Branch: refs/heads/master
> Commit: 9491da8f393fa95fb33cf3afcb65dab88be63f86
> Parents: 1c49b52
> Author: Claus Ibsen <da...@apache.org>
> Authored: Thu Jun 9 15:41:55 2016 +0200
> Committer: Claus Ibsen <da...@apache.org>
> Committed: Thu Jun 9 15:41:55 2016 +0200
>
> ----------------------------------------------------------------------
> .../camel/maven/packaging/PrepareCatalogMojo.java      | 13 ++++++++++++-
> 1 file changed, 12 insertions(+), 1 deletion(-)
> ----------------------------------------------------------------------
>
>
> http://git-wip-us.apache.org/repos/asf/camel/blob/9491da8f/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
> ----------------------------------------------------------------------
> diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
> index e45ee8b..0035c64 100644
> --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
> +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
> @@ -50,6 +50,8 @@ public class PrepareCatalogMojo extends AbstractMojo {
>
>      public static final int BUFFER_SIZE = 128 * 1024;
>
> +    private static final String[] EXCLUDE_DOC_FILES = {"camel-core-osgi", "camel-core-xml", "camel-http-common", "camel-jetty-common"};
> +
>      private static final Pattern LABEL_PATTERN = Pattern.compile("\\\"label\\\":\\s\\\"([\\w,]+)\\\"");
>
>      private static final int UNUSED_LABELS_WARN = 15;
> @@ -708,7 +710,7 @@ public class PrepareCatalogMojo extends AbstractMojo {
>              File[] components = componentsDir.listFiles();
>              if (components != null) {
>                  for (File dir : components) {
> -                    if (dir.isDirectory() && !"target".equals(dir.getName()) && !dir.getName().startsWith(".")) {
> +                    if (dir.isDirectory() && !"target".equals(dir.getName()) && !dir.getName().startsWith(".") && !excludeDocumentDir(dir.getName())) {
>                          File target = new File(dir, "src/main/docs");
>
>                          int before = adocFiles.size();
> @@ -1134,4 +1136,13 @@ public class PrepareCatalogMojo extends AbstractMojo {
>          }
>      }
>
> +    private static boolean excludeDocumentDir(String name) {
> +        for (String exclude : EXCLUDE_DOC_FILES) {
> +            if (exclude.equals(name)) {
> +                return true;
> +            }
> +        }
> +        return false;
> +    }
> +
> }
> \ No newline at end of file



-- 
Claus Ibsen
-----------------
http://davsclaus.com @davsclaus
Camel in Action 2: https://www.manning.com/ibsen2

Re: camel git commit: Camel catalog should not warn certain components lack of docs.

Posted by Andrea Cosentino <an...@yahoo.com.INVALID>.
Maybe camel-jetty too?

Don't know. I believe is a particular kind a component.
 --
Andrea Cosentino 
----------------------------------
Apache Camel PMC Member
Apache Karaf Committer
Apache Servicemix Committer
Email: ancosen1985@yahoo.com
Twitter: @oscerd2
Github: oscerd



On Thursday, June 9, 2016 3:42 PM, "davsclaus@apache.org" <da...@apache.org> wrote:
Repository: camel
Updated Branches:
  refs/heads/master 1c49b5226 -> 9491da8f3


Camel catalog should not warn certain components lack of docs.


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/9491da8f
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/9491da8f
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/9491da8f

Branch: refs/heads/master
Commit: 9491da8f393fa95fb33cf3afcb65dab88be63f86
Parents: 1c49b52
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Jun 9 15:41:55 2016 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Jun 9 15:41:55 2016 +0200

----------------------------------------------------------------------
.../camel/maven/packaging/PrepareCatalogMojo.java      | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/9491da8f/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
----------------------------------------------------------------------
diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
index e45ee8b..0035c64 100644
--- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
+++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
@@ -50,6 +50,8 @@ public class PrepareCatalogMojo extends AbstractMojo {

     public static final int BUFFER_SIZE = 128 * 1024;

+    private static final String[] EXCLUDE_DOC_FILES = {"camel-core-osgi", "camel-core-xml", "camel-http-common", "camel-jetty-common"};
+
     private static final Pattern LABEL_PATTERN = Pattern.compile("\\\"label\\\":\\s\\\"([\\w,]+)\\\"");

     private static final int UNUSED_LABELS_WARN = 15;
@@ -708,7 +710,7 @@ public class PrepareCatalogMojo extends AbstractMojo {
             File[] components = componentsDir.listFiles();
             if (components != null) {
                 for (File dir : components) {
-                    if (dir.isDirectory() && !"target".equals(dir.getName()) && !dir.getName().startsWith(".")) {
+                    if (dir.isDirectory() && !"target".equals(dir.getName()) && !dir.getName().startsWith(".") && !excludeDocumentDir(dir.getName())) {
                         File target = new File(dir, "src/main/docs");

                         int before = adocFiles.size();
@@ -1134,4 +1136,13 @@ public class PrepareCatalogMojo extends AbstractMojo {
         }
     }

+    private static boolean excludeDocumentDir(String name) {
+        for (String exclude : EXCLUDE_DOC_FILES) {
+            if (exclude.equals(name)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
}
\ No newline at end of file