From: Mark Walters Date: Sun, 8 Jul 2012 05:31:58 +0000 (+0100) Subject: Re: [PATCH] manpages: consistent "format" for NAME section X-Git-Url: http://git.tremily.us/gitweb.cgi?a=commitdiff_plain;h=78882ea6accd28b5c8925d3f77b8e45658891d98;p=notmuch-archives.git Re: [PATCH] manpages: consistent "format" for NAME section --- diff --git a/9d/59bc6d4eb5f0c4addc40281e0174e0c227a861 b/9d/59bc6d4eb5f0c4addc40281e0174e0c227a861 new file mode 100644 index 000000000..98448775a --- /dev/null +++ b/9d/59bc6d4eb5f0c4addc40281e0174e0c227a861 @@ -0,0 +1,232 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 927DB431FBC + for ; Sat, 7 Jul 2012 22:32:07 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -1.098 +X-Spam-Level: +X-Spam-Status: No, score=-1.098 tagged_above=-999 required=5 + tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001, + NML_ADSP_CUSTOM_MED=1.2, RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id s8jdZ6DyEdZO for ; + Sat, 7 Jul 2012 22:32:06 -0700 (PDT) +Received: from mail2.qmul.ac.uk (mail2.qmul.ac.uk [138.37.6.6]) + (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id F40C3431FAE + for ; Sat, 7 Jul 2012 22:32:05 -0700 (PDT) +Received: from smtp.qmul.ac.uk ([138.37.6.40]) + by mail2.qmul.ac.uk with esmtp (Exim 4.71) + (envelope-from ) + id 1Snk6E-0004id-7D; Sun, 08 Jul 2012 06:32:04 +0100 +Received: from 94-192-233-223.zone6.bethere.co.uk ([94.192.233.223] + helo=localhost) + by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.69) + (envelope-from ) + id 1Snk6D-0002lN-Ij; Sun, 08 Jul 2012 06:32:01 +0100 +From: Mark Walters +To: Tomi Ollila , notmuch@notmuchmail.org +Subject: Re: [PATCH] manpages: consistent "format" for NAME section +In-Reply-To: <1340574807-3880-1-git-send-email-tomi.ollila@iki.fi> +References: <1340574807-3880-1-git-send-email-tomi.ollila@iki.fi> +User-Agent: Notmuch/0.13.2+61~gf708609 (http://notmuchmail.org) Emacs/23.4.1 + (x86_64-pc-linux-gnu) +Date: Sun, 08 Jul 2012 06:31:58 +0100 +Message-ID: <87d346u8c1.fsf@qmul.ac.uk> +MIME-Version: 1.0 +Content-Type: text/plain; charset=us-ascii +X-Sender-Host-Address: 94.192.233.223 +X-QM-SPAM-Info: Sender has good ham record. :) +X-QM-Body-MD5: 72a6d91cd2459b5d36d9ad6ffef6fa62 (of first 20000 bytes) +X-SpamAssassin-Score: -1.8 +X-SpamAssassin-SpamBar: - +X-SpamAssassin-Report: The QM spam filters have analysed this message to + determine if it is + spam. We require at least 5.0 points to mark a message as spam. + This message scored -1.8 points. + Summary of the scoring: + * -2.3 RCVD_IN_DNSWL_MED RBL: Sender listed at http://www.dnswl.org/, + * medium trust + * [138.37.6.40 listed in list.dnswl.org] + * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail + provider * (markwalters1009[at]gmail.com) + * -0.0 T_RP_MATCHES_RCVD Envelope sender domain matches handover relay + * domain + * 0.5 AWL AWL: From: address is in the auto white-list +X-QM-Scan-Virus: ClamAV says the message is clean +Cc: Tomi Ollila +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sun, 08 Jul 2012 05:32:07 -0000 + +On Sun, 24 Jun 2012, Tomi Ollila wrote: +> The NAME section in manpages generally doesn't start with capital +> letter (unless the word is 'proper noun') and doesn't end with +> period. Notmuch manual pages now matches that "format". + +LGTM +1 (or possibly trivial) + +Best wishes + +Mark + +> --- +> +> See http://notmuchmail.org/manpages/ for reference. +> +> +> man/man1/notmuch-config.1 | 2 +- +> man/man1/notmuch-count.1 | 2 +- +> man/man1/notmuch-dump.1 | 2 +- +> man/man1/notmuch-new.1 | 2 +- +> man/man1/notmuch-reply.1 | 2 +- +> man/man1/notmuch-restore.1 | 2 +- +> man/man1/notmuch-search.1 | 2 +- +> man/man1/notmuch-show.1 | 2 +- +> man/man1/notmuch-tag.1 | 2 +- +> man/man7/notmuch-search-terms.7 | 2 +- +> 10 files changed, 10 insertions(+), 10 deletions(-) +> +> diff --git a/man/man1/notmuch-config.1 b/man/man1/notmuch-config.1 +> index 4f7985c..2ee555d 100644 +> --- a/man/man1/notmuch-config.1 +> +++ b/man/man1/notmuch-config.1 +> @@ -1,6 +1,6 @@ +> .TH NOTMUCH-CONFIG 1 2012-06-01 "Notmuch 0.13.2" +> .SH NAME +> -notmuch-config \- Access notmuch configuration file. +> +notmuch-config \- access notmuch configuration file +> .SH SYNOPSIS +> +> .B notmuch config get +> diff --git a/man/man1/notmuch-count.1 b/man/man1/notmuch-count.1 +> index 8029174..8551ab2 100644 +> --- a/man/man1/notmuch-count.1 +> +++ b/man/man1/notmuch-count.1 +> @@ -1,6 +1,6 @@ +> .TH NOTMUCH-COUNT 1 2012-06-01 "Notmuch 0.13.2" +> .SH NAME +> -notmuch-count \- Count messages matching the given search terms. +> +notmuch-count \- count messages matching the given search terms +> .SH SYNOPSIS +> +> .B notmuch count +> diff --git a/man/man1/notmuch-dump.1 b/man/man1/notmuch-dump.1 +> index 9c7dd84..64abf01 100644 +> --- a/man/man1/notmuch-dump.1 +> +++ b/man/man1/notmuch-dump.1 +> @@ -1,6 +1,6 @@ +> .TH NOTMUCH-DUMP 1 2012-06-01 "Notmuch 0.13.2" +> .SH NAME +> -notmuch-dump \- Creates a plain-text dump of the tags of each message. +> +notmuch-dump \- creates a plain-text dump of the tags of each message +> +> .SH SYNOPSIS +> +> diff --git a/man/man1/notmuch-new.1 b/man/man1/notmuch-new.1 +> index cd83a88..e01f2eb 100644 +> --- a/man/man1/notmuch-new.1 +> +++ b/man/man1/notmuch-new.1 +> @@ -1,6 +1,6 @@ +> .TH NOTMUCH-NEW 1 2012-06-01 "Notmuch 0.13.2" +> .SH NAME +> -notmuch-new \- Incorporate new mail into the notmuch database. +> +notmuch-new \- incorporate new mail into the notmuch database +> .SH SYNOPSIS +> +> .B notmuch new +> diff --git a/man/man1/notmuch-reply.1 b/man/man1/notmuch-reply.1 +> index fb5114c..5aa86c0 100644 +> --- a/man/man1/notmuch-reply.1 +> +++ b/man/man1/notmuch-reply.1 +> @@ -1,6 +1,6 @@ +> .TH NOTMUCH-REPLY 1 2012-06-01 "Notmuch 0.13.2" +> .SH NAME +> -notmuch-reply \- Constructs a reply template for a set of messages. +> +notmuch-reply \- constructs a reply template for a set of messages +> +> .SH SYNOPSIS +> +> diff --git a/man/man1/notmuch-restore.1 b/man/man1/notmuch-restore.1 +> index 3156af7..18281c7 100644 +> --- a/man/man1/notmuch-restore.1 +> +++ b/man/man1/notmuch-restore.1 +> @@ -1,6 +1,6 @@ +> .TH NOTMUCH-RESTORE 1 2012-06-01 "Notmuch 0.13.2" +> .SH NAME +> -notmuch-restore \- Restores the tags from the given file (see notmuch dump). +> +notmuch-restore \- restores the tags from the given file (see notmuch dump) +> +> .SH SYNOPSIS +> +> diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1 +> index 5c72c4b..b42eb2c 100644 +> --- a/man/man1/notmuch-search.1 +> +++ b/man/man1/notmuch-search.1 +> @@ -1,6 +1,6 @@ +> .TH NOTMUCH-SEARCH 1 2012-06-01 "Notmuch 0.13.2" +> .SH NAME +> -notmuch-search \- Search for messages matching the given search terms. +> +notmuch-search \- search for messages matching the given search terms +> .SH SYNOPSIS +> +> .B notmuch search +> diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1 +> index 4aab17c..b51a54c 100644 +> --- a/man/man1/notmuch-show.1 +> +++ b/man/man1/notmuch-show.1 +> @@ -1,6 +1,6 @@ +> .TH NOTMUCH-SHOW 1 2012-06-01 "Notmuch 0.13.2" +> .SH NAME +> -notmuch-show \- Show messages matching the given search terms. +> +notmuch-show \- show messages matching the given search terms +> .SH SYNOPSIS +> +> .B notmuch show +> diff --git a/man/man1/notmuch-tag.1 b/man/man1/notmuch-tag.1 +> index 27e682e..d810e1b 100644 +> --- a/man/man1/notmuch-tag.1 +> +++ b/man/man1/notmuch-tag.1 +> @@ -1,6 +1,6 @@ +> .TH NOTMUCH-TAG 1 2012-06-01 "Notmuch 0.13.2" +> .SH NAME +> -notmuch-tag \- Add/remove tags for all messages matching the search terms. +> +notmuch-tag \- add/remove tags for all messages matching the search terms +> +> .SH SYNOPSIS +> .B notmuch tag +> diff --git a/man/man7/notmuch-search-terms.7 b/man/man7/notmuch-search-terms.7 +> index c559ed6..b8ab52d 100644 +> --- a/man/man7/notmuch-search-terms.7 +> +++ b/man/man7/notmuch-search-terms.7 +> @@ -1,7 +1,7 @@ +> .TH NOTMUCH-SEARCH-TERMS 7 2012-06-01 "Notmuch 0.13.2" +> +> .SH NAME +> -notmuch-search-terms \- Syntax for notmuch queries +> +notmuch-search-terms \- syntax for notmuch queries +> +> .SH SYNOPSIS +> +> -- +> 1.7.1 +> +> _______________________________________________ +> notmuch mailing list +> notmuch@notmuchmail.org +> http://notmuchmail.org/mailman/listinfo/notmuch