1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-01-25 19:11:56 +00:00
Commit Graph

2801 Commits

Author SHA1 Message Date
Eli Zaretskii
6bdcaec885 Fix typos and minor wording issues in ELisp manual
* doc/lispref/internals.texi (Writing Emacs Primitives):
* doc/lispref/display.texi (Temporary Displays): Fix typos.
* doc/lispref/text.texi (Filling, Changing Properties)
(Transposition): Clarify and fix typos.
* doc/lispref/positions.texi (Screen Lines): Improve wording.
* doc/lispref/modes.texi (Minor Mode Conventions)
(Font Lock Multiline): Fix typos.
* doc/lispref/variables.texi (Dynamic Binding Tips): Fix a
cross-reference.  Fix a typo.
* doc/lispref/sequences.texi (Sequence Functions): Fix typos.
(Bug#31143)
2018-04-13 16:44:05 +03:00
Eli Zaretskii
3a798f696b Fix a minor mistake in the ELisp manual
* doc/lispref/files.texi (Reading from Files): Fix copy/paste
mistake.  (Bug#31107)
2018-04-09 17:53:37 +03:00
Eli Zaretskii
1527235baf ; * doc/lispref/compile.texi (Compilation Functions): Fix wording. 2018-04-02 20:25:52 +03:00
Tino Calancha
b07decdf02 ; * doc/lispref/compile.texi (Compilation Functions): Fix typo 2018-04-03 00:43:25 +09:00
Eli Zaretskii
9fee1b8fb3 Minor copyedits of completion-at-point-functions documentation
* lisp/minibuffer.el (completion-at-point-functions):
* doc/lispref/minibuf.texi (Completion in Buffers): Fix wording
and filling.

(cherry picked from commit a8ddd05d7d)
2018-04-01 12:22:39 +03:00
Stefan Monnier
748f0fdd5a (completion-at-point-functions): Improve doc
(cherry picked from commit b56c56f203)
2018-04-01 12:21:29 +03:00
Noam Postavsky
e50196e8a9 Document return value of pcase (Bug#30425)
* doc/lispref/control.texi (Pattern matching case statement):
* lisp/emacs-lisp/pcase.el (pcase): State that pcase returns nil if no
patterns match.
(pcase-exhaustive): State that an error is signaled if no patterns
match.
2018-03-31 00:50:37 -04:00
Eli Zaretskii
930f7b10b3 * doc/lispref/functions.texi (Defining Functions): Improve indexing. 2018-03-26 18:58:20 +03:00
Glenn Morris
7d6c7d0b46 ; Use GNU not Gnu in docs 2018-03-23 16:01:12 -04:00
Noam Postavsky
10b1f2fdd5 Explain more about (defvar foo) form (Bug#18059)
* doc/lispref/variables.texi (Defining Variables)
(Using Lexical Binding):
* doc/lispref/compile.texi (Compiler Errors): Emphasize that omitting
VALUE for `defvar' marks the variable special only locally.
* doc/lispref/variables.texi (Using Lexical Binding): Add example of
using `defvar' without VALUE.
2018-03-23 08:19:09 -04:00
Charles A. Roelli
68c2f336b1 * doc/lispref/buffers.texi (Buffer List): Fix grammar. 2018-03-22 20:43:42 +01:00
Charles A. Roelli
7e720c6851 * doc/lispref/anti.texi (Antinews): Fix grammar. 2018-03-22 20:40:02 +01:00
Eli Zaretskii
8ac621bb55 Document DEFUN attributes
* doc/lispref/internals.texi (Writing Emacs Primitives): Document
specification of function attributes in DEFUN.
2018-03-22 14:57:43 +02:00
Glenn Morris
5268f3059d * doc/lispref/windows.texi (Selecting Windows): Fix a typo. 2018-03-21 16:58:11 -04:00
Charles A. Roelli
143b485029 * doc/lispref/internals.texi (Writing Emacs Primitives): Fix grammar. 2018-03-21 20:52:35 +01:00
Alan Mackenzie
4ab4551470 Firm up documentation of generalized variables
* doc/lispref/variables.texi (Generalized Variables)
(Setting Generalized Variables): Define a generalized variable as something
setf can write to.  Remove the insinuation that hackers have poor memories.
State explicitly that the list of GVs given is complete.  Remove the
suggestion that `setf' has superseded, or is in the process of superseding,
`setq'.  Make minor corrections to the English.
2018-03-21 17:36:34 +00:00
Nick Helm
2fb52abd9e Improve documentation of 'with-help-window'
* doc/lispref/help.texi (Help Functions): Change variable name
to 'buffer-or-name'.

* lisp/help.el (with-help-window): Change variable name to
'buffer-or-name' and rewrite the doc string, adding reference
to 'help-window-setup'.  (Bug#30792)
2018-03-20 14:19:14 +02:00
Noam Postavsky
10bd3b3af8 Improve word motion docs (Bug#30815)
* doc/lispref/positions.texi (Word Motion): Fix reference to
`char-script-table'.
* lisp/simple.el (backward-word):
* src/syntax.c (forward-word): Mention `char-script-table' and add
link to the 'Word Motion' manual section.
2018-03-16 19:51:28 -04:00
Michael Albinus
2b8507fbdc Replace "carriage-return" by "carriage return" in manuals
* doc/emacs/msdos.texi:
* doc/emacs/mule.texi:
* doc/emacs/screen.texi:
* doc/lispref/nonascii.texi:
* doc/misc/calc.texi: Replace "carriage-return" by "carriage
return".  Suggested by Richard Stallman <rms@gnu.org> in
emacs-manual-bugs@gnu.org.
2018-03-15 10:56:08 +01:00
Charles A. Roelli
df0e7e2b9e Improve SVG documentation
* doc/lispref/display.texi (ImageMagick Images): Remove an
outdated comment that references a fixed bug.
(SVG Images): Fix grammar, and call functions functions (there are
no commands in lisp/svg.el).
2018-03-10 19:19:27 +01:00
Eli Zaretskii
a34ef52964 Document the "URL" keyword in library headers
* doc/lispref/tips.texi (Library Headers): "URL" is an alias for
"Homepage".  Suggested by Peter Oliver <p.d.oliver@mavit.org.uk>.
(Bug#30571)
2018-03-10 13:57:33 +02:00
Eli Zaretskii
317da2ace5 Minor improvements in manuals
* doc/lispref/variables.texi (Local Variables): Make more clear
that local bindings of 'let' are in effect only within the body.
Suggested by Marcin Borkowski <mbork@mbork.pl>, see
http://lists.gnu.org/archive/html/emacs-devel/2018-03/msg00217.html
for the details.

* doc/emacs/programs.texi (Matching): Fix a typo.  Reported by
Alex Branham <alex.branham@gmail.com> in emacs-manual-bugs@gnu.org.
Improve indexing.
2018-03-07 21:51:59 +02:00
Michael Albinus
304278c040 Further improvements on manuals
* doc/emacs/xresources.texi:
* doc/lispref/display.texi:
* doc/lispref/keymaps.texi:
* doc/misc/dbus.texi:
* doc/misc/efaq-w32.texi: Use "GTK+" where applicable.

* doc/emacs/xresources.texi (Resources): Mention several use
of "-xrm".
(Table of Resources) [verticalScrollBars]: Add reference to Scroll Bars.
2018-03-01 09:25:55 +01:00
Glenn Morris
fd50238748 * doc/lispref/streams.texi (Output Variables): Fix previous. 2018-02-28 12:35:44 -05:00
Paul Eggert
5e69219fda Document print-escape-control-characters
* doc/lispref/streams.texi, etc/NEWS: Add doc.
2018-02-27 20:13:37 -08:00
Michael Albinus
7a069f35d4 Fix @kindex entries in manuals
* doc/emacs/basic.texi:
* doc/emacs/buffers.texi:
* doc/emacs/building.texi:
* doc/emacs/calendar.texi:
* doc/emacs/custom.texi:
* doc/emacs/dired.texi:
* doc/emacs/display.texi:
* doc/emacs/files.texi:
* doc/emacs/frames.texi:
* doc/emacs/help.texi:
* doc/emacs/indent.texi:
* doc/emacs/killing.texi:
* doc/emacs/kmacro.texi:
* doc/emacs/mark.texi:
* doc/emacs/mini.texi:
* doc/emacs/misc.texi:
* doc/emacs/modes.texi:
* doc/emacs/msdos-xtra.texi:
* doc/emacs/msdos.texi:
* doc/emacs/mule.texi:
* doc/emacs/picture-xtra.texi:
* doc/emacs/programs.texi:
* doc/emacs/regs.texi:
* doc/emacs/rmail.texi:
* doc/emacs/screen.texi:
* doc/emacs/search.texi:
* doc/emacs/sending.texi:
* doc/emacs/text.texi:
* doc/emacs/trouble.texi:
* doc/lispref/files.texi:
* doc/misc/calc.texi:
* doc/misc/cc-mode.texi:
* doc/misc/ediff.texi:
* doc/misc/epa.texi:
* doc/misc/ert.texi:
* doc/misc/eww.texi:
* doc/misc/forms.texi:
* doc/misc/gnus.texi:
* doc/misc/info.texi:
* doc/misc/mairix-el.texi:
* doc/misc/message.texi:
* doc/misc/mh-e.texi:
* doc/misc/newsticker.texi:
* doc/misc/org.texi:
* doc/misc/pcl-cvs.texi:
* doc/misc/rcirc.texi:
* doc/misc/sc.texi:
* doc/misc/sieve.texi:
* doc/misc/vhdl-mode.texi:
* doc/misc/vip.texi:
* doc/misc/viper.texi:
* doc/misc/woman.texi: Fix @kindex entries.  Mark keys consistently.
2018-02-25 16:29:39 +01:00
Michael Albinus
621893352f Fix @cindex entries in manuals
* doc/emacs/custom.texi:
* doc/emacs/dired.texi:
* doc/emacs/display.texi:
* doc/emacs/files.texi:
* doc/emacs/frames.texi:
* doc/emacs/killing.texi:
* doc/emacs/maintaining.texi:
* doc/emacs/misc.texi:
* doc/emacs/msdos-xtra.texi:
* doc/emacs/msdos.texi:
* doc/emacs/search.texi:
* doc/emacs/text.texi:
* doc/emacs/trouble.texi:
* doc/lispintro/emacs-lisp-intro.texi:
* doc/lispref/strings.texi:
* doc/lispref/text.texi:
* doc/misc/cc-mode.texi:
* doc/misc/efaq.texi:
* doc/misc/eieio.texi:
* doc/misc/emacs-mime.texi:
* doc/misc/gnus.texi:
* doc/misc/htmlfontify.texi:
* doc/misc/idlwave.texi:
* doc/misc/message.texi:
* doc/misc/mh-e.texi:
* doc/misc/sem-user.texi:
* doc/misc/ses.texi:
* doc/misc/tramp.texi:
* doc/misc/vhdl-mode.texi: Fix @cindex entries.
2018-02-24 20:52:21 +01:00
Paul Eggert
8a73b80aa4 Minor doc fixes, mostly for timestamp issues 2018-02-23 11:52:18 -08:00
Michael Albinus
2dc24d5536 Fix @findex and @vindex entries in manuals
* doc/emacs/building.texi:
* doc/emacs/calendar.texi:
* doc/emacs/cmdargs.texi:
* doc/emacs/mini.texi:
* doc/emacs/misc.texi:
* doc/emacs/trouble.texi:
* doc/emacs/windows.texi:
* doc/lispintro/emacs-lisp-intro.texi:
* doc/lispref/edebug.texi:
* doc/lispref/frames.texi:
* doc/lispref/os.texi:
* doc/lispref/windows.texi:
* doc/misc/cc-mode.texi:
* doc/misc/dired-x.texi:
* doc/misc/ediff.texi:
* doc/misc/mh-e.texi:
* doc/misc/pcl-cvs.texi:
* doc/misc/reftex.texi:
* doc/misc/sc.texi:
* doc/misc/vhdl-mode.texi:
* doc/misc/viper.texi: Fix @findex and @vindex entries.
2018-02-23 15:30:19 +01:00
Alan Mackenzie
76f5242838 Document, in the Elisp manual, how to get a character's raw syntax descriptor
* doc/lispref/syntax.texi (Syntax Table internals): mention the use of `aref'
to get a character's raw syntax descriptor.
2018-02-22 18:25:13 +00:00
Robert Pluim
05214c65a3 Correct variable markup in manuals
* doc/lispref/minibuf.texi (Completion in Buffers): Fix markup.
* doc/lispref/text.texi (Filling): Likewise.
* doc/misc/dired-x.texi (Advanced Mark Commands): Likewise.
* doc/misc/epa.texi (Encrypting/decrypting gpg files): Likewise.
(Encrypting/decrypting gpg files): Likewise.
* doc/misc/tramp.texi (External methods): Likewise.
(Default Method): Likewise.
* doc/misc/viper.texi (Editing in Insert State): Likewise.
(File and Buffer Handling): Likewise.
* doc/misc/gnus.texi (Mail Source Customization): Likewise.
* doc/misc/url.texi (Customization): Likewise.  Note obsolete
status of url-temporary-directory.
2018-02-20 21:15:19 +02:00
Eli Zaretskii
d8917eba1c Improve documentation of Profiling features
* doc/lispref/debugging.texi (Profiling): Improve the description
of elp.el.  Improve wording of the rest of the section.  (Bug#30491)

* lisp/emacs-lisp/elp.el (elp-instrument-list): Make the
interactive invocation work.  Doc fix.
2018-02-17 11:59:36 +02:00
Eli Zaretskii
b228839af1 Improve indexing of "performance" in ELisp manual
* doc/lispref/debugging.texi (Profiling):
* doc/lispref/edebug.texi (Coverage Testing): Improve indexing of
features useful for performance analysis.  (Bug#30490)
2018-02-17 11:16:35 +02:00
Glenn Morris
69107f347b ; Fix doc typos related to indefinite articles 2018-02-16 17:33:57 -05:00
Glenn Morris
35e5c57db3 ; Fix doc typos related to indefinite articles 2018-02-16 14:11:51 -05:00
Eli Zaretskii
53511f9147 Another set of changes for the manual
* doc/emacs/programs.texi (Program Indent): Add a cross-reference
to elisp's description of 'pp'.
(Program Modes): Add a few more programming modes.  Add index
entries.
(Basic Indent, Multi-line Indent, C Indent, Comment Commands)
(Manipulating Comments): Fix markup of keyboard commands.
* doc/emacs/search.texi (Regexps): Add an example with non-ASCII
characters.  Suggested by Michael Albinus <michael.albinus@gmx.de>
in emacs-manual-bugs@gnu.org.

* doc/lispref/display.texi (Display Tables): Fix the description
of the 5th extra slot of the display table.  (Bug#13473)

* doc/emacs/regs.texi (Registers): Simplify wording.

* doc/emacs/custom.texi (Init Non-ASCII): Remove outdated text
about perils of encoded keyboard input.
2018-02-14 21:00:59 +02:00
Michael Albinus
8f7d718499 * doc/lispref/anti.texi (Antinews): Replace 25.2 with 25.3. 2018-02-09 13:04:12 +01:00
Eli Zaretskii
989d0afce9 Improve documentation of mini-window resizing
* doc/lispref/minibuf.texi (Minibuffer Windows): Mention
'message-truncate-lines' for preventing resizing of minibuffer
windows.  (Bug#19045)
(Minibuffer Misc): Remove redundant description of
'max-mini-window-height'.
* doc/lispref/display.texi (Echo Area Customization): Adjust
cross-reference.
2018-02-09 12:28:59 +02:00
Noam Postavsky
2dd273b985 Mention that shell quoting of % on w32 may fail (Bug#19350)
* doc/lispref/os.texi (Security Considerations): Mention that quoting
of '%' assumes no '^' in variable names.
* test/lisp/subr-tests.el (shell-quote-argument-%-on-w32): New test,
demonstrating what doesn't work.
2018-02-08 19:10:11 -05:00
Paul Eggert
979944c9b0 * doc/lispref/anti.texi (Antinews): Add some more antinews. 2018-02-08 15:59:19 -08:00
Noam Postavsky
04c5bd5b1f Doc fixes for process functions (Bug#30349)
* doc/lispref/processes.texi (Asynchronous Processes): Explain what
the 'stopped' state means for a pipe process.
* src/process.c (Fmake_process, Fmake_pipe_process)
(Fmake_serial_process, Fmake_network_process):
* lisp/subr.el (start-process):
* lisp/net/tls.el (open-tls-stream):
* lisp/net/starttls.el (starttls-open-stream):
* lisp/net/gnutls.el (open-gnutls-stream): Remove meaningless phrase
"specify an output stream" phrase from docstring.
2018-02-07 20:17:50 -05:00
Eli Zaretskii
5fe81923e5 Yet another round of improvements in the manual
* doc/emacs/misc.texi (Document View): Improve wording.  Reported
by lyr3 <lyr3@protonmail.com> in emacs-manual-bugs@gnu.org.

* doc/emacs/files.texi (Recover): Fix a typo.  Reported by Jorge
<jorge+list@disroot.org> in emacs-manual-bugs@gnu.org.

* doc/emacs/anti.texi (Antinews): Fix typos.  Reported by Justin
Heyes-Jones <justinhj@gmail.com> in emacs-manual-bugs@gnu.org.

* doc/emacs/mini.texi (Basic Minibuffer): Clarify wording.
Reported by Vivishek Sudhir <vivishek.sudhir@gmail.com> in
emacs-manual-bugs@gnu.org.

* doc/emacs/cmdargs.texi (MS-Windows Registry): Improve wording
regarding registry keys.

* doc/emacs/macos.texi (Mac OS / GNUstep): Sayu "NeXT Inc."
Reported by Cena Mayo <cenazoic@gmail.com> in
emacs-manual-bugs@gnu.org.

* doc/emacs/screen.texi (Screen): More accurate wording.
Suggested by Miloš Polakovič <milos@alphamail.org> in
emacs-manual-bugs@gnu.org.

* doc/emacs/indent.texi (Just Spaces): Minor wording change.
Suggested by David Bonnafous <dbonnafo@gmail.com> in
emacs-manual-bugs@gnu.org.

* doc/emacs/text.texi (TeX Mode, TeX Editing): Improve and
simplify wording.  Suggested by root@vxid.pw <root@vxid.pw> in
emacs-manual-bugs@gnu.org.

* doc/emacs/cmdargs.texi (Window Size X): Minor wording change.

* doc/emacs/display.texi (Highlight Interactively): Fill text.
(Optional Mode Line): Fix typos.  Suggested by Alberto Sartori
<alberto.sartori@sissa.it> in emacs-manual-bugs@gnu.org.

* doc/emacs/building.texi (Debugger Operation): Clarify wording.

* doc/emacs/files.texi (Directories, Comparing Files, Diff Mode)
(Remote Files, File Names, Visiting, Backup Deletion)
(Customize Save, Interlocking): Improve wording and accuracy of
the text.
* doc/emacs/maintaining.texi (VC With A Merging VCS): Don't say
"his".
* doc/emacs/arevert-xtra.texi (Auto Reverting Dired): Minor
wording changes.
(Supporting additional buffers): Moved to ...
* doc/lispref/backups.texi (Reverting): ... here.
* doc/emacs/emacs.texi (Top): Remove "Supporting additional
buffers" from master menu.
* doc/emacs/files.texi (Reverting): Mention use of file
notifications.  Suggested by Michael Albinus
<michael.albinus@gmx.de> in emacs-manual-bugs@gnu.org.

* doc/emacs/rmail.texi (Rmail Motion): Clarify what '-' does to
'M-s'.  Suggested by Arthur Milchior <arthur@milchior.fr> in
emacs-manual-bugs@gnu.org.

* doc/emacs/cmdargs.texi (Initial Options): Capitalize "Emacs".
(Action Arguments): Fix a typo.
(Emacs Invocation): Replace em-dash with a comma.  Suggested by
Justin Heyes-Jones <justinhj@gmail.com> in
emacs-manual-bugs@gnu.org.

* doc/emacs/m-x.texi (M-x): Add an example.  Suggested by Alberto
Sartori <alberto.sartori@sissa.it> in emacs-manual-bugs@gnu.org.

* doc/emacs/calendar.texi (Calendar/Diary, Calendar Unit Motion):
Minor wording changes.
2018-02-07 22:24:13 +02:00
Basil L. Contovounesios
59344c43a9 * doc/lispref/customize.texi (Custom Themes): Clarify .el preference.
Copyright-paperwork-exempt: yes

https://lists.gnu.org/archive/html/emacs-devel/2018-01/msg00824.html.
2018-02-02 09:22:53 -05:00
Noam Postavsky
e21f0189f3 * doc/lispref/functions.texi (Inline Functions): Fix typo (Bug#30238). 2018-02-01 19:26:40 -05:00
Eli Zaretskii
b90e91ca54 Fix last change of @key markup
* doc/lispref/display.texi (Specified Space):
* doc/emacs/programs.texi (C Modes):
* doc/emacs/killing.texi (Rectangles):
* doc/emacs/emacs.texi (Top):
* doc/emacs/display.texi (Useless Whitespace): Don't use @key
markup for characters and commands, only for keys.
2018-02-01 19:56:51 +02:00
Michael Albinus
56c37bbdb6 Use @key{} where it is missing in the manuals 2018-01-31 19:59:12 +01:00
Martin Rudalics
59657c482d Document 'window-at-side-p' in the Elisp manual
* doc/lispref/windows.texi (Windows and Frames): Document
'window-at-side-p'.
2018-01-31 09:35:15 +01:00
Noam Postavsky
2b35ed0b0c Document external-debugging-output in the Elisp Manual (Bug#24051)
* doc/lispref/streams.texi (Output Streams): List
external-debugging-output.
* src/print.c (Fexternal_debugging_output): Quote `print' in
docstring.
2018-01-30 22:29:13 -05:00
Noam Postavsky
f706c59093 Update manual description of locate-file (Bug#23650)
* doc/lispref/files.texi (Locating Files): Add example of predicate
when searching for a directory.
2018-01-30 22:14:02 -05:00
Eli Zaretskii
691431eb09 Resurrect lost text in lispref
* doc/lispref/files.texi (File Attributes): Resurrect
inadvertently lost text.
2018-01-30 15:13:18 +02:00