Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Encourage use of SPDX licenses in the "license" attribute of ConanFile #858

Merged
merged 1 commit into from
Oct 1, 2018
Merged

Encourage use of SPDX licenses in the "license" attribute of ConanFile #858

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions reference/conanfile/attributes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,12 @@ the :command:`conan info` command and possibly other search and report tools.
This attribute can contain several, comma separated licenses. It is a text string, so it can
contain any text, including hyperlinks to license files elsewhere.

However, we strongly recommend packagers of Open-Source projects to use
[SPDX](https://spdx.org/) identifiers from the [SPDX license
list](https://spdx.org/licenses/) instead of free-formed text. This will help
people wanting to automate license compatibility checks, like consumers of your
package, or you if your package has Open-Source dependencies.

This is a recommended, but not mandatory attribute.

author
Expand Down Expand Up @@ -166,7 +172,7 @@ For these reasons, the most common convention among Conan recipes is to distingu

settings = "os", "compiler", "build_type", "arch"

When Conan generates a compiled binary for a package with a given combination of the settings above, it generates a unique ID for that binary by hashing the current values of these settings.
When Conan generates a compiled binary for a package with a given combination of the settings above, it generates a unique ID for that binary by hashing the current values of these settings.

But what happens for example to **header only libraries**? The final package for such libraries is not
binary and, in most cases it will be identical, unless it is automatically generating code.
Expand Down Expand Up @@ -688,8 +694,7 @@ To get a list of all the dependency names from ```deps_cpp_info```, you can call
def build(self):
# deps is a list of package names: ["Poco", "zlib", "OpenSSL"]
deps = self.deps_cpp_info.deps



liberforce marked this conversation as resolved.
Show resolved Hide resolved
It can be used to get information about the dependencies, like used compilation flags or the
root folder of the package:

Expand Down