From commits-return-4379-archive-asf-public=cust-asf.ponee.io@openwhisk.apache.org Tue Apr 24 23:53:16 2018 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx-eu-01.ponee.io (Postfix) with SMTP id 8472A180679 for ; Tue, 24 Apr 2018 23:53:15 +0200 (CEST) Received: (qmail 13159 invoked by uid 500); 24 Apr 2018 21:53:14 -0000 Mailing-List: contact commits-help@openwhisk.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@openwhisk.apache.org Delivered-To: mailing list commits@openwhisk.apache.org Received: (qmail 13150 invoked by uid 99); 24 Apr 2018 21:53:14 -0000 Received: from ec2-52-202-80-70.compute-1.amazonaws.com (HELO gitbox.apache.org) (52.202.80.70) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 24 Apr 2018 21:53:14 +0000 Received: by gitbox.apache.org (ASF Mail Server at gitbox.apache.org, from userid 33) id DDC54807D9; Tue, 24 Apr 2018 21:53:13 +0000 (UTC) Date: Tue, 24 Apr 2018 21:53:13 +0000 To: "commits@openwhisk.apache.org" Subject: [incubator-openwhisk-release] branch master updated: Add the spec to assemble the LICENSE file for each OpenWhisk repo (#127) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Message-ID: <152460679386.26870.1666058295936011201@gitbox.apache.org> From: mrutkowski@apache.org X-Git-Host: gitbox.apache.org X-Git-Repo: incubator-openwhisk-release X-Git-Refname: refs/heads/master X-Git-Reftype: branch X-Git-Oldrev: c5b0a22de8a4b66c4fdaca01e28f34ab5bd8206e X-Git-Newrev: e19b2375b556e5da96c2a4328fa5e89ead9411e5 X-Git-Rev: e19b2375b556e5da96c2a4328fa5e89ead9411e5 X-Git-NotificationType: ref_changed_plus_diff X-Git-Multimail-Version: 1.5.dev Auto-Submitted: auto-generated This is an automated email from the ASF dual-hosted git repository. mrutkowski pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/incubator-openwhisk-release.git The following commit(s) were added to refs/heads/master by this push: new e19b237 Add the spec to assemble the LICENSE file for each OpenWhisk repo (#127) e19b237 is described below commit e19b2375b556e5da96c2a4328fa5e89ead9411e5 Author: Vincent AuthorDate: Tue Apr 24 17:53:11 2018 -0400 Add the spec to assemble the LICENSE file for each OpenWhisk repo (#127) --- docs/project_licenses.md | 117 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 117 insertions(+) diff --git a/docs/project_licenses.md b/docs/project_licenses.md index 3d7c19d..6fbea23 100644 --- a/docs/project_licenses.md +++ b/docs/project_licenses.md @@ -267,6 +267,123 @@ The following table provides a single view, with links, of all project repositor ## Notes - The general requirements and tracking of all LICENSE related update for all repos. are in [Issue 109](https://github.com/apache/incubator-openwhisk-release/issues/109). +## How to assemble the LICENSE file for each OpenWhisk repository + +We define a formal way for OpenWhisk projects to comply in order to produce the LICENSE files. Please follow the mechanism +of syntax and wording narrated in the following paragraphs. + +The LICENSE file consists of two major sections: + +- The content of Apache license 2.0 +- Licenses of packages OpenWhisk project depends on + +The content of the first section can be copied from the link [Apache license 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt). +We can keep it in OpenWhisk exactly the same as its original content, or replace the sentence "Copyright [yyyy] [name of copyright owner]" +with "Copyright 2016-present The Apache Software Foundation", which describes the copyright of OpenWhisk. + +The second section includes the information of licenses used by other software, since OpenWhisk depends on multiple packages +in different ways. Please apply the following rules to identify and describe the relationship between them and OpenWhisk. + +A folder named licenses needs to be created under the home directory of each OpenWhisk project in order to keep the license files +of other packages, each OpenWhisk project depends on. Make sure the license file is named after LICENSE-[package name].txt for each +package. + +So far, we list 4 types of relations available among all OpenWhisk projects. We tend to group the packages by licenses, which +means packages can be listed under one statement, if they share the same license. + +- **Source code dependency**: the packages, that OpenWhisk's source code depends on, and will be released together with OpenWhisk projects. + + For this type of dependency, we used the verb "bundle" to indicate the relationship and add the following narration to LICENSE file to describe it: + + This distribution bundles the following components, which are available under a [license name] license ([link of the licese]). + [package name] [version] ([codename] - [link of the package]) + License included at licenses/LICENSE-[package name].txt + [copyright information] + + [package name] [version] ([codename] - [link of the package]) + License included at licenses/LICENSE-[package name].txt + [copyright information] + ... + +- **Binary dependency**: the packages, that OpenWhisk's source code depends on, but will NOT be released together with OpenWhisk projects. + + For this type of dependency, we use the phrase "have binary dependencies on" to indicate the relationship and add the following narration to LICENSE file to describe it: + + This distribution has binary dependencies on the following components, which are available under a [license name] license ([link of the licese]). + [package name] [version] ([codename] - [link of the package]) + License included at licenses/LICENSE-[package name].txt + [copyright information] + + [package name] [version] ([codename] - [link of the package]) + License included at licenses/LICENSE-[package name].txt + [copyright information] + ... + + For example, OpenWhisk CLI has binary dependencies on go-isatty and go-homedir, which are both licensed with MIT. We are add the following narration + into LICENSE file: + + This distribution has binary dependencies on the following components, which are available an MIT license (http://opensource.org/licenses/MIT). + Go Isatty 66b8e73 (mattn/go-isatty - https://github.com/mattn/go-isatty) + License included at licenses/LICENSE-goisatty.txt, or https://github.com/mattn/go-isatty/blob/master/LICENSE + Copyright (c) Yasuhiro MATSUMOTO + + Go Homedir 1111e45 (mitchellh/go-homedir - https://github.com/mitchellh/go-homedir) + License included at licenses/LICENSE-gohomedir.txt, or https://github.com/mitchellh/go-homedir/blob/master/LICENSE + Copyright (c) 2013 Mitchell Hashimoto + + The content of their licenses are included under licenses/LICENSE-goisatty.txt and licenses/LICENSE-gohomedir.txt. + +- **Packages used by OpenWhisk with no alternative**: the components, that are necessary to deliver OpenWhisk services or tools, +and currently are the only candidates used by OpenWhisk. + + For this type of dependency, we use the phrase "depend on" to indicate the relationship and add the following narration to LICENSE file to describe it: + + This distribution depends on the following components, which are available under a [license name] license ([link of the licese]). + [package name] [version] ([codename] - [link of the package]) + License included at licenses/LICENSE-[package name].txt + [copyright information] + + [package name] [version] ([codename] - [link of the package]) + License included at licenses/LICENSE-[package name].txt + [copyright information] + ... + + For example, OpenWhisk depends on Docker engine, which is licensed with Apache 2.0. We can add the following narration into LICENSE file: + + This distribution depends on the following components, which are available an Apache license 2.0 (https://www.apache.org/licenses/LICENSE-2.0). + Docker engine [Docker version] (Docker - https://www.docker.com) + License included at licenses/LICENSE-docker.txt + Copyright 2013-2017 Docker, Inc + +- **Packages used by OpenWhisk with alternative**: the components, that are necessary to deliver OpenWhisk services or tools, +but can be replaced with other packages by changing OpenWhisk configurations. + + For this type of dependency, we use the phrase "optionally depend on" to indicate the relationship and add the following narration to LICENSE file to describe it: + + This distribution optionally depends on the following components, which are available under a [license name] license ([link of the licese]). + [package name] [version] ([codename] - [link of the package]) + License included at licenses/LICENSE-[package name].txt + [copyright information] + + [package name] [version] ([codename] - [link of the package]) + License included at licenses/LICENSE-[package name].txt + [copyright information] + ... + + For example, OpenWhisk depends on Kafka and CouchDB, which are both licensed with Apache 2.0, but they can be replaced with other + messaging and database services. We can add the following narration into LICENSE file: + + This distribution optionally depends on the following components, which are available an Apache license 2.0 (https://www.apache.org/licenses/LICENSE-2.0). + Apache Kafka [Kafka version] (Kafka - https://github.com/apache/kafka) + License included at licenses/LICENSE-kafka.txt + Copyright 2018 The Apache Software Foundation + + Apache CouchDB [CouchDb version] (CouchDB - https://github.com/apache/couchdb) + License included at licenses/LICENSE-couchdb.txt + Copyright 2009-2016 The Apache Software Foundation + + The content of their licenses are included under licenses/LICENSE-kafka.txt and licenses/LICENSE-couchdb.txt. + ## References The following is a list of informative references that describe licenses that you may encounter in this project's along with their prescribed treatment by the owning entities. -- To stop receiving notification emails like this one, please contact mrutkowski@apache.org.