git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 0/4] Misc. documentation fixes

From
Aastian <astian@eclipso.at>
Date
Jul 8, 2017, 20:34 UTC
Message-ID
<20170708203413.16442-1-astian@eclipso.at>
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: astian
Message 1 of 10 in “Misc. documentation fixes”
  1. 0/4 Misc. documentation fixesastian, Jul 8, 2017
  2. 1/4 Doc/config.txt: explain repeated sectionsastian, Jul 8, 2017
  3. Junio C HamanoJul 8, 2017
  4. Junio C HamanoJul 9, 2017
  5. Jeff KingJul 10, 2017
  6. Junio C HamanoJul 10, 2017
  7. 2/4 Doc/config.txt: fix typosastian, Jul 8, 2017
  8. 3/4 Doc/git-send-email.txt: clarify a couple of optionsastian, Jul 8, 2017
  9. 4/4 Doc/config.txt: fix documentation for smtpEncryptionastian, Jul 8, 2017
  10. Junio C HamanoJul 8, 2017

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.