bug#2562: [PATCH] 23.0.91; pcmpl-unix.el::pcmpl-ssh-hosts improve docstring

bug#2562: [PATCH] 23.0.91; pcmpl-unix.el::pcmpl-ssh-hosts improve docstring

[Jari Aalto]

[-- Attachment #1: Type: text/plain, Size: 157 bytes --]

tags patch
thanks

2009-03-03  Jari Aalto  <jari.aalto@cante.net>

	* pcmpl-unix.el (pcmpl-ssh-hosts): Improve docstring to
	mention sshd(8) hashed format.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-lisp-pcmpl-unix.el-pcmpl-ssh-hosts-improve-docst.patch --]
[-- Type: text/x-diff, Size: 1028 bytes --]

From 726c1b9dff18612fff229cf182952796e602a839 Mon Sep 17 00:00:00 2001
From: Jari Aalto <jari.aalto@cante.net>
Date: Tue, 3 Mar 2009 20:10:28 +0200
Subject: [PATCH] lisp/pcmpl-unix.el: (pcmpl-ssh-hosts): improve docstring

Signed-off-by: Jari Aalto <jari.aalto@cante.net>
---
 lisp/pcmpl-unix.el |    5 ++++-
 1 files changed, 4 insertions(+), 1 deletions(-)

diff --git a/lisp/pcmpl-unix.el b/lisp/pcmpl-unix.el
index c12920f..ef7297d 100644
--- a/lisp/pcmpl-unix.el
+++ b/lisp/pcmpl-unix.el
@@ -134,7 +134,10 @@ with the SSH option \"HashKnownHosts no\"."
 ;; http://www.emacswiki.org/cgi-bin/wiki/pcmpl-ssh.el
 
 (defun pcmpl-ssh-hosts ()
-  "Return a list of hosts found in `pcmpl-ssh-known-hosts-file'."
+  "Return a list of hosts found in `pcmpl-ssh-known-hosts-file'.
+
+Note: in case the file is in hashed format as described in
+sshd(8) manual page, this function returns nothing."
   (when (and pcmpl-ssh-known-hosts-file
              (file-readable-p pcmpl-ssh-known-hosts-file))
     (with-temp-buffer
-- 
1.6.1.3

bug#2561: [PATCH] 23.0.91; pcmpl-unix.el::pcmpl-ssh-hosts improve docstring

[Richard M Stallman]

    +Note: in case the file is in hashed format as described in
    +sshd(8) manual page, this function returns nothing."

Since man pages are deprecated in GNU, can you refer to that
documentation in another way?

bug#2561: [PATCH] 23.0.91; pcmpl-unix.el::pcmpl-ssh-hosts improve docstring

[Jari Aalto]

Richard M Stallman <rms@gnu.org> writes:

>     +Note: in case the file is in hashed format as described in
>     +sshd(8) manual page, this function returns nothing."
>
> Since man pages are deprecated in GNU, can you refer to that
> documentation in another way?

Howabout this. --Jari

2009-03-03  Jari Aalto  <jari.aalto@cante.net>

        * pcmpl-unix.el (pcmpl-ssh-hosts): Improve docstring to
        mention OpenSSH hashed format.

From 905acf969238822e82b9c21a412072be72985da5 Mon Sep 17 00:00:00 2001
From: Jari Aalto <jari.aalto@cante.net>
Date: Thu, 5 Mar 2009 02:52:37 +0200
Subject: [PATCH] pcmpl-unix.el (pcmpl-ssh-hosts): Improve docstring to mention OpenSSH hashed format

Signed-off-by: Jari Aalto <jari.aalto@cante.net>
---
 lisp/pcmpl-unix.el |    5 ++++-
 1 files changed, 4 insertions(+), 1 deletions(-)

diff --git a/lisp/pcmpl-unix.el b/lisp/pcmpl-unix.el
index c12920f..298b601 100644
--- a/lisp/pcmpl-unix.el
+++ b/lisp/pcmpl-unix.el
@@ -134,7 +134,10 @@ with the SSH option \"HashKnownHosts no\"."
 ;; http://www.emacswiki.org/cgi-bin/wiki/pcmpl-ssh.el
 
 (defun pcmpl-ssh-hosts ()
-  "Return a list of hosts found in `pcmpl-ssh-known-hosts-file'."
+  "Return a list of hosts found in `pcmpl-ssh-known-hosts-file'.
+
+Note: in case the file is in hashed format as described in
+OpenSSH documentation, this function returns nothing."
   (when (and pcmpl-ssh-known-hosts-file
              (file-readable-p pcmpl-ssh-known-hosts-file))
     (with-temp-buffer
-- 
1.6.1.3

bug#2561: [PATCH] 23.0.91; pcmpl-unix.el::pcmpl-ssh-hosts improve docstring

[Richard M Stallman]

    +Note: in case the file is in hashed format as described in
    +OpenSSH documentation, this function returns nothing."

That's fine.

bug#2561: [PATCH] 23.0.91; pcmpl-unix.el::pcmpl-ssh-hosts improve docstring

[Chong Yidong]

Thanks; I've checked in the patch.