[PATCH 0/4] Misc. documentation fixes
- Date: Sat, 8 Jul 2017 20:34:09 +0000
- From: astian <astian@xxxxxxxxxx>
- Subject: [PATCH 0/4] Misc. documentation fixes
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.
Doc/config.txt: explain repeated sections
Doc/config.txt: fix typos
Doc/git-send-email.txt: clarify a couple of options
Still to fix:
The current nomenclarure is braindamaged: what's currently
called "ssl" should be called "tls", what's currently called
"tls" should be called "starttls".
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(-)