[devtools,v2,2/3] doc: Add checkpkg man page

Message ID 20180909190245.25211-3-jelle@vdwaa.nl
State New
Headers show
Series
  • Add man pages
Related show

Commit Message

Jelle van der Waa Sept. 9, 2018, 7:02 p.m. UTC
---
 Makefile                |  3 ++-
 doc/checkpkg.1.asciidoc | 27 +++++++++++++++++++++++++++
 2 files changed, 29 insertions(+), 1 deletion(-)
 create mode 100644 doc/checkpkg.1.asciidoc

Patch

diff --git a/Makefile b/Makefile
index 80fe1d7..e812936 100644
--- a/Makefile
+++ b/Makefile
@@ -63,7 +63,8 @@  BASHCOMPLETION_LINKS = \
 
 
 MANS = \
-	doc/lddd.1
+	doc/lddd.1 \
+	doc/checkpkg.1
 
 
 all: $(BINPROGS) bash_completion zsh_completion man
diff --git a/doc/checkpkg.1.asciidoc b/doc/checkpkg.1.asciidoc
new file mode 100644
index 0000000..96ec645
--- /dev/null
+++ b/doc/checkpkg.1.asciidoc
@@ -0,0 +1,27 @@ 
+checkpkg(1)
+===========
+
+Name
+----
+checkpkg - Compare the current build package with the repository version
+
+Synopsis
+--------
+checkpkg
+
+Description
+-----------
+
+Searches for a locally built package corresponding to the PKGBUILD, and
+downloads the last version of that package from the Pacman repositories. It
+then compares the list of .so files provided by each version of the package and
+outputs if there are soname differences for the new package. A directory is
+also created using mktemp with files containing a file list for both packages
+and a library list for both packages.
+
+See Also
+--------
+
+linkman:find-libprovides[1]
+
+include::footer.asciidoc[]