[6/7] flink git commit: [FLINK-8742][docs] Move docs generator annotations to flink-annotations

2018-04-06 Thread chesnay 
[FLINK-8742][docs] Move docs generator annotations to flink-annotations

This closes #5821.


Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/14f0c569
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/14f0c569
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/14f0c569

Branch: refs/heads/release-1.5
Commit: 14f0c5694ab73ba1fdb6038ce23c10f17d31d8d8
Parents: 9e2581e
Author: zentol 
Authored: Thu Apr 5 12:17:27 2018 +0200
Committer: zentol 
Committed: Fri Apr 6 15:24:03 2018 +0200

--
 .../flink/annotation/docs/ConfigGroup.java  | 36 ++
 .../flink/annotation/docs/ConfigGroups.java | 39 
 .../apache/flink/configuration/ConfigGroup.java | 36 --
 .../flink/configuration/ConfigGroups.java   | 39 
 .../apache/flink/configuration/CoreOptions.java |  2 +
 .../configuration/HighAvailabilityOptions.java  |  2 +
 .../configuration/ResourceManagerOptions.java   |  2 +
 .../flink/configuration/SecurityOptions.java|  2 +
 flink-docs/pom.xml  |  5 +++
 .../ConfigOptionsDocGenerator.java  |  4 +-
 .../ConfigOptionsDocGeneratorTest.java  |  4 +-
 11 files changed, 92 insertions(+), 79 deletions(-)
--


http://git-wip-us.apache.org/repos/asf/flink/blob/14f0c569/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroup.java
--
diff --git 
a/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroup.java
 
b/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroup.java
new file mode 100644
index 000..2b70bd6
--- /dev/null
+++ 
b/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroup.java
@@ -0,0 +1,36 @@
+/*
+ * 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.
+ */
+
+package org.apache.flink.annotation.docs;
+
+import org.apache.flink.annotation.Internal;
+
+import java.lang.annotation.Target;
+
+/**
+ * A class that specifies a group of config options. The name of the group 
will be used as the basis for the
+ * filename of the generated html file, as defined in {@link 
ConfigOptionsDocGenerator}.
+ *
+ * @see ConfigGroups
+ */
+@Target({})
+@Internal
+public @interface ConfigGroup {
+   String name();
+   String keyPrefix();
+}

http://git-wip-us.apache.org/repos/asf/flink/blob/14f0c569/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroups.java
--
diff --git 
a/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroups.java
 
b/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroups.java
new file mode 100644
index 000..53bf856
--- /dev/null
+++ 
b/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroups.java
@@ -0,0 +1,39 @@
+/*
+ * 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.
+ */
+
+package org.apache.flink.annotation.docs;
+
+import org.apache.flink.annotation.Internal;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import

[6/7] flink git commit: [FLINK-8742][docs] Move docs generator annotations to flink-annotations

2018-04-06 Thread chesnay 
[FLINK-8742][docs] Move docs generator annotations to flink-annotations

This closes #5821.
This closes #5787.


Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/47ac3684
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/47ac3684
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/47ac3684

Branch: refs/heads/master
Commit: 47ac3684a195eef5ce319f3e1ac3f966d98b418c
Parents: 8b0f590
Author: zentol 
Authored: Thu Apr 5 12:17:27 2018 +0200
Committer: zentol 
Committed: Fri Apr 6 15:23:02 2018 +0200

--
 .../flink/annotation/docs/ConfigGroup.java  | 36 ++
 .../flink/annotation/docs/ConfigGroups.java | 39 
 .../apache/flink/configuration/ConfigGroup.java | 36 --
 .../flink/configuration/ConfigGroups.java   | 39 
 .../apache/flink/configuration/CoreOptions.java |  2 +
 .../configuration/HighAvailabilityOptions.java  |  2 +
 .../configuration/ResourceManagerOptions.java   |  2 +
 .../flink/configuration/SecurityOptions.java|  2 +
 flink-docs/pom.xml  |  5 +++
 .../ConfigOptionsDocGenerator.java  |  4 +-
 .../ConfigOptionsDocGeneratorTest.java  |  4 +-
 11 files changed, 92 insertions(+), 79 deletions(-)
--


http://git-wip-us.apache.org/repos/asf/flink/blob/47ac3684/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroup.java
--
diff --git 
a/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroup.java
 
b/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroup.java
new file mode 100644
index 000..2b70bd6
--- /dev/null
+++ 
b/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroup.java
@@ -0,0 +1,36 @@
+/*
+ * 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.
+ */
+
+package org.apache.flink.annotation.docs;
+
+import org.apache.flink.annotation.Internal;
+
+import java.lang.annotation.Target;
+
+/**
+ * A class that specifies a group of config options. The name of the group 
will be used as the basis for the
+ * filename of the generated html file, as defined in {@link 
ConfigOptionsDocGenerator}.
+ *
+ * @see ConfigGroups
+ */
+@Target({})
+@Internal
+public @interface ConfigGroup {
+   String name();
+   String keyPrefix();
+}

http://git-wip-us.apache.org/repos/asf/flink/blob/47ac3684/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroups.java
--
diff --git 
a/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroups.java
 
b/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroups.java
new file mode 100644
index 000..53bf856
--- /dev/null
+++ 
b/flink-annotations/src/main/java/org/apache/flink/annotation/docs/ConfigGroups.java
@@ -0,0 +1,39 @@
+/*
+ * 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.
+ */
+
+package org.apache.flink.annotation.docs;
+
+import org.apache.flink.annotation.Internal;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import