All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: "brian m. carlson" <sandals@crustytoothpaste.net>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>
Subject: Re: [PATCH v2] Documentation: avoid dangling modifier for imap-send
Date: Mon, 4 Aug 2014 19:51:08 -0700	[thread overview]
Message-ID: <20140805025108.GW12427@google.com> (raw)
In-Reply-To: <20140805024535.GV12427@google.com>

Jonathan Nieder wrote:

> Should the neighboring instances of '[Rr]equired to use imap-send
> be changed to plain "Required", too?  (I suspect yes.)

Here's what that would look like.

-- >8 --
From: brian m. carlson <sandals@crustytoothpaste.net>
Subject: imap-send doc: omit confusing "to use imap-send" modifier

It wouldn't make sense for these configuration variables to be
required for Git in general to function.  'Required' in this context
means required for git imap-send to work.

Noticed while trying to figure out what the sentence describing
imap.tunnel meant.

[jn: expanded to also simplify explanation of imap.folder and
 imap.host in the same way]

Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
 Documentation/git-imap-send.txt | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt
index 875d283..d3b465d 100644
--- a/Documentation/git-imap-send.txt
+++ b/Documentation/git-imap-send.txt
@@ -38,17 +38,17 @@ Variables
 imap.folder::
 	The folder to drop the mails into, which is typically the Drafts
 	folder. For example: "INBOX.Drafts", "INBOX/Drafts" or
-	"[Gmail]/Drafts". Required to use imap-send.
+	"[Gmail]/Drafts". Required.
 
 imap.tunnel::
 	Command used to setup a tunnel to the IMAP server through which
 	commands will be piped instead of using a direct network connection
-	to the server. Required when imap.host is not set to use imap-send.
+	to the server. Required when imap.host is not set.
 
 imap.host::
 	A URL identifying the server. Use a `imap://` prefix for non-secure
 	connections and a `imaps://` prefix for secure connections.
-	Ignored when imap.tunnel is set, but required to use imap-send
+	Ignored when imap.tunnel is set, but required.
 	otherwise.
 
 imap.user::
-- 

  reply	other threads:[~2014-08-05  2:51 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-08-02 23:57 [PATCH] Documentation: avoid dangling modifier for imap-send brian m. carlson
2014-08-03  0:14 ` [PATCH v2] " brian m. carlson
2014-08-04 18:29   ` Junio C Hamano
2014-08-05  0:54     ` brian m. carlson
2014-08-05  1:13     ` brian m. carlson
2014-08-05  2:45       ` Jonathan Nieder
2014-08-05  2:51         ` Jonathan Nieder [this message]
2014-08-05  2:52           ` brian m. carlson
2014-08-05  2:57             ` Jonathan Nieder
2014-08-05  2:56           ` [PATCH v3] imap-send doc: omit confusing "to use imap-send" modifier brian m. carlson
2014-08-05 20:48             ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20140805025108.GW12427@google.com \
    --to=jrnieder@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=sandals@crustytoothpaste.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.