From: Tomi Ollila <tomi.ollila@iki.fi>
Date: Thu, 7 Nov 2013 13:25:37 +0000 (+0200)
Subject: Re: [PATCH 2/2] man: document notmuch compact --quiet and --backup=DIRECTORY options
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=4be96eef5578c1c7d8a0f1b0671cf651b5215884;p=notmuch-archives.git

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