[arch-projects] [devtools] [PATCH v2 0/3] Add man pages
This is v2 of my man page addition effort, I've switched from mandoc to the much easier asciidoc. Another reason to use asciidoc is that pacman/pacman-contrib also use it. So possible contributors might be more familiar with it. Thanks to Luke Shumaker for some more inspiration for the content! Jelle van der Waa (3): doc: Add lddd man page doc: Add checkpkg man page doc: add find-libprovides man page .gitignore | 1 + Makefile | 23 ++++++++++++++++++-- doc/asciidoc.conf | 37 +++++++++++++++++++++++++++++++++ doc/checkpkg.1.asciidoc | 27 ++++++++++++++++++++++++ doc/find-libprovides.1.asciidoc | 24 +++++++++++++++++++++ doc/footer.asciidoc | 28 +++++++++++++++++++++++++ doc/lddd.1.asciidoc | 25 ++++++++++++++++++++++ 7 files changed, 163 insertions(+), 2 deletions(-) create mode 100644 doc/asciidoc.conf create mode 100644 doc/checkpkg.1.asciidoc create mode 100644 doc/find-libprovides.1.asciidoc create mode 100644 doc/footer.asciidoc create mode 100644 doc/lddd.1.asciidoc -- 2.18.0
---
.gitignore | 1 +
Makefile | 22 ++++++++++++++++++++--
doc/asciidoc.conf | 37 +++++++++++++++++++++++++++++++++++++
doc/footer.asciidoc | 28 ++++++++++++++++++++++++++++
doc/lddd.1.asciidoc | 25 +++++++++++++++++++++++++
5 files changed, 111 insertions(+), 2 deletions(-)
create mode 100644 doc/asciidoc.conf
create mode 100644 doc/footer.asciidoc
create mode 100644 doc/lddd.1.asciidoc
diff --git a/.gitignore b/.gitignore
index 1e92b82..04eefe5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -16,3 +16,4 @@ zsh_completion
find-libdeps
crossrepomove
arch-nspawn
+doc/*.1
diff --git a/Makefile b/Makefile
index 2d29c83..80fe1d7 100644
--- a/Makefile
+++ b/Makefile
@@ -1,6 +1,7 @@
V=20180531
PREFIX = /usr/local
+MANDIR = $(PREFIX)/share/man
BINPROGS = \
checkpkg \
@@ -60,7 +61,13 @@ BASHCOMPLETION_LINKS = \
archco \
communityco
-all: $(BINPROGS) bash_completion zsh_completion
+
+MANS = \
+ doc/lddd.1
+
+
+all: $(BINPROGS) bash_completion zsh_completion man
+man: $(MANS)
edit = sed -e "s|@pkgdatadir[@]|$(DESTDIR)$(PREFIX)/share/devtools|g"
@@ -72,8 +79,13 @@ edit = sed -e "s|@pkgdatadir[@]|$(DESTDIR)$(PREFIX)/share/devtools|g"
@chmod +x "$@"
@bash -O extglob -n "$@"
+$(MANS): doc/asciidoc.conf doc/footer.asciidoc
+
+doc/%: doc/%.asciidoc
+ a2x --no-xmllint --asciidoc-opts="-f doc/asciidoc.conf" -d manpage -f manpage -D doc $<
+
clean:
- rm -f $(BINPROGS) bash_completion zsh_completion
+ rm -f $(BINPROGS) bash_completion zsh_completion $(MANS)
install:
install -dm0755 $(DESTDIR)$(PREFIX)/bin
@@ -88,6 +100,9 @@ install:
for l in ${BASHCOMPLETION_LINKS}; do ln -sf devtools $(DESTDIR)/usr/share/bash-completion/completions/$$l; done
install -Dm0644 zsh_completion $(DESTDIR)$(PREFIX)/share/zsh/site-functions/_devtools
ln -sf archco $(DESTDIR)$(PREFIX)/bin/communityco
+ for manfile in $(MANS); do \
+ install -Dm644 $$manfile -t $(DESTDIR)$(MANDIR)/man$${manfile##*.}; \
+ done;
uninstall:
for f in ${BINPROGS}; do rm -f $(DESTDIR)$(PREFIX)/bin/$$f; done
@@ -99,6 +114,9 @@ uninstall:
rm $(DESTDIR)$(PREFIX)/share/zsh/site-functions/_devtools
rm -f $(DESTDIR)$(PREFIX)/bin/communityco
rm -f $(DESTDIR)$(PREFIX)/bin/find-libprovides
+ for manfile in $(MANS); do \
+ rm -f $(DESTDIR)$(MANDIR)/man$${manfile##*.}/$${manfile#doc/}; \
+ done;
dist:
git archive --format=tar --prefix=devtools-$(V)/ $(V) | gzip -9 > devtools-$(V).tar.gz
diff --git a/doc/asciidoc.conf b/doc/asciidoc.conf
new file mode 100644
index 0000000..c675a20
--- /dev/null
+++ b/doc/asciidoc.conf
@@ -0,0 +1,37 @@
+## linkman: macro
+# Inspired by/borrowed from the GIT source tree at Documentation/asciidoc.conf
+#
+# Usage: linkman:command[manpage-section]
+#
+# Note, {0} is the manpage section, while {target} is the command.
+#
+# Show man link as: <command>(<section>); if section is defined, else just show
+# the command.
+
+[macros]
+(?su)[\\]?(?P<name>linkman):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
+
+[attributes]
+asterisk=*
+plus=+
+caret=^
+startsb=[
+endsb=]
+backslash=\
+tilde=~
+apostrophe='
+backtick=`
+litdd=--
+
+ifdef::backend-docbook[]
+[linkman-inlinemacro]
+{0%{target}}
+{0#<citerefentry>}
+{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
+{0#</citerefentry>}
+endif::backend-docbook[]
+
+ifdef::backend-xhtml11[]
+[linkman-inlinemacro]
+<a href="{target}.{0}.html">{target}{0?({0})}</a>
+endif::backend-xhtml11[]
diff --git a/doc/footer.asciidoc b/doc/footer.asciidoc
new file mode 100644
index 0000000..a092447
--- /dev/null
+++ b/doc/footer.asciidoc
@@ -0,0 +1,28 @@
+
+Bugs
+----
+Bugs can be reported on the bug tracker 'https://bugs.archlinux.org' in the Arch
+Linux category and title prefixed with [devtools] or via
+mailto:arch-projects@archlinux.org[].
+
+
+Authors
+-------
+
+Maintainers:
+
+* Aaron Griffin
--- Makefile | 3 ++- doc/checkpkg.1.asciidoc | 27 +++++++++++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 doc/checkpkg.1.asciidoc 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[] -- 2.18.0
--- doc/find-libprovides.1.asciidoc | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 doc/find-libprovides.1.asciidoc diff --git a/doc/find-libprovides.1.asciidoc b/doc/find-libprovides.1.asciidoc new file mode 100644 index 0000000..c6d527d --- /dev/null +++ b/doc/find-libprovides.1.asciidoc @@ -0,0 +1,24 @@ +find-libdeps(1) +=============== + +Name +---- +find-libdeps - Find soname dependencies for a package + +Synopsis +-------- +find-libdeps [options] [package] + +Description +----------- + +Finds soname dependencies of a package and prints out a list in the following +format '<soname>=<soversion>-<soarch>'. + +Options +------- + +*--ignore-internal*:: + Ignore internal libraries + +include::footer.asciidoc[] -- 2.18.0
participants (1)
-
Jelle van der Waa