Re: [Patch 2/2] edk2: Update to Tiano Contribution Agreement 1.1

["Kinney, Michael D" <michael.d.kinney@intel.com>]

Hi Jordan,

Thanks for the feedback.

I will add more background to the commit message from the
details in the Bugzilla and in RFC in edk2-devel.

I agree to change the filename from CONTRIBUTIONS.txt
to Contributions.txt to follow EDK II file name convention.

The Free BSD Documentation project was used as a reference
for this update.  This most closely matches the BSD license
used for the majority of the EDK II source files but adds
language for documentation files in both source and compiled
forms.

https://www.freebsd.org/copyright/freebsd-doc-license.html

Yes. If a document was provided under the BSD 2-clause license
for source code, the document would be rejected and a request
would be made to use the documentation license for the TianoCore
Project.

https://github.com/tianocore-docs/edk2-TemplateSpecification/blob/master/LICENSE.txt

Details on all the license requirements for a document in
document source files and compiled documents can be found
in the following Wiki:

https://github.com/tianocore-docs/edk2-TemplateSpecification/wiki

Document source file headers:

https://github.com/tianocore-docs/edk2-TemplateSpecification/wiki/TianoCore-Documents-MarkDown-File-Headers

Published document license and copyright requirements:

https://github.com/tianocore-docs/edk2-TemplateSpecification/wiki/TianoCore-Documents-Layout#published-document-license-and-copyright

I am going to add a top level Readme.md to the edk2 repo.
I will add the content that was removed from Contributions.txt
to this Readme.md file.  The contents of Readme.md are 
shown when anyone browses to the edk2 repo on GitHub, so it
is a more obvious place to put the details for how to make 
a contribution and I will also add links to the wiki pages
with complete details on this topic.

I agree that Contributions.txt can be reflowed to 80 columns.
I will split the series into additional patches, so the 
text change is obvious without reflow followed by a patch with
reflow.  I like your idea to do 4 patches.

I also agree that a space can be added before the '('.

I will send out a V2 version of the series soon.

Best regards,

Mike


> -----Original Message-----
> From: Justen, Jordan L
> Sent: Monday, July 17, 2017 5:02 PM
> To: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-
> devel@lists.01.org
> Cc: Andrew Fish <afish@apple.com>; Leif Lindholm
> <leif.lindholm@linaro.org>
> Subject: Re: [edk2] [Patch 2/2] edk2: Update to Tiano
> Contribution Agreement 1.1
> 
> On 2017-07-17 14:28:29, Michael D Kinney wrote:
> > https://bugzilla.tianocore.org/show_bug.cgi?id=629
> >
> 
> Why doesn't the commit message mention the purpose of the 1.0 to
> 1.1
> change?
> 
> > Cc: Leif Lindholm <leif.lindholm@linaro.org>
> > Cc: Andrew Fish <afish@apple.com>
> > Contributed-under: TianoCore Contribution Agreement 1.1
> > Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
> > ---
> >
> > diff --git a/AppPkg/Contributions.txt b/CONTRIBUTIONS.txt
> 
> Why is this not named Contributions.txt? I think CONTRIBUTIONS
> would
> be common for open source, and EDK II would prefer
> Contributions.txt,
> but CONTRIBUTIONS.txt looks like some sort of hybrid. :)
> 
> > similarity index 79%
> > rename from AppPkg/Contributions.txt
> > rename to CONTRIBUTIONS.txt
> > index f87cbd73c6..0c9c2be6e7 100644
> > --- a/AppPkg/Contributions.txt
> > +++ b/CONTRIBUTIONS.txt
> > @@ -1,4 +1,3 @@
> > -
> >  ======================
> >  = Code Contributions =
> >  ======================
> > @@ -27,6 +26,7 @@ To make a contribution to a TianoCore
> project, follow these steps.
> >     * MIT: http://opensource.org/licenses/MIT
> >     * Python-2.0: http://opensource.org/licenses/Python-2.0
> >     * Zlib: http://opensource.org/licenses/Zlib
> > +   For documentation:
> https://www.freebsd.org/copyright/freebsd-doc-license.html
> >
> 
> I think you should add a blank line above 'For documentation' and
> move
> the url to the next line with a bullet.
> 
> Can you explain why the different license is required? Maybe that
> should be in the commit message?
> 
> Fedora has a wiki page about documentation licensing options:
> 
> https://fedoraproject.org/wiki/Licensing:Main?rd=Licensing#Docume
> ntation_Licenses
> 
> Were any of these other options considered?
> 
> If someone contributed a document using the BSD license, would it
> be
> rejected?
> 
> >
> > -=====================================================
> > -= Change Description / Commit Message / Patch Email =
> > -=====================================================
> > -
> 
> [snip]
> 
> > -* "Signed-off-by" is the contributor's signature identifying
> them
> > -  by their real/legal name and their email address.
> > -
> 
> Why is this all removed? This was one area we could point
> contributors
> when they don't know how to contribute a patch.
> 
> >  ========================================
> > -= TianoCore Contribution Agreement 1.0 =
> > += TianoCore Contribution Agreement 1.1 =
> >  ========================================
> >
> > -INTEL CORPORATION ("INTEL") MAKES AVAILABLE SOFTWARE,
> DOCUMENTATION,
> > +INTEL CORPORATION ("INTEL") MAKES AVAILABLE SOFTWARE,
> DOCUMENTATION ("DOCUMENTATION"),
> 
> We should reflow the text to be < 80 columns. Leif mentioned that
> this
> makes it more obvious what the changes are. Okay, how about
> splitting
> patch 2 into 4 patches.
> 
> 1. Move the existing Contributions.txt to the root with no
> changes.
> 
> 2. Remove all the info about how to properly submit a patch. (I
> actually don't think we should make this change.)
> 
> 3. Add the new 1.1 text so it is obvious what changed, even if
> lines
> go above 80 columns.
> 
> 4. Reflow the long lines.
> 
> >  Certain other content may be made available under other
> licenses as
> > -indicated in or with such Content. (For example, in a
> License.txt file.)
> > +indicated in or with such Content(for example, in a
> License.txt file).
> 
> Do we need this change? It seemed better before.
> 
> At the least, I think you'd want a space before that parentheses.
> 
> -Jordan