diff options
author | 2016-06-20 17:27:28 +0000 | |
---|---|---|
committer | 2016-06-21 09:58:14 +0000 | |
commit | 662dadd57662400c3a59edfa5347e1cf917053aa (patch) | |
tree | bb89e8d92cc75bbee761353099319ff560ce3a6c /src/main/java/com/google/devtools | |
parent | 28de2754fa6f3dce071e630bbf6e14aa7f554acd (diff) |
Add license types to the documentation
Fixes #642.
--
MOS_MIGRATED_REVID=125351602
Diffstat (limited to 'src/main/java/com/google/devtools')
-rw-r--r-- | src/main/java/com/google/devtools/build/docgen/templates/be/functions.vm | 23 | ||||
-rw-r--r-- | src/main/java/com/google/devtools/build/lib/packages/PackageFactory.java | 16 |
2 files changed, 15 insertions, 24 deletions
diff --git a/src/main/java/com/google/devtools/build/docgen/templates/be/functions.vm b/src/main/java/com/google/devtools/build/docgen/templates/be/functions.vm index 19784a3564..3bea6a4c26 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/be/functions.vm +++ b/src/main/java/com/google/devtools/build/docgen/templates/be/functions.vm @@ -308,15 +308,20 @@ package_group( </p> -<h3 id="licenses_example">Examples</h3> - -<p>The following example specifies a single license type of - <code>"notice"</code>. Third-party software licenses that do not require - publishing of source code changes but require some sort of copyright or - other public notice are included in this license type. -</p> - -<pre class="code"> +<p>Legal license types include:</p> +<dl> +<dt><code>restricted</code></dt><dd>Requires mandatory source distribution.</dd> +<dt><code>reciprocal</code></dt><dd>Allows usage of software freely in +<b>unmodified</b> form. Any modifications must be made freely available.</dd> +<dt><code>notice</code></dt><dd>Original or modified third-party software may be +shipped without danger nor encumbering other sources. All of the licenses in this +category do, however, have an \"original Copyright notice\" or +\"advertising clause\", wherein any external distributions must include the notice +or clause specified in the license.</dd> +<dt><code>permissive</code></dt><dd>Code that is under a license but does not +require a notice.</dd> +<dt><code>unencumbered</code></dt><dd>Public domain, free for any use.</dd> +</dl> licenses(["notice"]) # MIT license diff --git a/src/main/java/com/google/devtools/build/lib/packages/PackageFactory.java b/src/main/java/com/google/devtools/build/lib/packages/PackageFactory.java index 972f7486bf..85a3adbccf 100644 --- a/src/main/java/com/google/devtools/build/lib/packages/PackageFactory.java +++ b/src/main/java/com/google/devtools/build/lib/packages/PackageFactory.java @@ -759,21 +759,7 @@ public final class PackageFactory { * TODO(bazel-team): Remove in favor of package.licenses. */ @SkylarkSignature(name = "licenses", returnType = Runtime.NoneType.class, - doc = "Declare the license(s) for the code in the current package. Legal license types " - + "include:\n" - + "<dl>" - + "<dt><code>restricted</code></dt><dd>Requires mandatory source distribution.</dd>" - + "<dt><code>reciprocal</code></dt><dd>Allows usage of software freely in " - + "<b>unmodified</b> form. Any modifications must be made freely available.</dd>" - + "<dt><code>notice</code></dt><dd>Original or modified third-party software may be " - + "shipped without danger nor encumbering other sources. All of the licenses in this " - + "category do, however, have an \"original Copyright notice\" or " - + "\"advertising clause\", wherein any external distributions must include the notice " - + "or clause specified in the license.</dd>" - + "<dt><code>permissive</code></dt><dd>Code that is under a license but does not " - + "require a notice.</dd>" - + "<dt><code>unencumbered</code></dt><dd>Public domain, free for any use.</dd>" - + "</dl>", + doc = "Declare the license(s) for the code in the current package.", parameters = { @Param(name = "license_strings", type = SkylarkList.class, generic1 = String.class, doc = "A list of strings, the names of the licenses used.")}, |