]> git.eshelyaron.com Git - emacs.git/commitdiff
Clean up some defvoo doc strings
authorLars Ingebrigtsen <larsi@gnus.org>
Fri, 13 Apr 2018 17:54:22 +0000 (19:54 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Fri, 13 Apr 2018 18:00:52 +0000 (20:00 +0200)
* lisp/gnus/nndiary.el: Remove "*" from doc strings from defvoo
elements (bug#23392).

* lisp/gnus/nndir.el: Ditto

* lisp/gnus/nndoc.el: Ditto.

* lisp/gnus/nnrss.el: Ditto.

* lisp/gnus/nnspool.el: Ditto.

* lisp/gnus/nntp.el: Ditto.

lisp/gnus/nndiary.el
lisp/gnus/nndir.el
lisp/gnus/nndoc.el
lisp/gnus/nnrss.el
lisp/gnus/nnspool.el
lisp/gnus/nntp.el

index 609d90b1071803e0c0e05c152b1c072e81043b9d..0b300c1a16f05d7fa010e564291d8e4a0d7fe1d6 100644 (file)
@@ -232,7 +232,7 @@ through all nnml directories and generate nov databases for them
 all.  This may very well take some time.")
 
 (defvoo nndiary-prepare-save-mail-hook nil
-  "*Hook run narrowed to an article before saving.")
+  "Hook run narrowed to an article before saving.")
 
 (defvoo nndiary-inhibit-expiry nil
   "If non-nil, inhibit expiry.")
index 0506bb20ee6f7e97231f12d060ec9557ac1ce68d..6dc6c3380826bda02ed9830749c4e2caa8d20d7a 100644 (file)
@@ -37,7 +37,7 @@
   nnml-current-directory nnmh-current-directory)
 
 (defvoo nndir-nov-is-evil nil
-  "*Non-nil means that nndir will never retrieve NOV headers."
+  "Non-nil means that nndir will never retrieve NOV headers."
   nnml-nov-is-evil)
 
 \f
index fa3117ae2f3c18e67f9beb952b094fcda2593db0..2ed023f68635867c120cf720d87752901c087b5d 100644 (file)
 (nnoo-declare nndoc)
 
 (defvoo nndoc-article-type 'guess
-  "*Type of the file.
+  "Type of the file.
 One of `mbox', `babyl', `digest', `news', `rnews', `mmdf', `forward',
 `rfc934', `rfc822-forward', `mime-parts', `standard-digest',
 `slack-digest', `clari-briefs', `nsmail', `outlook', `oe-dbx',
 `mailman', `exim-bounce', or `guess'.")
 
 (defvoo nndoc-post-type 'mail
-  "*Whether the nndoc group is `mail' or `post'.")
+  "Whether the nndoc group is `mail' or `post'.")
 
 (defvoo nndoc-open-document-hook 'nnheader-ms-strip-cr
   "Hook run after opening a document.
index c38f7eb79b913eeec816dc60c2e9056d62f07b97..f80e2c510789e143981b6643743fdc9ef07f92c0 100644 (file)
@@ -49,7 +49,7 @@
   "Where nnrss will save its files.")
 
 (defvoo nnrss-ignore-article-fields '(slash:comments)
-  "*List of fields that should be ignored when comparing RSS articles.
+  "List of fields that should be ignored when comparing RSS articles.
 Some RSS feeds update article fields during their lives, e.g. to
 indicate the number of comments or the number of times the
 articles have been seen.  However, if there is a difference
index 128ce7cac662c89e3abe259760abd750f448bcc1..c4dc575dcd46348db8b6c5aca98004304349f1ad 100644 (file)
@@ -105,7 +105,7 @@ If nil, nnspool will load the entire file into a buffer and process it
 there.")
 
 (defvoo nnspool-rejected-article-hook nil
-  "*A hook that will be run when an article has been rejected by the server.")
+  "A hook that will be run when an article has been rejected by the server.")
 
 (defvoo nnspool-file-coding-system nnheader-file-coding-system
   "Coding system for nnspool.")
index 5291919bab569d21d63a952231b78997feecee39..784240f4ff9ce6588b7e7a939393edd1b1fc1452 100644 (file)
@@ -48,7 +48,7 @@
   "Port number on the physical nntp server.")
 
 (defvoo nntp-server-opened-hook '(nntp-send-mode-reader)
-  "*Hook used for sending commands to the server at startup.
+  "Hook used for sending commands to the server at startup.
 The default value is `nntp-send-mode-reader', which makes an innd
 server spawn an nnrpd server.")
 
@@ -94,7 +94,7 @@ For indirect connections:
 - `nntp-open-via-telnet-and-telnet'")
 
 (defvoo nntp-never-echoes-commands nil
-  "*Non-nil means the nntp server never echoes commands.
+  "Non-nil means the nntp server never echoes commands.
 It is reported that some nntps server doesn't echo commands.  So, you
 may want to set this to non-nil in the method for such a server setting
 `nntp-open-connection-function' to `nntp-open-ssl-stream' for example.
@@ -103,102 +103,102 @@ variable overrides the nil value of this variable.")
 
 (defvoo nntp-open-connection-functions-never-echo-commands
     '(nntp-open-network-stream)
-  "*List of functions that never echo commands.
+  "List of functions that never echo commands.
 Add or set a function which you set to `nntp-open-connection-function'
 to this list if it does not echo commands.  Note that a non-nil value
 of the `nntp-never-echoes-commands' variable overrides this variable.")
 
 (defvoo nntp-pre-command nil
-  "*Pre-command to use with the various nntp-open-via-* methods.
+  "Pre-command to use with the various nntp-open-via-* methods.
 This is where you would put \"runsocks\" or stuff like that.")
 
 (defvoo nntp-telnet-command "telnet"
-  "*Telnet command used to connect to the nntp server.
+  "Telnet command used to connect to the nntp server.
 This command is used by the methods `nntp-open-telnet-stream',
 `nntp-open-via-rlogin-and-telnet' and `nntp-open-via-telnet-and-telnet'.")
 
 (defvoo nntp-telnet-switches '("-8")
-  "*Switches given to the telnet command `nntp-telnet-command'.")
+  "Switches given to the telnet command `nntp-telnet-command'.")
 
 (defvoo nntp-end-of-line "\r\n"
-  "*String to use on the end of lines when talking to the NNTP server.
+  "String to use on the end of lines when talking to the NNTP server.
 This is \"\\r\\n\" by default, but should be \"\\n\" when using an indirect
 connection method (nntp-open-via-*).")
 
 (defvoo nntp-via-rlogin-command "rsh"
-  "*Rlogin command used to connect to an intermediate host.
+  "Rlogin command used to connect to an intermediate host.
 This command is used by the methods `nntp-open-via-rlogin-and-telnet'
 and `nntp-open-via-rlogin-and-netcat'.  The default is \"rsh\", but \"ssh\"
 is a popular alternative.")
 
 (defvoo nntp-via-rlogin-command-switches nil
-  "*Switches given to the rlogin command `nntp-via-rlogin-command'.
+  "Switches given to the rlogin command `nntp-via-rlogin-command'.
 If you use \"ssh\" for `nntp-via-rlogin-command', you may set this to
 \(\"-C\") in order to compress all data connections, otherwise set this
 to \(\"-t\" \"-e\" \"none\") or (\"-C\" \"-t\" \"-e\" \"none\") if the telnet
 command requires a pseudo-tty allocation on an intermediate host.")
 
 (defvoo nntp-via-telnet-command "telnet"
-  "*Telnet command used to connect to an intermediate host.
+  "Telnet command used to connect to an intermediate host.
 This command is used by the `nntp-open-via-telnet-and-telnet' method.")
 
 (defvoo nntp-via-telnet-switches '("-8")
-  "*Switches given to the telnet command `nntp-via-telnet-command'.")
+  "Switches given to the telnet command `nntp-via-telnet-command'.")
 
 (defvoo nntp-netcat-command "nc"
-  "*Netcat command used to connect to the nntp server.
+  "Netcat command used to connect to the nntp server.
 This command is used by the `nntp-open-netcat-stream' and
 `nntp-open-via-rlogin-and-netcat' methods.")
 
 (defvoo nntp-netcat-switches nil
-  "*Switches given to the netcat command `nntp-netcat-command'.")
+  "Switches given to the netcat command `nntp-netcat-command'.")
 
 (defvoo nntp-via-user-name nil
-  "*User name to log in on an intermediate host with.
+  "User name to log in on an intermediate host with.
 This variable is used by the various nntp-open-via-* methods.")
 
 (defvoo nntp-via-user-password nil
-  "*Password to use to log in on an intermediate host with.
+  "Password to use to log in on an intermediate host with.
 This variable is used by the `nntp-open-via-telnet-and-telnet' method.")
 
 (defvoo nntp-via-address nil
-  "*Address of an intermediate host to connect to.
+  "Address of an intermediate host to connect to.
 This variable is used by the various nntp-open-via-* methods.")
 
 (defvoo nntp-via-envuser nil
-  "*Whether both telnet client and server support the ENVIRON option.
+  "Whether both telnet client and server support the ENVIRON option.
 If non-nil, there will be no prompt for a login name.")
 
 (defvoo nntp-via-shell-prompt "bash\\|[$>] *\r?$"
-  "*Regular expression to match the shell prompt on an intermediate host.
+  "Regular expression to match the shell prompt on an intermediate host.
 This variable is used by the `nntp-open-via-telnet-and-telnet' method.")
 
 (defvoo nntp-large-newsgroup 50
-  "*The number of articles which indicates a large newsgroup.
+  "The number of articles which indicates a large newsgroup.
 If the number of articles is greater than the value, verbose
 messages will be shown to indicate the current status.")
 
 (defvoo nntp-maximum-request 400
-  "*The maximum number of the requests sent to the NNTP server at one time.
+  "The maximum number of the requests sent to the NNTP server at one time.
 If Emacs hangs up while retrieving headers, set the variable to a
 lower value.")
 
 (defvoo nntp-nov-is-evil nil
-  "*If non-nil, nntp will never attempt to use XOVER when talking to the server.")
+  "If non-nil, nntp will never attempt to use XOVER when talking to the server.")
 
 (defvoo nntp-xover-commands '("XOVER" "XOVERVIEW")
-  "*List of strings that are used as commands to fetch NOV lines from a server.
+  "List of strings that are used as commands to fetch NOV lines from a server.
 The strings are tried in turn until a positive response is gotten.  If
 none of the commands are successful, nntp will just grab headers one
 by one.")
 
 (defvoo nntp-nov-gap 5
-  "*Maximum allowed gap between two articles.
+  "Maximum allowed gap between two articles.
 If the gap between two consecutive articles is bigger than this
 variable, split the XOVER request into two requests.")
 
 (defvoo nntp-xref-number-is-evil nil
-  "*If non-nil, Gnus never trusts article numbers in the Xref header.
+  "If non-nil, Gnus never trusts article numbers in the Xref header.
 Some news servers, e.g., ones running Diablo, run multiple engines
 having the same articles but article numbers are not kept synchronized
 between them.  If you connect to such a server, set this to a non-nil
@@ -206,7 +206,7 @@ value, and Gnus never uses article numbers (that appear in the Xref
 header and vary by which engine is chosen) to refer to articles.")
 
 (defvoo nntp-prepare-server-hook nil
-  "*Hook run before a server is opened.
+  "Hook run before a server is opened.
 If can be used to set up a server remotely, for instance.  Say you
 have an account at the machine \"other.machine\".  This machine has
 access to an NNTP server that you can't access locally.  You could
@@ -237,11 +237,11 @@ server there that you can connect to.  See also
 \f
 
 (defvoo nntp-connection-timeout nil
-  "*Number of seconds to wait before an nntp connection times out.
+  "Number of seconds to wait before an nntp connection times out.
 If this variable is nil, which is the default, no timers are set.")
 
 (defvoo nntp-prepare-post-hook nil
-  "*Hook run just before posting an article.  It is supposed to be used
+  "Hook run just before posting an article.  It is supposed to be used
 to insert Cancel-Lock headers.")
 
 (defvoo nntp-server-list-active-group 'try
@@ -1743,26 +1743,26 @@ If SEND-IF-FORCE, only send authinfo to the server if the
 ;; ==========================================================================
 
 (defvoo nntp-open-telnet-envuser nil
-  "*If non-nil, telnet session (client and server both) will support the ENVIRON option and not prompt for login name.")
+  "If non-nil, telnet session (client and server both) will support the ENVIRON option and not prompt for login name.")
 
 (defvoo nntp-telnet-shell-prompt "bash\\|[$>] *\r?$"
-  "*Regular expression to match the shell prompt on the remote machine.")
+  "Regular expression to match the shell prompt on the remote machine.")
 
 (defvoo nntp-rlogin-program "rsh"
-  "*Program used to log in on remote machines.
+  "Program used to log in on remote machines.
 The default is \"rsh\", but \"ssh\" is a popular alternative.")
 
 (defvoo nntp-rlogin-parameters '("telnet" "-8" "${NNTPSERVER:=news}" "nntp")
-  "*Parameters to `nntp-open-rlogin'.
+  "Parameters to `nntp-open-rlogin'.
 That function may be used as `nntp-open-connection-function'.  In that
 case, this list will be used as the parameter list given to rsh.")
 
 (defvoo nntp-rlogin-user-name nil
-  "*User name on remote system when using the rlogin connect method.")
+  "User name on remote system when using the rlogin connect method.")
 
 (defvoo nntp-telnet-parameters
     '("exec" "telnet" "-8" "${NNTPSERVER:=news}" "nntp")
-  "*Parameters to `nntp-open-telnet'.
+  "Parameters to `nntp-open-telnet'.
 That function may be used as `nntp-open-connection-function'.  In that
 case, this list will be executed as a command after logging in
 via telnet.")