Skip to content

Commit f6bdf09

Browse files
authored
Add info on updating package manager ports to lib_dev.rst (#97)
* Add info on updating package manager ports to lib_dev.rst
1 parent d65fcc7 commit f6bdf09

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

docs/dev/lib_dev.rst

+39
Original file line numberDiff line numberDiff line change
@@ -171,3 +171,42 @@ Full Tree Dev
171171

172172
For advanced users (mostly core developers), it might be useful to simultaneously develop multiple apps and/or libraries. For this, please see the :doc:`full_tree` documentation to setup the lib and app tree,
173173
then follow the build instructions in :doc:`build_full_tree`.
174+
175+
Maintaining package manager ports
176+
*********************************
177+
178+
Ports of liblsl are available via a number of third-party package managers.
179+
When new releases of liblsl are published,
180+
these ports can be updated using the following steps:
181+
182+
vcpkg
183+
=====
184+
185+
vcpkg ports are managed in the `microsoft/vcpkg <https://github.com/microsoft/vcpkg>`_ repository on GitHub
186+
and changes or additions are submitted in the form of pull requests.
187+
For a general overview of vcpkg, see https://github.com/microsoft/vcpkg/tree/master/docs.
188+
189+
The liblsl port is maintained at https://github.com/microsoft/vcpkg/tree/master/ports/liblsl.
190+
191+
- For new liblsl releases where no changes have been made in the CMake build scripts,
192+
it should be enough to update the library versions in `vcpkg.json <https://github.com/microsoft/vcpkg/blob/master/ports/liblsl/vcpkg.json>`_
193+
and in `portfile.cmake <https://github.com/microsoft/vcpkg/blob/master/ports/liblsl/portfile.cmake>`_.
194+
195+
- If there have been changes in the CMake build scripts, portfile.cmake may need to be adapted accordingly.
196+
If any dependencies have changed (e.g. the version of Boost), the dependency information in vcpkg.json needs to be updated, as well.
197+
198+
Conan
199+
=====
200+
201+
Conan packages are managed in the `conan-io/conan-center-index <https://github.com/conan-io/conan-center-index>`_ repository on GitHub
202+
and changes or additions are submitted in the form of pull requests.
203+
For a general overview of the Conan package maintainance process, see `Adding Packages to ConanCenter <https://github.com/conan-io/conan-center-index/blob/master/docs/how_to_add_packages.md>`_.
204+
205+
The liblsl port is maintained at https://github.com/conan-io/conan-center-index/tree/master/recipes/liblsl.
206+
207+
- For new liblsl releases where no changes have been made in the CMake build scripts,
208+
it should be enough to add the new library version to `config.yml <https://github.com/conan-io/conan-center-index/blob/master/recipes/liblsl/config.yml>`_
209+
and to `conandata.yml <https://github.com/conan-io/conan-center-index/blob/master/recipes/liblsl/all/conandata.yml>`_.
210+
211+
- If there have been changes in the CMake build scripts, `conanfile.py <https://github.com/conan-io/conan-center-index/blob/master/recipes/liblsl/all/conanfile.py>`_ may need to be adapted accordingly.
212+
If any dependencies have changed (e.g. the version of Boost), the dependency information in conanfile.py needs to be updated, as well.

0 commit comments

Comments
 (0)