Re: [PATCH] manpages: consistent "format" for NAME section

Subject: Re: [PATCH] manpages: consistent "format" for NAME section

Date: Sun, 08 Jul 2012 06:31:58 +0100

To: Tomi Ollila, notmuch@notmuchmail.org

Cc: Tomi Ollila

From: Mark Walters


On Sun, 24 Jun 2012, Tomi Ollila <tomi.ollila@iki.fi> 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

Thread: