From: astian <astian@eclipso.at>
To: git@vger.kernel.org
Cc: astian <astian@eclipso.at>
Subject: [PATCH 0/4] Misc. documentation fixes
Date: Sat, 8 Jul 2017 20:34:09 +0000 [thread overview]
Message-ID: <20170708203413.16442-1-astian@eclipso.at> (raw)
Hi there,
I was looking into adding a new option to git-send-email (and I may
later send the patches implementing that) but as I looked over the code
and associated documentation I found a few places where I thought
improvement could be made. So here are some documentation fixes and
clarifications that you might find useful.
They apply cleanly on top of commit 8b2efe2a0 (Fifteenth batch for 2.14).
Note 1: even though I'm sending them as a "series", all of these are in
fact independent of each other.
Note 2: see below for a couple of patch-specific comments.
astian (4):
Doc/config.txt: explain repeated sections
Doc/config.txt: fix typos
Doc/git-send-email.txt: clarify a couple of options
Still to fix:
--smtp-encryption:
The current nomenclarure is braindamaged: what's currently
called "ssl" should be called "tls", what's currently called
"tls" should be called "starttls".
--smtp-server-option:
IMO the option is wrongly named: this option only works with a
local sendmail-like binary. When talking to that program, SMTP
is not used.
Doc/config.txt: fix documentation for smtpEncryption
I don't know what's the story behind this, but IMO having
"smtpEncryption" configurable from "sendemail.<identity>"
subsections is useful and should be preserved.
For example, one can set "ssl" (meaning TLS) as global configuration
(under "sendemail"), but set it to "none" (that is, plain text) for
a particular identity that actually connects to an i2p or onion
server, i.e. through an already encrypted transport.
Documentation/config.txt | 5 +----
Documentation/git-send-email.txt | 15 +++++++++------
2 files changed, 10 insertions(+), 10 deletions(-)
--
2.13.2
next reply other threads:[~2017-07-08 20:39 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-07-08 20:34 astian [this message]
2017-07-08 20:34 ` [PATCH 1/4] Doc/config.txt: explain repeated sections astian
2017-07-08 23:03 ` Junio C Hamano
2017-07-09 7:57 ` Junio C Hamano
2017-07-10 7:32 ` Jeff King
2017-07-10 16:17 ` Junio C Hamano
2017-07-08 20:34 ` [PATCH 2/4] Doc/config.txt: fix typos astian
2017-07-08 20:34 ` [PATCH 3/4] Doc/git-send-email.txt: clarify a couple of options astian
2017-07-08 20:34 ` [PATCH 4/4] Doc/config.txt: fix documentation for smtpEncryption astian
2017-07-08 23:09 ` 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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170708203413.16442-1-astian@eclipso.at \
--to=astian@eclipso.at \
--cc=git@vger.kernel.org \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).