[PATCH] doc: Create documentation for pacman-db-upgrade and testpkg

Ben Westover kwestover.kw at gmail.com
Wed Aug 3 01:58:56 UTC 2022


There are two "binaries" that are currently missing documentation,
pacman-db-upgrade and testpkg. This patch adds that documentation.

Signed-off-by: Ben Westover <kwestover.kw at gmail.com>
---
 doc/meson.build                  |  2 ++
 doc/pacman-db-upgrade.8.asciidoc | 39 ++++++++++++++++++++++++++++++++
 doc/testpkg.8.asciidoc           | 21 +++++++++++++++++
 3 files changed, 62 insertions(+)
 create mode 100644 doc/pacman-db-upgrade.8.asciidoc
 create mode 100644 doc/testpkg.8.asciidoc

diff --git a/doc/meson.build b/doc/meson.build
index 06df92c9..a18e7f3f 100644
--- a/doc/meson.build
+++ b/doc/meson.build
@@ -5,7 +5,9 @@ manpages = [
   { 'name': 'makepkg-template.1' },
   { 'name': 'repo-add.8' },
   { 'name': 'vercmp.8' },
+  { 'name': 'testpkg.8' },
   { 'name': 'pacman-key.8' },
+  { 'name': 'pacman-db-upgrade.8' },
   { 'name': 'PKGBUILD.5', 'extra_depends' : [ 'PKGBUILD-example.txt' ] },
   { 'name': 'makepkg.conf.5' },
   { 'name': 'pacman.conf.5' },
diff --git a/doc/pacman-db-upgrade.8.asciidoc b/doc/pacman-db-upgrade.8.asciidoc
new file mode 100644
index 00000000..d984179b
--- /dev/null
+++ b/doc/pacman-db-upgrade.8.asciidoc
@@ -0,0 +1,39 @@
+pacman-db-upgrade(8)
+====================
+
+Name
+----
+pacman-db-upgrade - upgrade the local pacman database to a newer format
+
+Synopsis
+--------
+'pacman-db-upgrade' [options]
+
+Description
+-----------
+'pacman-db-upgrade' is a script that upgrades the local database used
+by linkman:pacman[8] to a newer format.
+
+Common Options
+--------------
+*-h, \--help*::
+Show the built-in help message and exit.
+*-V, \--version*::
+Show version information and exit.
+*\--nocolor*::
+Remove color from output.
+
+pacman-db-upgrade Options
+-------------------------
+*-d, \--dbpath* <path>::
+Set an alternate database location.
+*\--config* <path>::
+Set an alternate configuration file.
+*-r, \--root* <path>::
+Sset an alternate installation root.
+
+See Also
+--------
+linkman:pacman[8]
+
+include::footer.asciidoc[]
diff --git a/doc/testpkg.8.asciidoc b/doc/testpkg.8.asciidoc
new file mode 100644
index 00000000..6401a9be
--- /dev/null
+++ b/doc/testpkg.8.asciidoc
@@ -0,0 +1,21 @@
+testpkg(8)
+==========
+
+Name
+----
+testpkg - test a pacman package for validity
+
+Synopsis
+--------
+'testpkg' <package file>
+
+Description
+-----------
+'testpkg' is a script used to make sure packages produced by
+linkman:makepkg[8] are valid.
+
+See Also
+--------
+linkman:makepkg[8]
+
+include::footer.asciidoc[]
-- 
2.37.1


More information about the pacman-dev mailing list