From 7681a57b88a91bf9eedc890b974df9728d5eb50d Mon Sep 17 00:00:00 2001 From: Mauro Aranda Date: Sat, 18 May 2019 17:35:04 -0300 Subject: Remove redundants "See" before @xref or @pxref (Bug#35793) * doc/lispref/control.texi (Control Structures): * doc/lispref/modes.texi (Search-based Fontification): * doc/misc/cc-mode.texi (Filling and Line Breaking Commands) (Auto-newline Insertion, Other Special Indentations): * doc/misc/dbus.texi (Errors and Events): * doc/misc/dired-x.texi (Find File At Point): * doc/misc/eudc.texi (Display of Query Results, Inline Query Expansion): * doc/misc/gnus-faq.texi (FAQ 3-11): * doc/misc/gnus.texi (Group Parameters, Posting Styles) (Spam Package Introduction): * doc/misc/org.texi (LaTeX fragments, Previewing LaTeX fragments): * doc/misc/reftex.texi (Commands): Remove redundant "See" before cross references. * doc/lispref/functions.texi (Function Safety): Redundant "see" is in ignored text, but remove it anyway. * doc/lispref/positions.texi (Skipping Characters): Remove redundant "See" before cross references. Change @xref to @pxref, which is more suitable when at the end of a sentence. Most of the redundants "See" found by Noam Postavsky. --- doc/lispref/control.texi | 2 +- doc/lispref/functions.texi | 2 +- doc/lispref/modes.texi | 2 +- doc/lispref/positions.texi | 4 ++-- doc/misc/cc-mode.texi | 6 +++--- doc/misc/dbus.texi | 4 ++-- doc/misc/dired-x.texi | 4 ++-- doc/misc/eudc.texi | 4 ++-- doc/misc/gnus-faq.texi | 2 +- doc/misc/gnus.texi | 6 +++--- doc/misc/org.texi | 4 ++-- doc/misc/reftex.texi | 2 +- 12 files changed, 21 insertions(+), 21 deletions(-) (limited to 'doc') diff --git a/doc/lispref/control.texi b/doc/lispref/control.texi index 3ffe8f7fb9d..9e27e1a751a 100644 --- a/doc/lispref/control.texi +++ b/doc/lispref/control.texi @@ -1452,7 +1452,7 @@ Run @var{body} with @var{var} bound to each value that @end defmac The Common Lisp loop facility also contains features for working with -iterators. See @xref{Loop Facility,,,cl,Common Lisp Extensions}. +iterators. @xref{Loop Facility,,,cl,Common Lisp Extensions}. The following piece of code demonstrates some important principles of working with iterators. diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi index f641fe7024a..0077fad8375 100644 --- a/doc/lispref/functions.texi +++ b/doc/lispref/functions.texi @@ -2369,7 +2369,7 @@ safe. A form that creates temporary bindings (@code{condition-case}, @code{dolist}, @code{dotimes}, @code{lambda}, @code{let}, or @code{let*}), if all args are safe and the symbols to be bound are not -explicitly risky (see @pxref{File Local Variables}). +explicitly risky (@pxref{File Local Variables}). @item An assignment using @code{add-to-list}, @code{setq}, @code{push}, or @code{pop}, if all args are safe and the symbols to be assigned are diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 0ff13d72e2f..e8a8eb35e97 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -2977,7 +2977,7 @@ Its value should have one of the forms described in this table. @strong{Warning:} Do not design an element of @code{font-lock-keywords} to match text which spans lines; this does not work reliably. -For details, see @xref{Multiline Font Lock}. +For details, @pxref{Multiline Font Lock}. You can use @var{case-fold} in @code{font-lock-defaults} to specify the value of @code{font-lock-keywords-case-fold-search} which says diff --git a/doc/lispref/positions.texi b/doc/lispref/positions.texi index 527a3ab420c..77077934673 100644 --- a/doc/lispref/positions.texi +++ b/doc/lispref/positions.texi @@ -840,8 +840,8 @@ The argument @var{character-set} is a string, like the inside of a terminate it, and @samp{\} quotes @samp{^}, @samp{-} or @samp{\}. Thus, @code{"a-zA-Z"} skips over all letters, stopping before the first nonletter, and @code{"^a-zA-Z"} skips nonletters stopping before -the first letter. See @xref{Regular Expressions}. Character classes -can also be used, e.g., @code{"[:alnum:]"}. See @pxref{Char Classes}. +the first letter (@pxref{Regular Expressions}). Character classes +can also be used, e.g., @code{"[:alnum:]"} (@pxref{Char Classes}). If @var{limit} is supplied (it must be a number or a marker), it specifies the maximum position in the buffer that point can be skipped diff --git a/doc/misc/cc-mode.texi b/doc/misc/cc-mode.texi index 0102a4ace87..bdeff22693f 100644 --- a/doc/misc/cc-mode.texi +++ b/doc/misc/cc-mode.texi @@ -1060,7 +1060,7 @@ there's a piece of normal text without having to think much about it. and so on. You can configure the exact way comments get filled and broken, and -where Emacs does auto-filling (see @pxref{Custom Filling and +where Emacs does auto-filling (@pxref{Custom Filling and Breaking}). Typically, the style system (@pxref{Styles}) will have set this up for you, so you probably won't have to bother. @@ -1478,7 +1478,7 @@ normal, with no @kbd{C-u} prefix). @end itemize You can configure the precise circumstances in which newlines get -inserted (see @pxref{Custom Auto-newlines}). Typically, the style +inserted (@pxref{Custom Auto-newlines}). Typically, the style system (@pxref{Styles}) will have set this up for you, so you probably won't have to bother. @@ -6731,7 +6731,7 @@ custom line-up function associated with it. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! To configure macros which you invoke without a terminating @samp{;}, -see @xref{Macros with ;}. +@pxref{Macros with ;}. Here are the remaining odds and ends regarding indentation: diff --git a/doc/misc/dbus.texi b/doc/misc/dbus.texi index c7d499884da..7c7612f579c 100644 --- a/doc/misc/dbus.texi +++ b/doc/misc/dbus.texi @@ -1928,7 +1928,7 @@ This executes @var{forms} exactly like a @code{progn}, except that errors can be made visible when @code{dbus-debug} is set to @code{t}. @end defspec -Incoming D-Bus messages are handled as Emacs events, see @pxref{Misc +Incoming D-Bus messages are handled as Emacs events, @pxref{Misc Events, , , elisp}. They are retrieved only, when Emacs runs in interactive mode. The generated event has this form: @@ -1952,7 +1952,7 @@ of the D-Bus object emitting the message. @var{interface} and @var{member} denote the message which has been sent. @var{handler} is the callback function which has been registered for -this message (see @pxref{Signals}). When a @code{dbus-event} event +this message (@pxref{Signals}). When a @code{dbus-event} event arrives, @var{handler} is called with @var{args} as arguments. In order to inspect the @code{dbus-event} data, you could extend the diff --git a/doc/misc/dired-x.texi b/doc/misc/dired-x.texi index c2630e6be66..b8e1ad459d1 100644 --- a/doc/misc/dired-x.texi +++ b/doc/misc/dired-x.texi @@ -968,7 +968,7 @@ should not bind @code{dired-x-find-file-other-window} over @code{find-file-other-window}. If you change this variable after @file{dired-x.el} is loaded then do @kbd{M-x dired-x-bind-find-file}. The default value of this variable is @code{t}; by default, the binding is not -done. See @xref{Optional Installation File At Point}. +done. @xref{Optional Installation File At Point}. @item dired-x-bind-find-file @findex dired-x-bind-find-file @@ -976,7 +976,7 @@ A function, which can be called interactively or in your @file{~/.emacs} file, that uses the value of @code{dired-x-hands-off-my-keys} to determine if @code{dired-x-find-file} should be bound over @code{find-file} and @code{dired-x-find-file-other-window} bound over -@code{find-file-other-window}. See @xref{Optional Installation File At Point}. +@code{find-file-other-window}. @xref{Optional Installation File At Point}. @end table @node Miscellaneous Commands diff --git a/doc/misc/eudc.texi b/doc/misc/eudc.texi index 117b62e9ac8..568f94ba7c1 100644 --- a/doc/misc/eudc.texi +++ b/doc/misc/eudc.texi @@ -606,7 +606,7 @@ function that will be passed the corresponding attribute values for display. @end defvar -This variable has protocol-local definitions (see @pxref{Server/Protocol +This variable has protocol-local definitions (@pxref{Server/Protocol Locals}). For instance, it is defined as follows for LDAP: @lisp @@ -714,7 +714,7 @@ name and the remaining words are all considered as surname constituents. @var{format}s are in fact not limited to EUDC attribute names, you can use server or protocol specific names in them. It may be safer if you do so, to set the variable @code{eudc-inline-query-format} in a protocol -or server local fashion (see @pxref{Server/Protocol Locals}). +or server local fashion (@pxref{Server/Protocol Locals}). For instance you could use the following to match up to three words against the @code{cn} attribute of LDAP servers: diff --git a/doc/misc/gnus-faq.texi b/doc/misc/gnus-faq.texi index d4be7b1f0ce..bc0357144dc 100644 --- a/doc/misc/gnus-faq.texi +++ b/doc/misc/gnus-faq.texi @@ -707,7 +707,7 @@ retrieves via POP3? Yes, if the POP3 server supports the UIDL control (maybe almost servers do it nowadays). To do that, add a @code{:leave VALUE} pair to each -POP3 mail source. See @pxref{Mail Source Specifiers} for VALUE. +POP3 mail source. @xref{Mail Source Specifiers}, for details on VALUE. @node FAQ 4 - Reading messages @subsection Reading messages diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi index 4ee80eacb2e..0d4cf970848 100644 --- a/doc/misc/gnus.texi +++ b/doc/misc/gnus.texi @@ -3096,7 +3096,7 @@ You can also use regexp expansions in the rules: (sieve header :regex "list-id" "") @end example -See @pxref{Sieve Commands} for commands and variables that might be of +@xref{Sieve Commands}, for commands and variables that might be of interest in relation to the sieve parameter. The Sieve language is described in RFC 3028. @xref{Top, Emacs Sieve, @@ -12837,7 +12837,7 @@ In the case of a string value, if the @code{match} is a regular expression, or if it takes the form @code{(header @var{match} @var{regexp})}, a @samp{gnus-match-substitute-replacement} is proceed on the value to replace the positional parameters @samp{\@var{n}} by -the corresponding parenthetical matches (see @xref{Replacing Match,, +the corresponding parenthetical matches (@pxref{Replacing Match,, Replacing the Text that Matched, elisp, The Emacs Lisp Reference Manual}.) @@ -24197,7 +24197,7 @@ You must read this section to understand how the Spam package works. Do not skip, speed-read, or glance through this section. Make sure you read the section on the @code{spam.el} sequence of -events. See @xref{Extending the Spam package}. +events. @xref{Extending the Spam package}. @cindex spam-initialize @vindex spam-use-stat diff --git a/doc/misc/org.texi b/doc/misc/org.texi index 2be2707d95e..b3c0d52db1b 100644 --- a/doc/misc/org.texi +++ b/doc/misc/org.texi @@ -10292,7 +10292,7 @@ Org mode can contain @LaTeX{} math fragments, and it supports ways to process these for several export back-ends. When exporting to @LaTeX{}, the code is left as it is. When exporting to HTML, Org can use either @uref{http://www.mathjax.org, MathJax} (@pxref{Math formatting in HTML -export}) or transcode the math into images (see @pxref{Previewing @LaTeX{} +export}) or transcode the math into images (@pxref{Previewing @LaTeX{} fragments}). @LaTeX{} fragments don't need any special marking at all. The following @@ -10358,7 +10358,7 @@ or @file{convert} installed@footnote{These are respectively available at and from the @file{imagemagick} suite. Choose the converter by setting the variable @code{org-preview-latex-default-process} accordingly.}, @LaTeX{} fragments can be processed to produce images of the typeset expressions to be -used for inclusion while exporting to HTML (see @pxref{@LaTeX{} fragments}), +used for inclusion while exporting to HTML (@pxref{@LaTeX{} fragments}), or for inline previewing within Org mode. @vindex org-format-latex-options diff --git a/doc/misc/reftex.texi b/doc/misc/reftex.texi index baa8de4b4dc..8221abdbbaa 100644 --- a/doc/misc/reftex.texi +++ b/doc/misc/reftex.texi @@ -3697,7 +3697,7 @@ MicroEmacs at the time). Here is a summary of @RefTeX{}'s commands which can be executed from @LaTeX{} files. Command which are executed from the special buffers are not described here. All commands are available from the @code{Ref} -menu. See @xref{Key Bindings}. +menu. @xref{Key Bindings}. @deffn Command reftex-toc Show the table of contents for the current document. When called with -- cgit v1.2.1 From 8f18d121210aa27dc05555140ab21a8489f0de50 Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Sat, 25 May 2019 22:10:00 +0300 Subject: Improve documentation of decoding into a unibyte buffer * doc/lispref/nonascii.texi (Explicit Encoding): Document what happens when DESTINATION of decoding is a unibyte buffer. * src/coding.c (Fdecode_coding_region) (Fdecode_coding_string): Document what happens if DESTINATION is a unibyte buffer. --- doc/lispref/nonascii.texi | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/lispref/nonascii.texi b/doc/lispref/nonascii.texi index df4f2932c6e..4e6bf12db92 100644 --- a/doc/lispref/nonascii.texi +++ b/doc/lispref/nonascii.texi @@ -1912,7 +1912,10 @@ the command returns the decoded text as a multibyte string without inserting it. If decoded text is inserted in some buffer, this command returns the -length of the decoded text. +length of the decoded text. If that buffer is a unibyte buffer +(@pxref{Selecting a Representations}), the internal representation of +the decoded text (@pxref{Text Representations}) is inserted into the +buffer as individual bytes. This command puts a @code{charset} text property on the decoded text. The value of the property states the character set used to decode the @@ -1931,7 +1934,9 @@ contains 8-bit bytes in their multibyte form). If optional argument @var{buffer} specifies a buffer, the decoded text is inserted in that buffer after point (point does not move). In this -case, the return value is the length of the decoded text. +case, the return value is the length of the decoded text. If that +buffer is a unibyte buffer, the internal representation of the decoded +text is inserted into it as individual bytes. @cindex @code{charset}, text property This function puts a @code{charset} text property on the decoded text. -- cgit v1.2.1 From 2168165ec05aa663d41998adb518e778899a8edd Mon Sep 17 00:00:00 2001 From: Noam Postavsky Date: Sun, 26 May 2019 08:46:15 -0400 Subject: ; * doc/lispref/nonascii.texi (Explicit Encoding): Fix typo. --- doc/lispref/nonascii.texi | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/lispref/nonascii.texi b/doc/lispref/nonascii.texi index 4e6bf12db92..d2eb2cb0728 100644 --- a/doc/lispref/nonascii.texi +++ b/doc/lispref/nonascii.texi @@ -1913,7 +1913,7 @@ inserting it. If decoded text is inserted in some buffer, this command returns the length of the decoded text. If that buffer is a unibyte buffer -(@pxref{Selecting a Representations}), the internal representation of +(@pxref{Selecting a Representation}), the internal representation of the decoded text (@pxref{Text Representations}) is inserted into the buffer as individual bytes. -- cgit v1.2.1