Skip to content

Commit

Permalink
ci+docs: switch to pkgconf on macOS
Browse files Browse the repository at this point in the history
Change-Id: I9cb98823c41974d37257c72f67693c2ebce23db8
  • Loading branch information
Pesa committed Dec 10, 2024
1 parent 0311642 commit 5afb1fb
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .jenkins.d/00-deps.sh
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ APT_PKGS=(
pkg-config
python3
)
FORMULAE=(boost openssl pkg-config)
FORMULAE=(boost openssl pkgconf)
PIP_PKGS=()
case $JOB_NAME in
*code-coverage)
Expand Down
16 changes: 8 additions & 8 deletions docs/INSTALL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ following platforms:
- Debian 11 (bullseye)
- Debian 12 (bookworm)
- CentOS Stream 9
- macOS 12 / 13 / 14
- macOS 12 / 13 / 14 / 15

ndn-cxx should also work on the following platforms, although they are not officially
supported:
Expand Down Expand Up @@ -63,7 +63,7 @@ development tools and libraries:

.. code-block:: sh
brew install boost openssl pkg-config
brew install boost openssl pkgconf
.. warning::

Expand Down Expand Up @@ -186,18 +186,18 @@ The ``./waf install`` command installs the following files:
- ``<LIBDIR>/libndn-cxx.so``, ``<LIBDIR>/libndn-cxx.so.<VERSION>`` (on Linux),
``<LIBDIR>/libndn-cxx.dylib``, ``<LIBDIR>/libndn-cxx.<VERSION>.dylib`` (on macOS):
shared NDN C++ library (if enabled).
- ``<LIBDIR>/pkgconfig/libndn-cxx.pc``: pkgconfig file storing all necessary flags to
build against the library. For example, if the ``pkg-config`` or ``pkgconf-pkg-config``
package is installed and ``PKG_CONFIG_PATH`` is configured properly (or if
``<LIBDIR>/pkgconfig`` is a default search path), the command ``pkg-config --cflags
--libs libndn-cxx`` will return all necessary compile and link flags for the library.
- ``<LIBDIR>/pkgconfig/libndn-cxx.pc``: pkgconfig file storing all necessary flags to build
against the library. For example, if the ``pkg-config`` or ``pkgconf`` package is installed
and ``PKG_CONFIG_PATH`` is configured properly (or if ``<LIBDIR>/pkgconfig`` is a default
search path), the command ``pkg-config --cflags --libs libndn-cxx`` will return all
necessary compile and link flags for the ndn-cxx library.
- ``<BINDIR>/ndnsec``: command-line tool to manage NDN keys and certificates.
- ``<BINDIR>/ndnsec-*``: convenience aliases for ``ndnsec`` tools.

If configured with tests (``./waf configure --with-tests``), the above commands
will also produce:

- ``build/unit-tests``: a unit test binary for the library.
- ``build/unit-tests``: a unit test binary for the library; it will not be installed.

1.5 GB available memory per CPU core is necessary for efficient compilation. On a
multi-core machine with less than 1.5 GB available memory per CPU core, limit the
Expand Down

0 comments on commit 5afb1fb

Please sign in to comment.