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

Message ID b8813979-7b21-fd88-b5a5-220ea4f282af@gmail.com
State New
Headers show
Series [PATCHv2] doc: Create documentation for pacman-db-upgrade and testpkg | expand

Commit Message

Ben Westover Aug. 3, 2022, 5 p.m. UTC
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@gmail.com>
---
 doc/meson.build                  |  2 ++
 doc/pacman-db-upgrade.8.asciidoc | 36 ++++++++++++++++++++++++++++++++
 doc/testpkg.8.asciidoc           | 20 ++++++++++++++++++
 3 files changed, 58 insertions(+)
 create mode 100644 doc/pacman-db-upgrade.8.asciidoc
 create mode 100644 doc/testpkg.8.asciidoc

Comments

Ben Westover Aug. 3, 2022, 5:06 p.m. UTC | #1
There are two "binaries" that are currently missing documentation,
pacman-db-upgrade and testpkg. This patch adds that documentation.

The documentation for pacman also contains a typo, which this patch fixes.

Signed-off-by: Ben Westover <kwestover.kw@gmail.com>
---
 doc/meson.build                  |  2 ++
 doc/pacman-db-upgrade.8.asciidoc | 36 ++++++++++++++++++++++++++++++++
 doc/pacman.8.asciidoc            |  2 +-
 doc/testpkg.8.asciidoc           | 20 ++++++++++++++++++
 4 files changed, 59 insertions(+), 1 deletion(-)
 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..fc9509c7
--- /dev/null
+++ b/doc/pacman-db-upgrade.8.asciidoc
@@ -0,0 +1,36 @@
+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.
+
+Options
+-------
+*-h, \--help*::
+Show the built-in help message and exit.
+*-V, \--version*::
+Show version information and exit.
+*-d, \--dbpath* <path>::
+Set an alternate database location.
+*-r, \--root* <path>::
+Set an alternate installation root.
+*\--config* <path>::
+Set an alternate configuration file.
+*\--nocolor*::
+Remove color from output.
+
+See Also
+--------
+linkman:pacman[8]
+
+include::footer.asciidoc[]
diff --git a/doc/pacman.8.asciidoc b/doc/pacman.8.asciidoc
index 2040f98d..7149b2f9 100644
--- a/doc/pacman.8.asciidoc
+++ b/doc/pacman.8.asciidoc
@@ -212,7 +212,7 @@ Transaction Options (apply to '-S', '-R' and '-U')
 
 *\--assume-installed* <package=version>::
 	Add a virtual package "package" with version "version" to the transaction
-	to satisfy dependencies. This allows to disable specific dependency checks
+	to satisfy dependencies. This allows disabling specific dependency checks
 	without affecting all dependency checks. To disable all dependency
 	checking, see the '\--nodeps' option.
 
diff --git a/doc/testpkg.8.asciidoc b/doc/testpkg.8.asciidoc
new file mode 100644
index 00000000..cec94839
--- /dev/null
+++ b/doc/testpkg.8.asciidoc
@@ -0,0 +1,20 @@
+testpkg(8)
+==========
+
+Name
+----
+testpkg - test a pacman package for validity
+
+Synopsis
+--------
+'testpkg' <package file>
+
+Description
+-----------
+'testpkg' is a script used to make sure that a pacman package is valid.
+
+See Also
+--------
+linkman:pacman[8]
+
+include::footer.asciidoc[]

Patch

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..34077093
--- /dev/null
+++ b/doc/pacman-db-upgrade.8.asciidoc
@@ -0,0 +1,36 @@ 
+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.
+
+Options
+--------------
+*-h, \--help*::
+Show the built-in help message and exit.
+*-V, \--version*::
+Show version information and exit.
+*-d, \--dbpath* <path>::
+Set an alternate database location.
+*-r, \--root* <path>::
+Set an alternate installation root.
+*\--config* <path>::
+Set an alternate configuration file.
+*\--nocolor*::
+Remove color from output.
+
+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..cec94839
--- /dev/null
+++ b/doc/testpkg.8.asciidoc
@@ -0,0 +1,20 @@ 
+testpkg(8)
+==========
+
+Name
+----
+testpkg - test a pacman package for validity
+
+Synopsis
+--------
+'testpkg' <package file>
+
+Description
+-----------
+'testpkg' is a script used to make sure that a pacman package is valid.
+
+See Also
+--------
+linkman:pacman[8]
+
+include::footer.asciidoc[]