Skip to content

CDRIVER-4797 Restore documentation describing dev packages #1495

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

Merged
merged 3 commits into from
Dec 20, 2023
Merged

CDRIVER-4797 Restore documentation describing dev packages #1495

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bba2c1a
note distinction of development packages
kevinAlbs Dec 20, 2023
bd1a48b
fix typo
kevinAlbs Dec 20, 2023
e33f093
describe how to check version
kevinAlbs Dec 20, 2023
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
10 changes: 9 additions & 1 deletion src/libmongoc/doc/learn/get/installing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ Yum/DNF.
# yum install epel-release

`epel-release` must be installed before attempting to install the C driver
libraries (i.e. one cannot install them both in a single `yum intsall`
libraries (i.e. one cannot install them both in a single `yum install`
command).

To install |libbson| only, install the `libbson-devel` package::
Expand All @@ -207,6 +207,10 @@ To install the full C database driver (|libmongoc|), install
## (This package will transitively install libbson-devel)
# yum install mongo-c-driver-devel

To check which version is available, see https://packages.fedoraproject.org/pkgs/mongo-c-driver/mongo-c-driver-devel.

The development packages (ending in `-devel`) include files required to build applications using |libbson| and |libmongoc|.
To only install the libraries without development files, install the `libbson` or `mongo-c-driver-libs` packages.

.. index::
!pair: installation; Debian
Expand All @@ -232,6 +236,10 @@ To install |libmongoc| (which will also install |libbson|)::

# apt install libmongoc-dev

To check which version is available, run `apt-cache policy libmongoc-dev`.

The development packages (ending in `-dev`) include files required to build applications using |libbson| and |libmongoc|.
To only install the libraries without development files, install the `libbson-1.0-0` or `libmongoc-1.0-0` packages.

.. index::
!pair: installation; macOS
Expand Down
4 changes: 4 additions & 0 deletions src/libmongoc/doc/ref/packages.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ Package Names and Availability

This table details the names and usage notes of such packages.

.. note::

The development packages (ending in ``-dev`` or ``-devel``) include files required to build applications using |libbson| and |libmongoc|.

.. seealso::

For a step-by-step tutorial on installing packages, refer to
Expand Down