You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2015/11/23 14:01:57 UTC
incubator-tinkerpop git commit: Update dev docs on latest
understanding of LICENSE/NOTICE.
Repository: incubator-tinkerpop
Updated Branches:
refs/heads/master f08a44889 -> af4a38510
Update dev docs on latest understanding of LICENSE/NOTICE.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/af4a3851
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/af4a3851
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/af4a3851
Branch: refs/heads/master
Commit: af4a385101fc5e659731bcc134720b60623d549a
Parents: f08a448
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Mon Nov 23 08:01:35 2015 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Mon Nov 23 08:01:35 2015 -0500
----------------------------------------------------------------------
docs/src/dev/developer/contributing.asciidoc | 36 ++++++++++++++++-------
1 file changed, 25 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/af4a3851/docs/src/dev/developer/contributing.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/dev/developer/contributing.asciidoc b/docs/src/dev/developer/contributing.asciidoc
index 23be871..cba6b3a 100644
--- a/docs/src/dev/developer/contributing.asciidoc
+++ b/docs/src/dev/developer/contributing.asciidoc
@@ -339,13 +339,19 @@ link:https://github.com/apache/incubator-tinkerpop/blob/master/LICENSE[LICENSE]
** Gremlin Server link:https://github.com/apache/incubator-tinkerpop/blob/master/gremlin-server/src/main/LICENSE[LICENSE]
/ link:https://github.com/apache/incubator-tinkerpop/blob/master/gremlin-server/src/main/NOTICE[NOTICE]
-As we don't usually include any dependencies in the source distribution (i.e. the source zip distribution), there is
+Source LICENSE and NOTICE
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+As dependencies are not typically added to the source distribution (i.e. the source zip distribution), there is
typically no need to edit source LICENSE/NOTICE when editing a TinkerPop `pom.xml`. These files only need to be edited
if the distribution has a file added to it. Such a situation may arise from several scenarios, but it would most
-likely come from the addition of a source file from another library. In that case, edit LICENSE to include this file
-following the pattern already present there. Refer to the
-link:http://www.apache.org/dev/licensing-howto.html#mod-notice[Modifications to Notice] section from the Apache
-"how-to" to determine if changes are necessary there.
+likely come from the addition of a source file from another library.
+
+* If the file being bundled is Apache licensed, then add an entry to NOTICE.
+* If the file being bundled is under a different approved license, then add an entry to LICENSE.
+
+Binary LICENSE and NOTICE
+^^^^^^^^^^^^^^^^^^^^^^^^^
The binary LICENSE/NOTICE is perhaps most impacted by changes to the various `pom.xml` files. After altering the
`pom.xml` file of any module, build both Gremlin Console and Gremlin Server and examine the contents of both binary
@@ -354,13 +360,21 @@ distributions, either:
* target/apache-gremlin-console-x.y.z-distribution.zip
* target/apache-gremlin-server-x.y.z-distribution.zip
-There is a _near_ one-to-one mapping between the jar files in those distributions and their respective LICENSE files.
-It is described as "near" because the distributions include TinkerPop jars which don't need to be represented there
-and there are entries in LICENSE that refer to libraries that are present, but shaded in the gremlin-shaded module.
-Everything else should be listed and present under the appropriate license section.
+Apache licensed software does not need to be included in LICENSE, but if the new dependency is an Apache-approved
+license then it should be added in the pattern already defined.
+
+To determine if changes are required to the NOTICE, first check if the bundled jar has a NOTICE file in it.
+
+* If the NOTICE of the file being bundled is NOT Apache licensed then there is no change to TinkerPop's NOTICE.
+* If the NOTICE of the file being bundled is Apache licensed then include the copyright notification in TinkerPop's
+NOTICE.
+* If the NOTICE of the file being bundled is Apache licensed AND is an Apache Software Foundation project, then
+ONLY include the portion of that NOTICE in TinkerPop's NOTICE that is unrelated to the Apache boilerplate NOTICE.
+If there is no such portion that is different than the boilerplate then this NOTICE can be excluded (i.e. don't
+alter TinkerPop's NOTICE at all).
-There is also a good chance that the TinkerPop binary NOTICE should be updated. Check if the newly added dependency
-contains a NOTICE of its own. If so, include that NOTICE in the TinkerPop NOTICE.
+Please refer to the link:http://www.apache.org/dev/licensing-howto.html#mod-notice[Modifications to Notice] section
+of the Apache "Licensing How-to" for more information.
[[documentation]]
Documentation