Re: [PATCH 2/2] man: document notmuch compact --quiet and --backup=DIRECTORY options

diff --git a/ef/cd0cd4c563e71f9d17fe4a02a0036776899d91 b/ef/cd0cd4c563e71f9d17fe4a02a0036776899d91
new file mode 100644 (file)
index 0000000..dd3cf27
--- /dev/null
+++ b/ef/cd0cd4c563e71f9d17fe4a02a0036776899d91
@@ -0,0 +1,134 @@
+Return-Path: <tomi.ollila@iki.fi>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 191DA431FBD\r
+       for <notmuch@notmuchmail.org>; Thu,  7 Nov 2013 05:25:50 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id HrMuIDMGsQDQ for <notmuch@notmuchmail.org>;\r
+       Thu,  7 Nov 2013 05:25:42 -0800 (PST)\r
+Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
+       by olra.theworths.org (Postfix) with ESMTP id CA0CB431FAE\r
+       for <notmuch@notmuchmail.org>; Thu,  7 Nov 2013 05:25:41 -0800 (PST)\r
+Received: from guru.guru-group.fi (localhost [IPv6:::1])\r
+       by guru.guru-group.fi (Postfix) with ESMTP id 2964B100051;\r
+       Thu,  7 Nov 2013 15:25:37 +0200 (EET)\r
+From: Tomi Ollila <tomi.ollila@iki.fi>\r
+To: Jani Nikula <jani@nikula.org>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH 2/2] man: document notmuch compact --quiet and\r
+       --backup=DIRECTORY options\r
+In-Reply-To: <1383755936-11862-2-git-send-email-jani@nikula.org>\r
+References:\r
+ <3d33996df44b338847dac930b6cd294c57b6e54b.1383481295.git.jani@nikula.org>\r
+       <1383755936-11862-1-git-send-email-jani@nikula.org>\r
+       <1383755936-11862-2-git-send-email-jani@nikula.org>\r
+User-Agent: Notmuch/0.16+119~g219c55f (http://notmuchmail.org) Emacs/24.3.1\r
+       (x86_64-unknown-linux-gnu)\r
+X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL\r
+       $[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F\r
+       !)g;OY^,BjTbr)Np:%c_o'jj,Z\r
+Date: Thu, 07 Nov 2013 15:25:37 +0200\r
+Message-ID: <m27gck9wdq.fsf@guru.guru-group.fi>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Thu, 07 Nov 2013 13:25:50 -0000\r
+\r
+On Wed, Nov 06 2013, Jani Nikula <jani@nikula.org> wrote:\r
+\r
+> ---\r
+>\r
+> v2: --verbose -> --quiet\r
+\r
+Patches\r
+\r
+id:1383755936-11862-1-git-send-email-jani@nikula.org &\r
+id:1383755936-11862-2-git-send-email-jani@nikula.org\r
+\r
+(notmuch compact --quiet and --backup=DIRECTORY options with docs)\r
+\r
+LGTM\r
+\r
+Tomi\r
+\r
+\r
+\r
+> ---\r
+>  man/man1/notmuch-compact.1 | 28 +++++++++++++++++++++++++++-\r
+>  1 file changed, 27 insertions(+), 1 deletion(-)\r
+>\r
+> diff --git a/man/man1/notmuch-compact.1 b/man/man1/notmuch-compact.1\r
+> index 1aeed22..0c95873 100644\r
+> --- a/man/man1/notmuch-compact.1\r
+> +++ b/man/man1/notmuch-compact.1\r
+> @@ -4,6 +4,8 @@ notmuch-compact \- compact the notmuch database\r
+>  .SH SYNOPSIS\r
+>  \r
+>  .B notmuch compact\r
+> +.RI "[ --quiet ]"\r
+> +.RI "[ --backup=<" directory "> ]"\r
+>  \r
+>  .SH DESCRIPTION\r
+>  \r
+> @@ -14,11 +16,35 @@ the space required by the database and improve lookup performance.\r
+>  \r
+>  The compacted database is built in a temporary directory and is later\r
+>  moved into the place of the origin database. The original uncompacted\r
+> -database is preserved to be deleted by the user as desired.\r
+> +database is discarded, unless the\r
+> +.BR "\-\-backup=" <directory>\r
+> +option is used.\r
+>  \r
+>  Note that the database write lock will be held during the compaction\r
+>  process (which may be quite long) to protect data integrity.\r
+>  \r
+> +Supported options for\r
+> +.B compact\r
+> +include\r
+> +\r
+> +.RS 4\r
+> +.TP 4\r
+> +.BR "\-\-backup=" <directory>\r
+> +\r
+> +Save the current database to the given directory before replacing it\r
+> +with the compacted database. The backup directory must not exist and\r
+> +it must reside on the same mounted filesystem as the current database.\r
+> +\r
+> +.RE\r
+> +\r
+> +.RS 4\r
+> +.TP 4\r
+> +.BR \-\-quiet\r
+> +\r
+> +Do not report database compaction progress to stdout.\r
+> +\r
+> +.RE\r
+> +\r
+>  .RE\r
+>  .SH ENVIRONMENT\r
+>  The following environment variables can be used to control the\r
+> -- \r
+> 1.8.4.rc3\r
+>\r
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r