ericLemanissier/conan-center-index
1
0
Fork 1
mirror of https://github.com/conan-io/conan-center-index.git synced 2025-08-14 02:35:37 +00:00
Code Issues 6 Packages Projects Releases Wiki Activity

(#6919) [docs] How to add system packages

Browse Source 
* How to add system packages

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Update GTK branch

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Replace GTK by OpenCL

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Update docs/faqs.md

* Update docs/how_to_add_packages.md
This commit is contained in:
Uilian Ries
2021-09-13 04:31:47 -03:00
committed by GitHub
parent 42df0abe05
commit c0d86ab7c4
2 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/faqs.md
View File

@@ -203,6 +203,19 @@ As a result, all calls to `tools.check_min_cppstd` must be guarded by a check fo
We defer adding older versions without a direct requirement. We love to hear why in the opening description of the PR.
This is for historical reasons, when older versions were permitted the overwhelming majority received zero downloads and were never used by the community while still increasing the burden on the build system.
## Can I install packages from the system package manager?
It depends. You can not mix both regular projects with system packages, but you can provide package wrappers for system packages.
The [SystemPackageTool](https://docs.conan.io/en/latest/reference/conanfile/methods.html#systempackagetool) can easily manage a system package manager (e.g. apt,
pacman, brew, choco) and install packages which are missing on Conan Center but available for most distributions. However, Conan can not track system packages, like their
version and options, which creates a fragile situation where affects libraries and binaries built in your package but can not be totally reproduced.
Also, system package managers require administrator permission to install packages, which is not always possible and may break limited users. Moreover, more than one Conan package may require the same system package and there is no way to track their mutual usage.
The hook [KB-H032](error_knowledge_base.md#KB-H032) does not allow `system_requirement` nor `SystemPackageTool` in recipes, to avoid mixing both regular projects with
system packages at same recipe.
However, there are exceptions where some projects are closer to system drivers or hardware and packaging as a regular library could result
in an incompatible Conan package. To deal with those cases, you are allowed to provide an exclusive Conan package which only installs system packages, the
[OpenGL](https://github.com/conan-io/conan-center-index/blob/master/recipes/opengl/all/conanfile.py) is a good example.
## Why ConanCenter does **not** build and execute tests in recipes
<!-- ref https://github.com/conan-io/conan-center-index/pull/5405#issuecomment-854618305 -->

3
docs/how_to_add_packages.md
View File

@@ -174,6 +174,9 @@ Many projects offer **pkg-config**'s `*.pc` files which need to be modeled using
For cases where a project only offers source files, but not a build script, you can add CMake support, but first, contact the upstream and open a PR offering building support. If it's rejected because the author doesn't want any kind of build script, or the project is abandoned, CCI can accept your build script. Take a look at [Bzip2](https://github.com/conan-io/conan-center-index/blob/master/recipes/bzip2/all/CMakeLists.txt) and [DirectShowBaseClasses](https://github.com/conan-io/conan-center-index/blob/master/recipes/directshowbaseclasses/all/CMakeLists.txt) as examples.
For exceptional cases where only system packages can be used and a regular Conan package may be result in an incompatible and fragile package, a separated system package
may be created. As example there are [glu](https://github.com/conan-io/conan-center-index/blob/master/recipes/glu/all/conanfile.py) and [OpenGL](https://github.com/conan-io/conan-center-index/blob/master/recipes/opengl/all/conanfile.py). Also, it will require an exception rule for [conan-center hook](https://github.com/conan-io/hooks#conan-center), a [pull request](https://github.com/conan-io/hooks/pulls) should be open to allow it over the KB-H032.
## Test the recipe locally
The system will use the [conan-center hook](https://github.com/conan-io/hooks) to perform some quality checks. You can install the hook running: