ef/cd0cd4c563e71f9d17fe4a02a0036776899d91

   1 Return-Path: <tomi.ollila@iki.fi>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id 191DA431FBD\r
   6         for <notmuch@notmuchmail.org>; Thu,  7 Nov 2013 05:25:50 -0800 (PST)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: 0\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
  12         autolearn=disabled\r
  13 Received: from olra.theworths.org ([127.0.0.1])\r
  14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  15         with ESMTP id HrMuIDMGsQDQ for <notmuch@notmuchmail.org>;\r
  16         Thu,  7 Nov 2013 05:25:42 -0800 (PST)\r
  17 Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
  18         by olra.theworths.org (Postfix) with ESMTP id CA0CB431FAE\r
  19         for <notmuch@notmuchmail.org>; Thu,  7 Nov 2013 05:25:41 -0800 (PST)\r
  20 Received: from guru.guru-group.fi (localhost [IPv6:::1])\r
  21         by guru.guru-group.fi (Postfix) with ESMTP id 2964B100051;\r
  22         Thu,  7 Nov 2013 15:25:37 +0200 (EET)\r
  23 From: Tomi Ollila <tomi.ollila@iki.fi>\r
  24 To: Jani Nikula <jani@nikula.org>, notmuch@notmuchmail.org\r
  25 Subject: Re: [PATCH 2/2] man: document notmuch compact --quiet and\r
  26         --backup=DIRECTORY options\r
  27 In-Reply-To: <1383755936-11862-2-git-send-email-jani@nikula.org>\r
  28 References:\r
  29  <3d33996df44b338847dac930b6cd294c57b6e54b.1383481295.git.jani@nikula.org>\r
  30         <1383755936-11862-1-git-send-email-jani@nikula.org>\r
  31         <1383755936-11862-2-git-send-email-jani@nikula.org>\r
  32 User-Agent: Notmuch/0.16+119~g219c55f (http://notmuchmail.org) Emacs/24.3.1\r
  33         (x86_64-unknown-linux-gnu)\r
  34 X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL\r
  35         $[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F\r
  36         !)g;OY^,BjTbr)Np:%c_o'jj,Z\r
  37 Date: Thu, 07 Nov 2013 15:25:37 +0200\r
  38 Message-ID: <m27gck9wdq.fsf@guru.guru-group.fi>\r
  39 MIME-Version: 1.0\r
  40 Content-Type: text/plain\r
  41 X-BeenThere: notmuch@notmuchmail.org\r
  42 X-Mailman-Version: 2.1.13\r
  43 Precedence: list\r
  44 List-Id: "Use and development of the notmuch mail system."\r
  45         <notmuch.notmuchmail.org>\r
  46 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  47         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  48 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  49 List-Post: <mailto:notmuch@notmuchmail.org>\r
  50 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  51 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  52         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  53 X-List-Received-Date: Thu, 07 Nov 2013 13:25:50 -0000\r
  54 \r
  55 On Wed, Nov 06 2013, Jani Nikula <jani@nikula.org> wrote:\r
  56 \r
  57 > ---\r
  58 >\r
  59 > v2: --verbose -> --quiet\r
  60 \r
  61 Patches\r
  62 \r
  63 id:1383755936-11862-1-git-send-email-jani@nikula.org &\r
  64 id:1383755936-11862-2-git-send-email-jani@nikula.org\r
  65 \r
  66 (notmuch compact --quiet and --backup=DIRECTORY options with docs)\r
  67 \r
  68 LGTM\r
  69 \r
  70 Tomi\r
  71 \r
  72 \r
  73 \r
  74 > ---\r
  75 >  man/man1/notmuch-compact.1 | 28 +++++++++++++++++++++++++++-\r
  76 >  1 file changed, 27 insertions(+), 1 deletion(-)\r
  77 >\r
  78 > diff --git a/man/man1/notmuch-compact.1 b/man/man1/notmuch-compact.1\r
  79 > index 1aeed22..0c95873 100644\r
  80 > --- a/man/man1/notmuch-compact.1\r
  81 > +++ b/man/man1/notmuch-compact.1\r
  82 > @@ -4,6 +4,8 @@ notmuch-compact \- compact the notmuch database\r
  83 >  .SH SYNOPSIS\r
  84 >  \r
  85 >  .B notmuch compact\r
  86 > +.RI "[ --quiet ]"\r
  87 > +.RI "[ --backup=<" directory "> ]"\r
  88 >  \r
  89 >  .SH DESCRIPTION\r
  90 >  \r
  91 > @@ -14,11 +16,35 @@ the space required by the database and improve lookup performance.\r
  92 >  \r
  93 >  The compacted database is built in a temporary directory and is later\r
  94 >  moved into the place of the origin database. The original uncompacted\r
  95 > -database is preserved to be deleted by the user as desired.\r
  96 > +database is discarded, unless the\r
  97 > +.BR "\-\-backup=" <directory>\r
  98 > +option is used.\r
  99 >  \r
 100 >  Note that the database write lock will be held during the compaction\r
 101 >  process (which may be quite long) to protect data integrity.\r
 102 >  \r
 103 > +Supported options for\r
 104 > +.B compact\r
 105 > +include\r
 106 > +\r
 107 > +.RS 4\r
 108 > +.TP 4\r
 109 > +.BR "\-\-backup=" <directory>\r
 110 > +\r
 111 > +Save the current database to the given directory before replacing it\r
 112 > +with the compacted database. The backup directory must not exist and\r
 113 > +it must reside on the same mounted filesystem as the current database.\r
 114 > +\r
 115 > +.RE\r
 116 > +\r
 117 > +.RS 4\r
 118 > +.TP 4\r
 119 > +.BR \-\-quiet\r
 120 > +\r
 121 > +Do not report database compaction progress to stdout.\r
 122 > +\r
 123 > +.RE\r
 124 > +\r
 125 >  .RE\r
 126 >  .SH ENVIRONMENT\r
 127 >  The following environment variables can be used to control the\r
 128 > -- \r
 129 > 1.8.4.rc3\r
 130 >\r
 131 > _______________________________________________\r
 132 > notmuch mailing list\r
 133 > notmuch@notmuchmail.org\r
 134 > http://notmuchmail.org/mailman/listinfo/notmuch\r