Skip to contentSkip to conversation

send-email: update documentation of required Perl modules

PATCH New Chris Mayo 1 participant 1 message May 30, 2019 Documentation

lore
Share & tools
lore

Chris Mayo

author
#0 lore raw

PATCH v2 1/1 send-email: update documentation of required Perl modules

Improve and complete the list of required email related Perl modules, clarifying which are core Perl modules and remove Net::SMTP::SSL.

git-send-email uses the TLS support in the Net::SMTP core module from recent versions of Perl. Documenting the minimum version is complex because of separate numbering for Perl (5.21.5~169), Net:SMTP (2.34) and libnet (3.01). Version numbers from commit:
bfbfc9a953 ("send-email: Net::SMTP::starttls was introduced in v2.34", 2017-05-31).

Users of older Perl versions without Net::SMTP::SSL installed will get a clear error message.

---

This is v2 of the patch titled:
"send-email: remove documented requirement for Net::SMTP::SSL"

Changes:
- add the core Net::Domain and Net::SMTP modules with an expanded note as suggested, also the core module MIME::QuotedPrint (MIME::Base64 is already listed).
- add the CPAN module Mail::Address (Authen::SASL is already listed)

 Documentation/git-send-email.txt | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
Documentation/git-send-email.txt +6 -2
index 1afe9fc858..504ae7fe76 100644
@@ -500,8 +500,12 @@ app-specific or your regular password as appropriate.  If you have credential
 helper configured (see linkgit:git-credential[1]), the password will be saved in
 the credential store so you won't have to type it the next time.
 
-Note: the following perl modules are required
-      Net::SMTP::SSL, MIME::Base64 and Authen::SASL
+Note: the following core Perl modules that may be installed with your
+distribution of Perl are required:
+MIME::Base64, MIME::QuotedPrint, Net::Domain and Net::SMTP.
+These additional Perl modules are also required:
+Authen::SASL and Mail::Address.
+
 
 SEE ALSO
 --------
Signature · 1 line
2.21.0