From patchwork Sun Sep 9 19:02:43 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Jelle van der Waa X-Patchwork-Id: 768 Return-Path: Delivered-To: patchwork@archlinux.org Received: from apollo.archlinux.org (localhost [127.0.0.1]) by apollo.archlinux.org (Postfix) with ESMTP id 97BC16CBB1C3 for ; Sun, 9 Sep 2018 19:03:04 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.1 (2015-04-28) on apollo X-Spam-Level: X-Spam-Status: No, score=-2.2 required=5.0 tests=DKIM_SIGNED=0.1, MAILING_LIST_MULTI=-1,RCVD_IN_DNSWL_MED=-2.3,T_DKIM_INVALID=1 autolearn=ham autolearn_force=no version=3.4.1 X-Spam-BL-Results: [127.0.9.2] [127.0.0.11] Received: from orion.archlinux.org (orion.archlinux.org [88.198.91.70]) by apollo.archlinux.org (Postfix) with ESMTPS for ; Sun, 9 Sep 2018 19:03:04 +0000 (UTC) Received: from orion.archlinux.org (localhost [127.0.0.1]) by orion.archlinux.org (Postfix) with ESMTP id 13A8BD413863F; Sun, 9 Sep 2018 19:03:01 +0000 (UTC) Received: from luna.archlinux.org (luna.archlinux.org [IPv6:2a01:4f8:160:3033::2]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by orion.archlinux.org (Postfix) with ESMTPS; Sun, 9 Sep 2018 19:03:01 +0000 (UTC) Received: from luna.archlinux.org (luna.archlinux.org [127.0.0.1]) by luna.archlinux.org (Postfix) with ESMTP id 272F62CD39; Sun, 9 Sep 2018 19:02:59 +0000 (UTC) Authentication-Results: luna.archlinux.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=vdwaa-nl.20150623.gappssmtp.com header.i=@vdwaa-nl.20150623.gappssmtp.com header.b=v6jjX3Fh Received: from luna.archlinux.org (luna.archlinux.org [127.0.0.1]) by luna.archlinux.org (Postfix) with ESMTP id 9B93C2CD2B for ; Sun, 9 Sep 2018 19:02:54 +0000 (UTC) Received: from orion.archlinux.org (orion.archlinux.org [88.198.91.70]) by luna.archlinux.org (Postfix) with ESMTPS for ; Sun, 9 Sep 2018 19:02:54 +0000 (UTC) Received: from orion.archlinux.org (localhost [127.0.0.1]) by orion.archlinux.org (Postfix) with ESMTP id DA0D1D4138614 for ; Sun, 9 Sep 2018 19:02:52 +0000 (UTC) Received: from mail-ed1-x533.google.com (mail-ed1-x533.google.com [IPv6:2a00:1450:4864:20::533]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by orion.archlinux.org (Postfix) with ESMTPS for ; Sun, 9 Sep 2018 19:02:52 +0000 (UTC) Received: by mail-ed1-x533.google.com with SMTP id h4-v6so14913665edi.6 for ; Sun, 09 Sep 2018 12:02:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=vdwaa-nl.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=02UNQXVCjQOa/D9MFR/GMCYM760rmw/KmCDAJ0xJc0s=; b=v6jjX3Fh+OQtGoRXgRk2ClGFXO4AsjhFduO1+7ixP3jrTMUvkKERce0IcGjjDquEB+ 1lmuwAHFMcUBsKotBXtkGLzvwaSFEolGs3fp20GUkBgTYTrxwnFBMtsLdjWoVgGClRWg PcA5Shg0zIgIbyRFLVA9wXp+D06+yDk9kvLZGl9nHAmjkeNpdoiesjp0MMncrDDQmxAI yad0mEHbf3V9EXuQbJ0pGFe1xe0RwFqfj7UIwhSWESsMMeW2J8BTQrOQqEr4+TqfMfg3 3j2SnmWso4hT66HCmAnIAvtrVyZaYB3myCfOtoDK1E2eDGUyWNrOieAWYPA7uS3Xt9WF it0A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=02UNQXVCjQOa/D9MFR/GMCYM760rmw/KmCDAJ0xJc0s=; b=WCnSDWHqs7HP+7yhiP57w8R42sq/jMJD7KUt+8iRpS/RxC+Vpin2FjKmftRhdvQnGW 6r7sdUaecke2wlfJua13U2uLtqTb1/Nl3FNKxTKQ8D8DQhgXyAySI3lrV0rJFy7eGXtc aD1looxbB2mSnniWy9QuoT3YG+u7BxCyxDHuWe/CJ9UW1PR72sYzaeG2oVKdovNWzb6O m2dWI3zWjf0oF+N9VI8O21sSkXhUWZ410TPOu1YbZck9FlgaEwzaf66A8KpivyoUCEpc RXPXN+fvqssf0JDmNdqprbjgkBNTSFFsvyEcEQvXios8geADPlYMW6kcX/aIfVuvqPvR +zyg== X-Gm-Message-State: APzg51DB9GLzMv+Niz+/bytZT+yxmrLs5miDqMH4IbY38nIVy/Y7/634 bi3UIAReCIHOf8lSRffmmMreWb35hXU= X-Google-Smtp-Source: ANB0VdYnTAYitZCn0BoT2nE09gcjRAGTkwhWcCpCV3F0kazapyM1sXKuUn6zK+BjDawwR3AnjxtT2Q== X-Received: by 2002:a50:a762:: with SMTP id h89-v6mr19318684edc.261.1536519772274; Sun, 09 Sep 2018 12:02:52 -0700 (PDT) Received: from localhost (53541122.cm-6-5a.dynamic.ziggo.nl. [83.84.17.34]) by smtp.gmail.com with ESMTPSA id x22-v6sm7448643edb.8.2018.09.09.12.02.51 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Sun, 09 Sep 2018 12:02:51 -0700 (PDT) From: Jelle van der Waa To: arch-projects@archlinux.org Date: Sun, 9 Sep 2018 21:02:43 +0200 Message-Id: <20180909190245.25211-2-jelle@vdwaa.nl> X-Mailer: git-send-email 2.18.0 In-Reply-To: <20180909190245.25211-1-jelle@vdwaa.nl> References: <20180909190245.25211-1-jelle@vdwaa.nl> MIME-Version: 1.0 Subject: [arch-projects] [devtools] [PATCH v2 1/3] doc: Add lddd man page X-BeenThere: arch-projects@archlinux.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Arch Linux projects development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Arch Linux projects development discussion Errors-To: arch-projects-bounces@archlinux.org Sender: "arch-projects" --- .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: (
); if section is defined, else just show +# the command. + +[macros] +(?su)[\\]?(?Plinkman):(?P\S*?)\[(?P.*?)\]= + +[attributes] +asterisk=* +plus=+ +caret=^ +startsb=[ +endsb=] +backslash=\ +tilde=~ +apostrophe=' +backtick=` +litdd=-- + +ifdef::backend-docbook[] +[linkman-inlinemacro] +{0%{target}} +{0#} +{0#{target}{0}} +{0#} +endif::backend-docbook[] + +ifdef::backend-xhtml11[] +[linkman-inlinemacro] +{target}{0?({0})} +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 +* Allan McRae +* Bartłomiej Piotrowski +* Dan McGee +* Dave Reisner +* Evangelos Foutras +* Jan Alexander Steffens (heftig) +* Levente Polyak +* Pierre Schmitz +* Sébastien Luttringer +* Sven-Hendrik Haase +* Thomas Bächler + +For additional contributors, use `git shortlog -s` on the devtools.git +repository. diff --git a/doc/lddd.1.asciidoc b/doc/lddd.1.asciidoc new file mode 100644 index 0000000..3a015d2 --- /dev/null +++ b/doc/lddd.1.asciidoc @@ -0,0 +1,25 @@ +lddd(1) +======= + +Name +---- +lddd - Find broken library links on your system + +Synopsis +-------- +lddd + +Description +----------- + +Scans '$PATH', '/lib', '/usr/lib', '/usr/local/lib' and +'/etc/ld.so.conf.d/*.conf' directories for ELF files with references to missing +shared libraries, and suggests which packages might need to be rebuilt. The +collected data is written to a temporary directory created by mktemp. + +See Also +-------- + +linkman:ldd[1] + +include::footer.asciidoc[]