This is an automated email from the git hooks/post-receive script. guillem pushed a commit to branch main in repository dpkg.
View the commit online: https://git.dpkg.org/cgit/dpkg/dpkg.git/commit/?id=e309f8639d2beb84c1f74b9bd0e9933f7fc7f58b commit e309f8639d2beb84c1f74b9bd0e9933f7fc7f58b Author: Guillem Jover <[email protected]> AuthorDate: Thu Apr 11 00:52:34 2024 +0200 man: Add new libdpkg(7) manual page This is intended to document the library as a whole, give some overview of its usage, API stability and deprecations. The API documentation for this library will not be translated, so it seems a bit pointless to translate this manual page. It is thus not marked for translation. --- Makefile.am | 1 + debian/libdpkg-dev.manpages | 1 + man/Makefile.am | 2 ++ man/libdpkg.pod | 44 ++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 48 insertions(+) diff --git a/Makefile.am b/Makefile.am index 8fed921ab..ebe721324 100644 --- a/Makefile.am +++ b/Makefile.am @@ -96,6 +96,7 @@ EXTRA_DIST = \ debian/dselect.manpages \ debian/dselect.postrm \ debian/libdpkg-dev.install \ + debian/libdpkg-dev.manpages \ debian/libdpkg-perl.install \ debian/source/format \ debian/source/lintian-overrides \ diff --git a/debian/libdpkg-dev.manpages b/debian/libdpkg-dev.manpages new file mode 100644 index 000000000..e877e2953 --- /dev/null +++ b/debian/libdpkg-dev.manpages @@ -0,0 +1 @@ +usr/share/man/*/libdpkg.7 diff --git a/man/Makefile.am b/man/Makefile.am index 4f4e462d7..68f4c37e6 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -62,6 +62,7 @@ man_MANS = \ dpkg.1 \ dpkg.cfg.5 \ dsc.5 \ + libdpkg.7 \ # EOL if BUILD_DSELECT @@ -152,6 +153,7 @@ EXTRA_DIST += \ dsc.pod \ dselect.cfg.pod \ dselect.pod \ + libdpkg.pod \ start-stop-daemon.pod \ update-alternatives.pod \ # EOL diff --git a/man/libdpkg.pod b/man/libdpkg.pod new file mode 100644 index 000000000..e41182607 --- /dev/null +++ b/man/libdpkg.pod @@ -0,0 +1,44 @@ +# dpkg manual page - libdpkg(7) +# +# Copyright © 2024 Guillem Jover <[email protected]> +# +# This is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <https://www.gnu.org/licenses/>. + +=encoding utf8 + +=head1 NAME + +libdpkg - Debian package manager C library + +=head1 DESCRIPTION + +The B<libdpkg> C library provides functions and infrastructure for the dpkg +tool set, and external projects that need to integrate tightly with it. + +The library provides a L<pkgconf(1)> entry named I<libdpkg>. + +B<Warning>: The API provided by this library is highly volatile, still in +the process of being cleaned up. It is only supposed to be used internally +by dpkg for now. Header files, functions, variables and types might get +renamed, removed or change semantics. If you still have a need to use it, +which you would be doing anyway, say by locally building dpkg to get the +library, then define the C preprocessor macro LIBDPKG_VOLATILE_API in your +build to acknowledge that fact. + +Due to the currently API volatility, only a static library is provided. + +=head1 SEE ALSO + +F<%PKGDOCDIR%/README.api>, +L<https://www.dpkg.org/doc/libdpkg/>. -- Dpkg.Org's dpkg
