aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLars Ingebrigtsen2018-04-13 19:54:22 +0200
committerLars Ingebrigtsen2018-04-13 20:00:52 +0200
commitb7ac2761fc5e58dd48b8b11642d16ba2b4f04c74 (patch)
tree15c6c757ed250957cf3dbaded2797c2234a5a7b2
parentffbb4e8d542df44ced5afd89221b0dfb234d8525 (diff)
downloademacs-b7ac2761fc5e58dd48b8b11642d16ba2b4f04c74.tar.gz
emacs-b7ac2761fc5e58dd48b8b11642d16ba2b4f04c74.zip
Clean up some defvoo doc strings
* 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.
-rw-r--r--lisp/gnus/nndiary.el2
-rw-r--r--lisp/gnus/nndir.el2
-rw-r--r--lisp/gnus/nndoc.el4
-rw-r--r--lisp/gnus/nnrss.el2
-rw-r--r--lisp/gnus/nnspool.el2
-rw-r--r--lisp/gnus/nntp.el66
6 files changed, 39 insertions, 39 deletions
diff --git a/lisp/gnus/nndiary.el b/lisp/gnus/nndiary.el
index 609d90b1071..0b300c1a16f 100644
--- a/lisp/gnus/nndiary.el
+++ b/lisp/gnus/nndiary.el
@@ -232,7 +232,7 @@ through all nnml directories and generate nov databases for them
232all. This may very well take some time.") 232all. This may very well take some time.")
233 233
234(defvoo nndiary-prepare-save-mail-hook nil 234(defvoo nndiary-prepare-save-mail-hook nil
235 "*Hook run narrowed to an article before saving.") 235 "Hook run narrowed to an article before saving.")
236 236
237(defvoo nndiary-inhibit-expiry nil 237(defvoo nndiary-inhibit-expiry nil
238 "If non-nil, inhibit expiry.") 238 "If non-nil, inhibit expiry.")
diff --git a/lisp/gnus/nndir.el b/lisp/gnus/nndir.el
index 0506bb20ee6..6dc6c338082 100644
--- a/lisp/gnus/nndir.el
+++ b/lisp/gnus/nndir.el
@@ -37,7 +37,7 @@
37 nnml-current-directory nnmh-current-directory) 37 nnml-current-directory nnmh-current-directory)
38 38
39(defvoo nndir-nov-is-evil nil 39(defvoo nndir-nov-is-evil nil
40 "*Non-nil means that nndir will never retrieve NOV headers." 40 "Non-nil means that nndir will never retrieve NOV headers."
41 nnml-nov-is-evil) 41 nnml-nov-is-evil)
42 42
43 43
diff --git a/lisp/gnus/nndoc.el b/lisp/gnus/nndoc.el
index fa3117ae2f3..2ed023f6863 100644
--- a/lisp/gnus/nndoc.el
+++ b/lisp/gnus/nndoc.el
@@ -38,14 +38,14 @@
38(nnoo-declare nndoc) 38(nnoo-declare nndoc)
39 39
40(defvoo nndoc-article-type 'guess 40(defvoo nndoc-article-type 'guess
41 "*Type of the file. 41 "Type of the file.
42One of `mbox', `babyl', `digest', `news', `rnews', `mmdf', `forward', 42One of `mbox', `babyl', `digest', `news', `rnews', `mmdf', `forward',
43`rfc934', `rfc822-forward', `mime-parts', `standard-digest', 43`rfc934', `rfc822-forward', `mime-parts', `standard-digest',
44`slack-digest', `clari-briefs', `nsmail', `outlook', `oe-dbx', 44`slack-digest', `clari-briefs', `nsmail', `outlook', `oe-dbx',
45`mailman', `exim-bounce', or `guess'.") 45`mailman', `exim-bounce', or `guess'.")
46 46
47(defvoo nndoc-post-type 'mail 47(defvoo nndoc-post-type 'mail
48 "*Whether the nndoc group is `mail' or `post'.") 48 "Whether the nndoc group is `mail' or `post'.")
49 49
50(defvoo nndoc-open-document-hook 'nnheader-ms-strip-cr 50(defvoo nndoc-open-document-hook 'nnheader-ms-strip-cr
51 "Hook run after opening a document. 51 "Hook run after opening a document.
diff --git a/lisp/gnus/nnrss.el b/lisp/gnus/nnrss.el
index c38f7eb79b9..f80e2c51078 100644
--- a/lisp/gnus/nnrss.el
+++ b/lisp/gnus/nnrss.el
@@ -49,7 +49,7 @@
49 "Where nnrss will save its files.") 49 "Where nnrss will save its files.")
50 50
51(defvoo nnrss-ignore-article-fields '(slash:comments) 51(defvoo nnrss-ignore-article-fields '(slash:comments)
52 "*List of fields that should be ignored when comparing RSS articles. 52 "List of fields that should be ignored when comparing RSS articles.
53Some RSS feeds update article fields during their lives, e.g. to 53Some RSS feeds update article fields during their lives, e.g. to
54indicate the number of comments or the number of times the 54indicate the number of comments or the number of times the
55articles have been seen. However, if there is a difference 55articles have been seen. However, if there is a difference
diff --git a/lisp/gnus/nnspool.el b/lisp/gnus/nnspool.el
index 128ce7cac66..c4dc575dcd4 100644
--- a/lisp/gnus/nnspool.el
+++ b/lisp/gnus/nnspool.el
@@ -105,7 +105,7 @@ If nil, nnspool will load the entire file into a buffer and process it
105there.") 105there.")
106 106
107(defvoo nnspool-rejected-article-hook nil 107(defvoo nnspool-rejected-article-hook nil
108 "*A hook that will be run when an article has been rejected by the server.") 108 "A hook that will be run when an article has been rejected by the server.")
109 109
110(defvoo nnspool-file-coding-system nnheader-file-coding-system 110(defvoo nnspool-file-coding-system nnheader-file-coding-system
111 "Coding system for nnspool.") 111 "Coding system for nnspool.")
diff --git a/lisp/gnus/nntp.el b/lisp/gnus/nntp.el
index 5291919bab5..784240f4ff9 100644
--- a/lisp/gnus/nntp.el
+++ b/lisp/gnus/nntp.el
@@ -48,7 +48,7 @@
48 "Port number on the physical nntp server.") 48 "Port number on the physical nntp server.")
49 49
50(defvoo nntp-server-opened-hook '(nntp-send-mode-reader) 50(defvoo nntp-server-opened-hook '(nntp-send-mode-reader)
51 "*Hook used for sending commands to the server at startup. 51 "Hook used for sending commands to the server at startup.
52The default value is `nntp-send-mode-reader', which makes an innd 52The default value is `nntp-send-mode-reader', which makes an innd
53server spawn an nnrpd server.") 53server spawn an nnrpd server.")
54 54
@@ -94,7 +94,7 @@ For indirect connections:
94- `nntp-open-via-telnet-and-telnet'") 94- `nntp-open-via-telnet-and-telnet'")
95 95
96(defvoo nntp-never-echoes-commands nil 96(defvoo nntp-never-echoes-commands nil
97 "*Non-nil means the nntp server never echoes commands. 97 "Non-nil means the nntp server never echoes commands.
98It is reported that some nntps server doesn't echo commands. So, you 98It is reported that some nntps server doesn't echo commands. So, you
99may want to set this to non-nil in the method for such a server setting 99may want to set this to non-nil in the method for such a server setting
100`nntp-open-connection-function' to `nntp-open-ssl-stream' for example. 100`nntp-open-connection-function' to `nntp-open-ssl-stream' for example.
@@ -103,102 +103,102 @@ variable overrides the nil value of this variable.")
103 103
104(defvoo nntp-open-connection-functions-never-echo-commands 104(defvoo nntp-open-connection-functions-never-echo-commands
105 '(nntp-open-network-stream) 105 '(nntp-open-network-stream)
106 "*List of functions that never echo commands. 106 "List of functions that never echo commands.
107Add or set a function which you set to `nntp-open-connection-function' 107Add or set a function which you set to `nntp-open-connection-function'
108to this list if it does not echo commands. Note that a non-nil value 108to this list if it does not echo commands. Note that a non-nil value
109of the `nntp-never-echoes-commands' variable overrides this variable.") 109of the `nntp-never-echoes-commands' variable overrides this variable.")
110 110
111(defvoo nntp-pre-command nil 111(defvoo nntp-pre-command nil
112 "*Pre-command to use with the various nntp-open-via-* methods. 112 "Pre-command to use with the various nntp-open-via-* methods.
113This is where you would put \"runsocks\" or stuff like that.") 113This is where you would put \"runsocks\" or stuff like that.")
114 114
115(defvoo nntp-telnet-command "telnet" 115(defvoo nntp-telnet-command "telnet"
116 "*Telnet command used to connect to the nntp server. 116 "Telnet command used to connect to the nntp server.
117This command is used by the methods `nntp-open-telnet-stream', 117This command is used by the methods `nntp-open-telnet-stream',
118`nntp-open-via-rlogin-and-telnet' and `nntp-open-via-telnet-and-telnet'.") 118`nntp-open-via-rlogin-and-telnet' and `nntp-open-via-telnet-and-telnet'.")
119 119
120(defvoo nntp-telnet-switches '("-8") 120(defvoo nntp-telnet-switches '("-8")
121 "*Switches given to the telnet command `nntp-telnet-command'.") 121 "Switches given to the telnet command `nntp-telnet-command'.")
122 122
123(defvoo nntp-end-of-line "\r\n" 123(defvoo nntp-end-of-line "\r\n"
124 "*String to use on the end of lines when talking to the NNTP server. 124 "String to use on the end of lines when talking to the NNTP server.
125This is \"\\r\\n\" by default, but should be \"\\n\" when using an indirect 125This is \"\\r\\n\" by default, but should be \"\\n\" when using an indirect
126connection method (nntp-open-via-*).") 126connection method (nntp-open-via-*).")
127 127
128(defvoo nntp-via-rlogin-command "rsh" 128(defvoo nntp-via-rlogin-command "rsh"
129 "*Rlogin command used to connect to an intermediate host. 129 "Rlogin command used to connect to an intermediate host.
130This command is used by the methods `nntp-open-via-rlogin-and-telnet' 130This command is used by the methods `nntp-open-via-rlogin-and-telnet'
131and `nntp-open-via-rlogin-and-netcat'. The default is \"rsh\", but \"ssh\" 131and `nntp-open-via-rlogin-and-netcat'. The default is \"rsh\", but \"ssh\"
132is a popular alternative.") 132is a popular alternative.")
133 133
134(defvoo nntp-via-rlogin-command-switches nil 134(defvoo nntp-via-rlogin-command-switches nil
135 "*Switches given to the rlogin command `nntp-via-rlogin-command'. 135 "Switches given to the rlogin command `nntp-via-rlogin-command'.
136If you use \"ssh\" for `nntp-via-rlogin-command', you may set this to 136If you use \"ssh\" for `nntp-via-rlogin-command', you may set this to
137\(\"-C\") in order to compress all data connections, otherwise set this 137\(\"-C\") in order to compress all data connections, otherwise set this
138to \(\"-t\" \"-e\" \"none\") or (\"-C\" \"-t\" \"-e\" \"none\") if the telnet 138to \(\"-t\" \"-e\" \"none\") or (\"-C\" \"-t\" \"-e\" \"none\") if the telnet
139command requires a pseudo-tty allocation on an intermediate host.") 139command requires a pseudo-tty allocation on an intermediate host.")
140 140
141(defvoo nntp-via-telnet-command "telnet" 141(defvoo nntp-via-telnet-command "telnet"
142 "*Telnet command used to connect to an intermediate host. 142 "Telnet command used to connect to an intermediate host.
143This command is used by the `nntp-open-via-telnet-and-telnet' method.") 143This command is used by the `nntp-open-via-telnet-and-telnet' method.")
144 144
145(defvoo nntp-via-telnet-switches '("-8") 145(defvoo nntp-via-telnet-switches '("-8")
146 "*Switches given to the telnet command `nntp-via-telnet-command'.") 146 "Switches given to the telnet command `nntp-via-telnet-command'.")
147 147
148(defvoo nntp-netcat-command "nc" 148(defvoo nntp-netcat-command "nc"
149 "*Netcat command used to connect to the nntp server. 149 "Netcat command used to connect to the nntp server.
150This command is used by the `nntp-open-netcat-stream' and 150This command is used by the `nntp-open-netcat-stream' and
151`nntp-open-via-rlogin-and-netcat' methods.") 151`nntp-open-via-rlogin-and-netcat' methods.")
152 152
153(defvoo nntp-netcat-switches nil 153(defvoo nntp-netcat-switches nil
154 "*Switches given to the netcat command `nntp-netcat-command'.") 154 "Switches given to the netcat command `nntp-netcat-command'.")
155 155
156(defvoo nntp-via-user-name nil 156(defvoo nntp-via-user-name nil
157 "*User name to log in on an intermediate host with. 157 "User name to log in on an intermediate host with.
158This variable is used by the various nntp-open-via-* methods.") 158This variable is used by the various nntp-open-via-* methods.")
159 159
160(defvoo nntp-via-user-password nil 160(defvoo nntp-via-user-password nil
161 "*Password to use to log in on an intermediate host with. 161 "Password to use to log in on an intermediate host with.
162This variable is used by the `nntp-open-via-telnet-and-telnet' method.") 162This variable is used by the `nntp-open-via-telnet-and-telnet' method.")
163 163
164(defvoo nntp-via-address nil 164(defvoo nntp-via-address nil
165 "*Address of an intermediate host to connect to. 165 "Address of an intermediate host to connect to.
166This variable is used by the various nntp-open-via-* methods.") 166This variable is used by the various nntp-open-via-* methods.")
167 167
168(defvoo nntp-via-envuser nil 168(defvoo nntp-via-envuser nil
169 "*Whether both telnet client and server support the ENVIRON option. 169 "Whether both telnet client and server support the ENVIRON option.
170If non-nil, there will be no prompt for a login name.") 170If non-nil, there will be no prompt for a login name.")
171 171
172(defvoo nntp-via-shell-prompt "bash\\|[$>] *\r?$" 172(defvoo nntp-via-shell-prompt "bash\\|[$>] *\r?$"
173 "*Regular expression to match the shell prompt on an intermediate host. 173 "Regular expression to match the shell prompt on an intermediate host.
174This variable is used by the `nntp-open-via-telnet-and-telnet' method.") 174This variable is used by the `nntp-open-via-telnet-and-telnet' method.")
175 175
176(defvoo nntp-large-newsgroup 50 176(defvoo nntp-large-newsgroup 50
177 "*The number of articles which indicates a large newsgroup. 177 "The number of articles which indicates a large newsgroup.
178If the number of articles is greater than the value, verbose 178If the number of articles is greater than the value, verbose
179messages will be shown to indicate the current status.") 179messages will be shown to indicate the current status.")
180 180
181(defvoo nntp-maximum-request 400 181(defvoo nntp-maximum-request 400
182 "*The maximum number of the requests sent to the NNTP server at one time. 182 "The maximum number of the requests sent to the NNTP server at one time.
183If Emacs hangs up while retrieving headers, set the variable to a 183If Emacs hangs up while retrieving headers, set the variable to a
184lower value.") 184lower value.")
185 185
186(defvoo nntp-nov-is-evil nil 186(defvoo nntp-nov-is-evil nil
187 "*If non-nil, nntp will never attempt to use XOVER when talking to the server.") 187 "If non-nil, nntp will never attempt to use XOVER when talking to the server.")
188 188
189(defvoo nntp-xover-commands '("XOVER" "XOVERVIEW") 189(defvoo nntp-xover-commands '("XOVER" "XOVERVIEW")
190 "*List of strings that are used as commands to fetch NOV lines from a server. 190 "List of strings that are used as commands to fetch NOV lines from a server.
191The strings are tried in turn until a positive response is gotten. If 191The strings are tried in turn until a positive response is gotten. If
192none of the commands are successful, nntp will just grab headers one 192none of the commands are successful, nntp will just grab headers one
193by one.") 193by one.")
194 194
195(defvoo nntp-nov-gap 5 195(defvoo nntp-nov-gap 5
196 "*Maximum allowed gap between two articles. 196 "Maximum allowed gap between two articles.
197If the gap between two consecutive articles is bigger than this 197If the gap between two consecutive articles is bigger than this
198variable, split the XOVER request into two requests.") 198variable, split the XOVER request into two requests.")
199 199
200(defvoo nntp-xref-number-is-evil nil 200(defvoo nntp-xref-number-is-evil nil
201 "*If non-nil, Gnus never trusts article numbers in the Xref header. 201 "If non-nil, Gnus never trusts article numbers in the Xref header.
202Some news servers, e.g., ones running Diablo, run multiple engines 202Some news servers, e.g., ones running Diablo, run multiple engines
203having the same articles but article numbers are not kept synchronized 203having the same articles but article numbers are not kept synchronized
204between them. If you connect to such a server, set this to a non-nil 204between 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
206header and vary by which engine is chosen) to refer to articles.") 206header and vary by which engine is chosen) to refer to articles.")
207 207
208(defvoo nntp-prepare-server-hook nil 208(defvoo nntp-prepare-server-hook nil
209 "*Hook run before a server is opened. 209 "Hook run before a server is opened.
210If can be used to set up a server remotely, for instance. Say you 210If can be used to set up a server remotely, for instance. Say you
211have an account at the machine \"other.machine\". This machine has 211have an account at the machine \"other.machine\". This machine has
212access to an NNTP server that you can't access locally. You could 212access 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
237 237
238 238
239(defvoo nntp-connection-timeout nil 239(defvoo nntp-connection-timeout nil
240 "*Number of seconds to wait before an nntp connection times out. 240 "Number of seconds to wait before an nntp connection times out.
241If this variable is nil, which is the default, no timers are set.") 241If this variable is nil, which is the default, no timers are set.")
242 242
243(defvoo nntp-prepare-post-hook nil 243(defvoo nntp-prepare-post-hook nil
244 "*Hook run just before posting an article. It is supposed to be used 244 "Hook run just before posting an article. It is supposed to be used
245to insert Cancel-Lock headers.") 245to insert Cancel-Lock headers.")
246 246
247(defvoo nntp-server-list-active-group 'try 247(defvoo nntp-server-list-active-group 'try
@@ -1743,26 +1743,26 @@ If SEND-IF-FORCE, only send authinfo to the server if the
1743;; ========================================================================== 1743;; ==========================================================================
1744 1744
1745(defvoo nntp-open-telnet-envuser nil 1745(defvoo nntp-open-telnet-envuser nil
1746 "*If non-nil, telnet session (client and server both) will support the ENVIRON option and not prompt for login name.") 1746 "If non-nil, telnet session (client and server both) will support the ENVIRON option and not prompt for login name.")
1747 1747
1748(defvoo nntp-telnet-shell-prompt "bash\\|[$>] *\r?$" 1748(defvoo nntp-telnet-shell-prompt "bash\\|[$>] *\r?$"
1749 "*Regular expression to match the shell prompt on the remote machine.") 1749 "Regular expression to match the shell prompt on the remote machine.")
1750 1750
1751(defvoo nntp-rlogin-program "rsh" 1751(defvoo nntp-rlogin-program "rsh"
1752 "*Program used to log in on remote machines. 1752 "Program used to log in on remote machines.
1753The default is \"rsh\", but \"ssh\" is a popular alternative.") 1753The default is \"rsh\", but \"ssh\" is a popular alternative.")
1754 1754
1755(defvoo nntp-rlogin-parameters '("telnet" "-8" "${NNTPSERVER:=news}" "nntp") 1755(defvoo nntp-rlogin-parameters '("telnet" "-8" "${NNTPSERVER:=news}" "nntp")
1756 "*Parameters to `nntp-open-rlogin'. 1756 "Parameters to `nntp-open-rlogin'.
1757That function may be used as `nntp-open-connection-function'. In that 1757That function may be used as `nntp-open-connection-function'. In that
1758case, this list will be used as the parameter list given to rsh.") 1758case, this list will be used as the parameter list given to rsh.")
1759 1759
1760(defvoo nntp-rlogin-user-name nil 1760(defvoo nntp-rlogin-user-name nil
1761 "*User name on remote system when using the rlogin connect method.") 1761 "User name on remote system when using the rlogin connect method.")
1762 1762
1763(defvoo nntp-telnet-parameters 1763(defvoo nntp-telnet-parameters
1764 '("exec" "telnet" "-8" "${NNTPSERVER:=news}" "nntp") 1764 '("exec" "telnet" "-8" "${NNTPSERVER:=news}" "nntp")
1765 "*Parameters to `nntp-open-telnet'. 1765 "Parameters to `nntp-open-telnet'.
1766That function may be used as `nntp-open-connection-function'. In that 1766That function may be used as `nntp-open-connection-function'. In that
1767case, this list will be executed as a command after logging in 1767case, this list will be executed as a command after logging in
1768via telnet.") 1768via telnet.")