bug#37964: [PATCH] Remove references to obsolete libraries

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

bug#37964: [PATCH] Remove references to obsolete libraries

Stefan Kangas
Inspired by Bug#37956, I had a look to see if we reference any other
obsolete libraries in the manuals.  The attached patch fixes what I
could find.

It would be good if someone had a look especially at the attempt to
remove the references to tls.el and starttls.el in the elisp manual.

Best regards,
Stefan Kangas

0001-Remove-references-to-obsolete-libraries.patch (8K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

bug#37964: [PATCH] Remove references to obsolete libraries

Eli Zaretskii
> From: Stefan Kangas <[hidden email]>
> Date: Mon, 28 Oct 2019 17:37:34 +0100
>
> diff --git a/doc/lispref/processes.texi b/doc/lispref/processes.texi
> index 287221a184..71ce1a8b56 100644
> --- a/doc/lispref/processes.texi
> +++ b/doc/lispref/processes.texi
> @@ -2426,18 +2426,15 @@ Network
>  @cindex encrypted network connections
>  @cindex @acronym{TLS} network connections
>  @cindex @acronym{STARTTLS} network connections
> -Emacs can create encrypted network connections, using either built-in
> -or external support.  The built-in support uses the GnuTLS
> -Transport Layer Security Library; see
> +Emacs can create encrypted network connections, using the built-in
> +support for the GnuTLS Transport Layer Security Library; see
>  @uref{https://www.gnu.org/software/gnutls/, the GnuTLS project page}.
>  If your Emacs was compiled with GnuTLS support, the function
>  @code{gnutls-available-p} is defined and returns non-@code{nil}.  For
>  more details, @pxref{Top,, Overview, emacs-gnutls, The Emacs-GnuTLS manual}.
> -The external support uses the @file{starttls.el} library, which
> -requires a helper utility such as @command{gnutls-cli} to be installed
> -on the system.  The @code{open-network-stream} function can
> -transparently handle the details of creating encrypted connections for
> -you, using whatever support is available.
> +The @code{open-network-stream} function can transparently handle the
> +details of creating encrypted connections for you, using whatever
> +support is available.

Not sure if we should remove references to starttls etc.  Does anyone
else have an opinion?

> -Use of any form of TLS/SSL requires support in Emacs.  You can either
> -use the built-in support (in Emacs 24.1 and later), or the
> -@file{starttls.el} Lisp library.  The built-in support uses the GnuTLS
> -@footnote{@url{https://www.gnu.org/software/gnutls/}} library.
> -If your Emacs has GnuTLS support built-in, the function
> -@code{gnutls-available-p} is defined and returns non-@code{nil}.
> -Otherwise, you must use the @file{starttls.el} library (see that file for
> -more information on customization options, etc.).  The Lisp library
> -requires one of the following external tools to be installed:
> +Use of any form of TLS/SSL requires support in Emacs.  You can use the
> +built-in support for the GnuTLS
> +@footnote{@url{https://www.gnu.org/software/gnutls/}} library. If your
> +Emacs has GnuTLS support built-in, the function
> +@code{gnutls-available-p} is defined and returns non-@code{nil}.  The
> +Lisp library requires one of the following external tools to be
> +installed:

The last part should be deleted if we are removing the starttls stuff,
because the "Lisp library" refers to it.  Also, you have only one
space between sentences there.

Thanks.



Reply | Threaded
Open this post in threaded view
|

bug#37964: [PATCH] Remove references to obsolete libraries

Stefan Kangas
Eli Zaretskii <[hidden email]> writes:

> Not sure if we should remove references to starttls etc.  Does anyone
> else have an opinion?

My understanding was that we avoid recommending use of obsolete
libraries.  Both tls.el and starttls.el are obsolete in 27.1.

The alternative to removing them would be to update it to say they are
now obsolete, I guess?  Please let me know if that is preferred.

> The last part should be deleted if we are removing the starttls stuff,
> because the "Lisp library" refers to it.  Also, you have only one
> space between sentences there.

Thanks, I've fixed that in the attached patch.

Best regards,
Stefan Kangas

From eafc61090841ed1a825a45ffb1f058cd31380945 Mon Sep 17 00:00:00 2001
From: Stefan Kangas <[hidden email]>
Date: Mon, 28 Oct 2019 17:33:22 +0100
Subject: [PATCH] Remove references to obsolete libraries

* doc/emacs/cmdargs.texi (General Variables):
* doc/lispintro/emacs-lisp-intro.texi (Lisp History):
* doc/lispref/processes.texi (Network):
* doc/misc/gnus-coding.texi (Gnus Coding Style):
* doc/misc/gnus.texi (Oort Gnus):
* doc/misc/smtpmail.texi (Encryption): Remove references to obsolete
libraries.  (Bug#37964)
---
 doc/emacs/cmdargs.texi              |  6 ------
 doc/lispintro/emacs-lisp-intro.texi |  2 +-
 doc/lispref/processes.texi          | 13 +++++--------
 doc/misc/gnus-coding.texi           | 10 ----------
 doc/misc/gnus.texi                  |  2 +-
 doc/misc/smtpmail.texi              | 23 ++++-------------------
 6 files changed, 11 insertions(+), 45 deletions(-)

diff --git a/doc/emacs/cmdargs.texi b/doc/emacs/cmdargs.texi
index b3d9af0baf..015ed3ae94 100644
--- a/doc/emacs/cmdargs.texi
+++ b/doc/emacs/cmdargs.texi
@@ -565,12 +565,6 @@ General Variables
 @item HOSTNAME
 @vindex HOSTNAME@r{, environment variable}
 The name of the machine that Emacs is running on.
-@c complete.el is obsolete since 24.1.
-@ignore
-@item INCPATH
-A colon-separated list of directories.  Used by the @code{complete} package
-to search for files.
-@end ignore
 @item INFOPATH
 @vindex INFOPATH@r{, environment variable}
 A colon-separated list of directories in which to search for Info files.
diff --git a/doc/lispintro/emacs-lisp-intro.texi b/doc/lispintro/emacs-lisp-intro.texi
index 489ba8d6ef..b25b7ffa84 100644
--- a/doc/lispintro/emacs-lisp-intro.texi
+++ b/doc/lispintro/emacs-lisp-intro.texi
@@ -923,7 +923,7 @@ Lisp History
 in the 1960s.  It is somewhat inspired by Common Lisp, which became a
 standard in the 1980s.  However, Emacs Lisp is much simpler than Common
 Lisp.  (The standard Emacs distribution contains an optional extensions
-file, @file{cl.el}, that adds many Common Lisp features to Emacs Lisp.)
+file, @file{cl-lib.el}, that adds many Common Lisp features to Emacs Lisp.)
 
 @node Note for Novices
 @unnumberedsec A Note for Novices
diff --git a/doc/lispref/processes.texi b/doc/lispref/processes.texi
index 5caf0a2426..9c200a0278 100644
--- a/doc/lispref/processes.texi
+++ b/doc/lispref/processes.texi
@@ -2426,18 +2426,15 @@ Network
 @cindex encrypted network connections
 @cindex @acronym{TLS} network connections
 @cindex @acronym{STARTTLS} network connections
-Emacs can create encrypted network connections, using either built-in
-or external support.  The built-in support uses the GnuTLS
-Transport Layer Security Library; see
+Emacs can create encrypted network connections, using the built-in
+support for the GnuTLS Transport Layer Security Library; see
 @uref{https://www.gnu.org/software/gnutls/, the GnuTLS project page}.
 If your Emacs was compiled with GnuTLS support, the function
 @code{gnutls-available-p} is defined and returns non-@code{nil}.  For
 more details, @pxref{Top,, Overview, emacs-gnutls, The Emacs-GnuTLS manual}.
-The external support uses the @file{starttls.el} library, which
-requires a helper utility such as @command{gnutls-cli} to be installed
-on the system.  The @code{open-network-stream} function can
-transparently handle the details of creating encrypted connections for
-you, using whatever support is available.
+The @code{open-network-stream} function can transparently handle the
+details of creating encrypted connections for you, using whatever
+support is available.
 
 @defun open-network-stream name buffer host service &rest parameters
 This function opens a TCP connection, with optional encryption, and
diff --git a/doc/misc/gnus-coding.texi b/doc/misc/gnus-coding.texi
index 6affea4872..240c795ac5 100644
--- a/doc/misc/gnus-coding.texi
+++ b/doc/misc/gnus-coding.texi
@@ -96,16 +96,6 @@ Gnus Coding Style
 @c As of 2005-10-21...
 There are no Gnus dependencies in this file.
 
-@item tls.el
-TLS/SSL support via wrapper around GnuTLS
-@c As of 2005-10-21...
-There are no Gnus dependencies in this file.
-
-@item pgg*.el
-Glue for the various PGP implementations.
-@c As of 2005-10-21...
-There are no Gnus dependencies in these files.
-
 @item sha1.el
 SHA1 Secure Hash Algorithm.
 @c As of 2007-08-25...
diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi
index 8ab1cf9f68..b4cf1613db 100644
--- a/doc/misc/gnus.texi
+++ b/doc/misc/gnus.texi
@@ -27940,7 +27940,7 @@ Oort Gnus
 @acronym{TLS} wrapper shipped with Gnus
 
 @acronym{TLS}/@acronym{SSL} is now supported in @acronym{IMAP} and
-@acronym{NNTP} via @file{tls.el} and GnuTLS.
+@acronym{NNTP} via GnuTLS.
 
 @item
 Improved anti-spam features.
diff --git a/doc/misc/smtpmail.texi b/doc/misc/smtpmail.texi
index 7fa7b24e16..558f67fa7d 100644
--- a/doc/misc/smtpmail.texi
+++ b/doc/misc/smtpmail.texi
@@ -295,26 +295,11 @@ Encryption
 are: @code{starttls} to insist on STARTTLS; @code{ssl} to use TLS/SSL;
 and @code{plain} for no encryption.
 
-Use of any form of TLS/SSL requires support in Emacs.  You can either
-use the built-in support (in Emacs 24.1 and later), or the
-@file{starttls.el} Lisp library.  The built-in support uses the GnuTLS
-@footnote{@url{https://www.gnu.org/software/gnutls/}} library.
-If your Emacs has GnuTLS support built-in, the function
+Use of any form of TLS/SSL requires support in Emacs.  You can use the
+built-in support for the GnuTLS
+@footnote{@url{https://www.gnu.org/software/gnutls/}} library.  If your
+Emacs has GnuTLS support built-in, the function
 @code{gnutls-available-p} is defined and returns non-@code{nil}.
-Otherwise, you must use the @file{starttls.el} library (see that file for
-more information on customization options, etc.).  The Lisp library
-requires one of the following external tools to be installed:
-
-@enumerate
-@item
-The GnuTLS command line tool @samp{gnutls-cli}, which you can get from
-@url{https://www.gnu.org/software/gnutls/}.  This is the recommended
-tool, mainly because it can verify server certificates.
-
-@item
-The @samp{starttls} external program, which you can get from
-@file{starttls-*.tar.gz} from @uref{ftp://ftp.opaopa.org/pub/elisp/}.
-@end enumerate
 
 @cindex certificates
 @cindex keys
--
2.20.1

Reply | Threaded
Open this post in threaded view
|

bug#37964: [PATCH] Remove references to obsolete libraries

Eli Zaretskii
> From: Stefan Kangas <[hidden email]>
> Cc: [hidden email]
> Date: Fri, 08 Nov 2019 14:10:53 +0100
>
> Eli Zaretskii <[hidden email]> writes:
>
> > Not sure if we should remove references to starttls etc.  Does anyone
> > else have an opinion?
>
> My understanding was that we avoid recommending use of obsolete
> libraries.  Both tls.el and starttls.el are obsolete in 27.1.
>
> The alternative to removing them would be to update it to say they are
> now obsolete, I guess?  Please let me know if that is preferred.

I don't mind removing the references, I just don't know whether people
are still using starttls.  Thus the request for more opinions.

> > The last part should be deleted if we are removing the starttls stuff,
> > because the "Lisp library" refers to it.  Also, you have only one
> > space between sentences there.
>
> Thanks, I've fixed that in the attached patch.

Thanks, it's fine now.