bug#29656: rcirc: The built-in /reconnect command should be documented

bug#29656: rcirc: The built-in /reconnect command should be documented

[Miciah Dashiel Butler Masters]

[-- Attachment #1.1: Type: text/plain, Size: 304 bytes --]

Commit 0b816f158782bd668cea3f013a4d6fb277ffe95a (shipped in Emacs 25.1)
added a /reconnect command to rcirc but did not document it and did not
delete the example /reconnect command definition in the manual.

The attached patch documents the built-in /reconnect and deletesthe example
reconnect command.

[-- Attachment #1.2: Type: text/html, Size: 361 bytes --]

[-- Attachment #2: 0001-Document-reconnect-as-a-built-in-command.patch --]
[-- Type: text/x-patch, Size: 4282 bytes --]

From a16c52c5732995d306afdb0db43ea65f10906a37 Mon Sep 17 00:00:00 2001
From: Miciah Masters <miciah.masters@gmail.com>
Date: Sun, 10 Dec 2017 19:56:48 -0500
Subject: [PATCH] Document /reconnect as a built-in command

Commit 0b816f158782bd668cea3f013a4d6fb277ffe95a (shipped in Emacs 25.1)
added a /reconnect command to rcirc but did not document it and did not
delete the example /reconnect command definition in the manual.

* doc/misc/rcirc.texi (rcirc commands): Document the built-in /reconnect
  command.
  (Hacking and Tweaking): Delete example reconnect command.
---
 doc/misc/rcirc.texi | 60 +++++++++++++++--------------------------------------
 1 file changed, 17 insertions(+), 43 deletions(-)

diff --git a/doc/misc/rcirc.texi b/doc/misc/rcirc.texi
index 1b5bdfcc68..89be1e08d4 100644
--- a/doc/misc/rcirc.texi
+++ b/doc/misc/rcirc.texi
@@ -88,7 +88,6 @@ Top
 * Scrolling conservatively::
 * Changing the time stamp format::
 * Defining a new command::
-* Reconnecting after you have lost the connection::
 
 @end detailmenu
 @end menu
@@ -401,6 +400,23 @@ rcirc commands
 optionally provide a reason for quitting.  When you kill the server
 buffer, you automatically quit the server and part all channels.  (Also
 @code{/quit ZZZzzz...}.)
+
+@item /reconnect
+@cindex /reconnect
+@cindex reconnect
+@cindex lost connection
+@cindex disconnecting servers, reconnecting
+This reconnects after you have lost the connection.
+
+If you're chatting from a laptop, then you might be familiar with this
+problem: When your laptop falls asleep and wakes up later, your IRC
+client doesn't realize that it has been disconnected.  It takes several
+minutes until the client decides that the connection has in fact been
+lost.  The simple solution is to use @kbd{M-x rcirc}.  The problem is
+that this opens an @emph{additional} connection, so you'll have two
+copies of every channel buffer, one dead and one live.
+
+The real answer, therefore, is the @code{/reconnect} command.
 @end table
 
 @node Useful IRC commands
@@ -787,7 +803,6 @@ Hacking and Tweaking
 * Scrolling conservatively::
 * Changing the time stamp format::
 * Defining a new command::
-* Reconnecting after you have lost the connection::
 @end menu
 
 @node Skipping /away messages using handlers
@@ -888,47 +903,6 @@ Defining a new command
                          (concat "I use " rcirc-id-string))))
 @end smallexample
 
-@node Reconnecting after you have lost the connection
-@section Reconnecting after you have lost the connection
-@cindex reconnecting
-@cindex disconnecting servers, reconnecting
-
-If you're chatting from a laptop, then you might be familiar with this
-problem: When your laptop falls asleep and wakes up later, your IRC
-client doesn't realize that it has been disconnected.  It takes several
-minutes until the client decides that the connection has in fact been
-lost.  The simple solution is to use @kbd{M-x rcirc}.  The problem is
-that this opens an @emph{additional} connection, so you'll have two
-copies of every channel buffer, one dead and one live.
-
-The real answer, therefore, is a @code{/reconnect} command:
-
-@smallexample
-(with-eval-after-load 'rcirc
-  (defun-rcirc-command reconnect (arg)
-    "Reconnect the server process."
-    (interactive "i")
-    (unless process
-      (error "There's no process for this target"))
-    (let* ((server (car (process-contact process)))
-           (port (process-contact process :service))
-           (nick (rcirc-nick process))
-           channels query-buffers)
-      (dolist (buf (buffer-list))
-        (with-current-buffer buf
-          (when (eq process (rcirc-buffer-process))
-            (remove-hook 'change-major-mode-hook
-                         'rcirc-change-major-mode-hook)
-            (if (rcirc-channel-p rcirc-target)
-                (setq channels (cons rcirc-target channels))
-              (setq query-buffers (cons buf query-buffers))))))
-      (delete-process process)
-      (rcirc-connect server port nick
-                     rcirc-default-user-name
-                     rcirc-default-full-name
-                     channels))))
-@end smallexample
-
 @node GNU Free Documentation License
 @appendix GNU Free Documentation License
 @include doclicense.texi
-- 
2.11.0.258.ge05806d

bug#29656: rcirc: The built-in /reconnect command should be documented

[Noam Postavsky]

tags 29656 fixed
close 29656 26.2
quit

Miciah Dashiel Butler Masters <miciah.masters@gmail.com> writes:

> Commit 0b816f158782bd668cea3f013a4d6fb277ffe95a (shipped in Emacs 25.1)
> added a /reconnect command to rcirc but did not document it and did not
> delete the example /reconnect command definition in the manual.
>
> The attached patch documents the built-in /reconnect and deletesthe example
> reconnect command.

Pushed to emacs-26.

[1: 3d09d533d1]: 2018-08-29 22:53:43 -0400
  rcirc: Document /reconnect as a built-in command (Bug#29656)
  https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=3d09d533d15eae2974f3858df43746cf6e8f897b