1*f578df4fSJingwen Chen<!-- Generated with Stardoc: http://skydoc.bazel.build --> 2*f578df4fSJingwen Chen 3*f578df4fSJingwen ChenRules for declaring the compliance licenses used by a package. 4*f578df4fSJingwen Chen 5*f578df4fSJingwen Chen 6*f578df4fSJingwen Chen 7*f578df4fSJingwen Chen<a id="license"></a> 8*f578df4fSJingwen Chen 9*f578df4fSJingwen Chen## license 10*f578df4fSJingwen Chen 11*f578df4fSJingwen Chen<pre> 12*f578df4fSJingwen Chenlicense(<a href="#license-name">name</a>, <a href="#license-copyright_notice">copyright_notice</a>, <a href="#license-license_kinds">license_kinds</a>, <a href="#license-license_text">license_text</a>, <a href="#license-namespace">namespace</a>, <a href="#license-package_name">package_name</a>, <a href="#license-package_url">package_url</a>, 13*f578df4fSJingwen Chen <a href="#license-package_version">package_version</a>) 14*f578df4fSJingwen Chen</pre> 15*f578df4fSJingwen Chen 16*f578df4fSJingwen Chen 17*f578df4fSJingwen Chen 18*f578df4fSJingwen Chen**ATTRIBUTES** 19*f578df4fSJingwen Chen 20*f578df4fSJingwen Chen 21*f578df4fSJingwen Chen| Name | Description | Type | Mandatory | Default | 22*f578df4fSJingwen Chen| :------------- | :------------- | :------------- | :------------- | :------------- | 23*f578df4fSJingwen Chen| <a id="license-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | | 24*f578df4fSJingwen Chen| <a id="license-copyright_notice"></a>copyright_notice | Copyright notice. | String | optional | <code>""</code> | 25*f578df4fSJingwen Chen| <a id="license-license_kinds"></a>license_kinds | License kind(s) of this license. If multiple license kinds are listed in the LICENSE file, and they all apply, then all should be listed here. If the user can choose a single one of many, then only list one here. | <a href="https://bazel.build/concepts/labels">List of labels</a> | optional | <code>[]</code> | 26*f578df4fSJingwen Chen| <a id="license-license_text"></a>license_text | The license file. | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>LICENSE</code> | 27*f578df4fSJingwen Chen| <a id="license-namespace"></a>namespace | A human readable name used to organize licenses into categories. This is used in google3 to differentiate third party licenses used for compliance versus internal licenses used by SLAsan for internal teams' SLAs. | String | optional | <code>""</code> | 28*f578df4fSJingwen Chen| <a id="license-package_name"></a>package_name | A human readable name identifying this package. This may be used to produce an index of OSS packages used by an applicatation. | String | optional | <code>""</code> | 29*f578df4fSJingwen Chen| <a id="license-package_url"></a>package_url | The URL this instance of the package was download from. This may be used to produce an index of OSS packages used by an applicatation. | String | optional | <code>""</code> | 30*f578df4fSJingwen Chen| <a id="license-package_version"></a>package_version | A human readable version string identifying this package. This may be used to produce an index of OSS packages used by an applicatation. It should be a value that increases over time, rather than a commit hash. | String | optional | <code>""</code> | 31*f578df4fSJingwen Chen 32*f578df4fSJingwen Chen 33*f578df4fSJingwen Chen 34*f578df4fSJingwen Chen<!-- Generated with Stardoc: http://skydoc.bazel.build --> 35*f578df4fSJingwen Chen 36*f578df4fSJingwen ChenProof of concept. License restriction. 37*f578df4fSJingwen Chen 38*f578df4fSJingwen Chen<a id="license_kind"></a> 39*f578df4fSJingwen Chen 40*f578df4fSJingwen Chen## license_kind 41*f578df4fSJingwen Chen 42*f578df4fSJingwen Chen<pre> 43*f578df4fSJingwen Chenlicense_kind(<a href="#license_kind-name">name</a>, <a href="#license_kind-canonical_text">canonical_text</a>, <a href="#license_kind-conditions">conditions</a>, <a href="#license_kind-long_name">long_name</a>, <a href="#license_kind-url">url</a>) 44*f578df4fSJingwen Chen</pre> 45*f578df4fSJingwen Chen 46*f578df4fSJingwen Chen 47*f578df4fSJingwen Chen 48*f578df4fSJingwen Chen**ATTRIBUTES** 49*f578df4fSJingwen Chen 50*f578df4fSJingwen Chen 51*f578df4fSJingwen Chen| Name | Description | Type | Mandatory | Default | 52*f578df4fSJingwen Chen| :------------- | :------------- | :------------- | :------------- | :------------- | 53*f578df4fSJingwen Chen| <a id="license_kind-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | | 54*f578df4fSJingwen Chen| <a id="license_kind-canonical_text"></a>canonical_text | File containing the canonical text for this license. Must be UTF-8 encoded. | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> | 55*f578df4fSJingwen Chen| <a id="license_kind-conditions"></a>conditions | Conditions to be met when using software under this license. Conditions are defined by the organization using this license. | List of strings | required | | 56*f578df4fSJingwen Chen| <a id="license_kind-long_name"></a>long_name | Human readable long name of license. | String | optional | <code>""</code> | 57*f578df4fSJingwen Chen| <a id="license_kind-url"></a>url | URL pointing to canonical license definition | String | optional | <code>""</code> | 58*f578df4fSJingwen Chen 59*f578df4fSJingwen Chen 60*f578df4fSJingwen Chen 61*f578df4fSJingwen Chen<!-- Generated with Stardoc: http://skydoc.bazel.build --> 62*f578df4fSJingwen Chen 63*f578df4fSJingwen ChenRules for declaring metadata about a package. 64*f578df4fSJingwen Chen 65*f578df4fSJingwen Chen<a id="package_info"></a> 66*f578df4fSJingwen Chen 67*f578df4fSJingwen Chen## package_info 68*f578df4fSJingwen Chen 69*f578df4fSJingwen Chen<pre> 70*f578df4fSJingwen Chenpackage_info(<a href="#package_info-name">name</a>, <a href="#package_info-package_name">package_name</a>, <a href="#package_info-package_url">package_url</a>, <a href="#package_info-package_version">package_version</a>) 71*f578df4fSJingwen Chen</pre> 72*f578df4fSJingwen Chen 73*f578df4fSJingwen Chen 74*f578df4fSJingwen Chen 75*f578df4fSJingwen Chen**ATTRIBUTES** 76*f578df4fSJingwen Chen 77*f578df4fSJingwen Chen 78*f578df4fSJingwen Chen| Name | Description | Type | Mandatory | Default | 79*f578df4fSJingwen Chen| :------------- | :------------- | :------------- | :------------- | :------------- | 80*f578df4fSJingwen Chen| <a id="package_info-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | | 81*f578df4fSJingwen Chen| <a id="package_info-package_name"></a>package_name | A human readable name identifying this package. This may be used to produce an index of OSS packages used by an applicatation. | String | optional | <code>""</code> | 82*f578df4fSJingwen Chen| <a id="package_info-package_url"></a>package_url | The URL this instance of the package was download from. This may be used to produce an index of OSS packages used by an applicatation. | String | optional | <code>""</code> | 83*f578df4fSJingwen Chen| <a id="package_info-package_version"></a>package_version | A human readable version string identifying this package. This may be used to produce an index of OSS packages used by an applicatation. It should be a value that increases over time, rather than a commit hash. | String | optional | <code>""</code> | 84*f578df4fSJingwen Chen 85*f578df4fSJingwen Chen 86*f578df4fSJingwen Chen 87*f578df4fSJingwen Chen<!-- Generated with Stardoc: http://skydoc.bazel.build --> 88*f578df4fSJingwen Chen 89*f578df4fSJingwen ChenProviders for license rules. 90*f578df4fSJingwen Chen 91*f578df4fSJingwen Chen<a id="LicenseInfo"></a> 92*f578df4fSJingwen Chen 93*f578df4fSJingwen Chen## LicenseInfo 94*f578df4fSJingwen Chen 95*f578df4fSJingwen Chen<pre> 96*f578df4fSJingwen ChenLicenseInfo(<a href="#LicenseInfo-copyright_notice">copyright_notice</a>, <a href="#LicenseInfo-label">label</a>, <a href="#LicenseInfo-license_kinds">license_kinds</a>, <a href="#LicenseInfo-license_text">license_text</a>, <a href="#LicenseInfo-namespace">namespace</a>, <a href="#LicenseInfo-package_name">package_name</a>, 97*f578df4fSJingwen Chen <a href="#LicenseInfo-package_url">package_url</a>, <a href="#LicenseInfo-package_version">package_version</a>) 98*f578df4fSJingwen Chen</pre> 99*f578df4fSJingwen Chen 100*f578df4fSJingwen ChenProvides information about a license instance. 101*f578df4fSJingwen Chen 102*f578df4fSJingwen Chen**FIELDS** 103*f578df4fSJingwen Chen 104*f578df4fSJingwen Chen 105*f578df4fSJingwen Chen| Name | Description | 106*f578df4fSJingwen Chen| :------------- | :------------- | 107*f578df4fSJingwen Chen| <a id="LicenseInfo-copyright_notice"></a>copyright_notice | string: Human readable short copyright notice | 108*f578df4fSJingwen Chen| <a id="LicenseInfo-label"></a>label | Label: label of the license rule | 109*f578df4fSJingwen Chen| <a id="LicenseInfo-license_kinds"></a>license_kinds | list(LicenseKindInfo): License kinds | 110*f578df4fSJingwen Chen| <a id="LicenseInfo-license_text"></a>license_text | string: The license file path | 111*f578df4fSJingwen Chen| <a id="LicenseInfo-namespace"></a>namespace | string: namespace of the license rule | 112*f578df4fSJingwen Chen| <a id="LicenseInfo-package_name"></a>package_name | string: Human readable package name | 113*f578df4fSJingwen Chen| <a id="LicenseInfo-package_url"></a>package_url | URL from which this package was downloaded. | 114*f578df4fSJingwen Chen| <a id="LicenseInfo-package_version"></a>package_version | Human readable version string | 115*f578df4fSJingwen Chen 116*f578df4fSJingwen Chen 117*f578df4fSJingwen Chen 118*f578df4fSJingwen Chen<!-- Generated with Stardoc: http://skydoc.bazel.build --> 119*f578df4fSJingwen Chen 120*f578df4fSJingwen ChenProviders for license rules. 121*f578df4fSJingwen Chen 122*f578df4fSJingwen Chen<a id="LicenseKindInfo"></a> 123*f578df4fSJingwen Chen 124*f578df4fSJingwen Chen## LicenseKindInfo 125*f578df4fSJingwen Chen 126*f578df4fSJingwen Chen<pre> 127*f578df4fSJingwen ChenLicenseKindInfo(<a href="#LicenseKindInfo-conditions">conditions</a>, <a href="#LicenseKindInfo-label">label</a>, <a href="#LicenseKindInfo-long_name">long_name</a>, <a href="#LicenseKindInfo-name">name</a>) 128*f578df4fSJingwen Chen</pre> 129*f578df4fSJingwen Chen 130*f578df4fSJingwen ChenProvides information about a license_kind instance. 131*f578df4fSJingwen Chen 132*f578df4fSJingwen Chen**FIELDS** 133*f578df4fSJingwen Chen 134*f578df4fSJingwen Chen 135*f578df4fSJingwen Chen| Name | Description | 136*f578df4fSJingwen Chen| :------------- | :------------- | 137*f578df4fSJingwen Chen| <a id="LicenseKindInfo-conditions"></a>conditions | list(string): List of conditions to be met when using this packages under this license. | 138*f578df4fSJingwen Chen| <a id="LicenseKindInfo-label"></a>label | Label: The full path to the license kind definition. | 139*f578df4fSJingwen Chen| <a id="LicenseKindInfo-long_name"></a>long_name | string: Human readable license name | 140*f578df4fSJingwen Chen| <a id="LicenseKindInfo-name"></a>name | string: Canonical license name | 141*f578df4fSJingwen Chen 142*f578df4fSJingwen Chen 143*f578df4fSJingwen Chen 144*f578df4fSJingwen Chen<!-- Generated with Stardoc: http://skydoc.bazel.build --> 145*f578df4fSJingwen Chen 146*f578df4fSJingwen ChenProviders for license rules. 147*f578df4fSJingwen Chen 148*f578df4fSJingwen Chen<a id="PackageInfo"></a> 149*f578df4fSJingwen Chen 150*f578df4fSJingwen Chen## PackageInfo 151*f578df4fSJingwen Chen 152*f578df4fSJingwen Chen<pre> 153*f578df4fSJingwen ChenPackageInfo(<a href="#PackageInfo-type">type</a>, <a href="#PackageInfo-label">label</a>, <a href="#PackageInfo-package_name">package_name</a>, <a href="#PackageInfo-package_url">package_url</a>, <a href="#PackageInfo-package_version">package_version</a>) 154*f578df4fSJingwen Chen</pre> 155*f578df4fSJingwen Chen 156*f578df4fSJingwen ChenProvides information about a package. 157*f578df4fSJingwen Chen 158*f578df4fSJingwen Chen**FIELDS** 159*f578df4fSJingwen Chen 160*f578df4fSJingwen Chen 161*f578df4fSJingwen Chen| Name | Description | 162*f578df4fSJingwen Chen| :------------- | :------------- | 163*f578df4fSJingwen Chen| <a id="PackageInfo-type"></a>type | string: How to interpret data | 164*f578df4fSJingwen Chen| <a id="PackageInfo-label"></a>label | Label: label of the package_info rule | 165*f578df4fSJingwen Chen| <a id="PackageInfo-package_name"></a>package_name | string: Human readable package name | 166*f578df4fSJingwen Chen| <a id="PackageInfo-package_url"></a>package_url | string: URL from which this package was downloaded. | 167*f578df4fSJingwen Chen| <a id="PackageInfo-package_version"></a>package_version | string: Human readable version string | 168*f578df4fSJingwen Chen 169*f578df4fSJingwen Chen 170*f578df4fSJingwen Chen 171