Blame src/libnm-core-aux-intern/README.md

Packit Service dff8e4
libnm-core-aux-intern
Packit Service dff8e4
=====================
Packit Service dff8e4
Packit Service dff8e4
`libnm-core-aux-intern` is a static library that:
Packit Service dff8e4
Packit Service dff8e4
 - uses parts of [`libnm-core-impl`](../libnm-core-impl), that are public API
Packit Service dff8e4
   of [`libnm`](../../libnm) (i.e. [`libnm-core-public`](../libnm-core-public)).
Packit Service dff8e4
 - that is statically linked into [`libnm-core-impl`](../libnm-core-impl) (and thus
Packit Service dff8e4
   [`libnm`](../libnm) and NetworkManager core.
Packit Service dff8e4
 - that can also be statically linked into other users of [`libnm`](../libnm).
Packit Service dff8e4
Packit Service dff8e4
Basically, it is a static library with utility functions that extends
Packit Service dff8e4
[`libnm-core-impl`](../libnm-core-impl) (the part that is public API of libnm),
Packit Service dff8e4
but it is also used by [`libnm-core-impl`](../libnm-core-impl) itself.
Packit Service dff8e4
Packit Service dff8e4
That means:
Packit Service dff8e4
Packit Service dff8e4
  - you can use it everywhere where you either statically link
Packit Service dff8e4
    with [`libnm-core-impl`](../libnm-core-impl), or dynamically link with
Packit Service dff8e4
    [`libnm`](../../libnm).
Packit Service dff8e4
  - you can even use it inside of [`libnm-core-impl`](../libnm-core-impl) itself.
Packit Service dff8e4
    This is the difference between `libnm-core-aux-intern` and
Packit Service dff8e4
    [`libnm-core-aux-extern`](..libnm-core-aux-extern).
Packit Service dff8e4
Packit Service dff8e4
Note that `libnm-core-aux-intern` only uses public API of `libnm`.
Packit Service dff8e4
Packit Service dff8e4
This directory should not be added to the include search path. Instead,
Packit Service dff8e4
users should fully qualify the include like `#include "libnm-core-aux-intern/nm-auth-subject.h"`.