1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-04-27 08:43:40 -07:00
Commit graph

6589 commits

Author SHA1 Message Date
Charles A. Roelli
ac3622c81a Improve documentation of 'read-hide-char'
* src/minibuf.c (syms_of_minibuf) <Vread_hide_char>: Clarify
documentation and mention where else the variable is used.
* doc/lispref/minibuf.texi (Reading a Password): Add an index
entry for 'read-hide-char'.
2018-10-03 20:00:13 +02:00
Noam Postavsky
cdca208932 Fix note about interactive advice (Bug#32905)
* doc/lispref/functions.texi (Core Advising Primitives): Add missing
':', and finish the sentence fragment.
2018-10-02 20:07:40 -04:00
Nicolas Goaziou
6a7a869c33 Org manual: Rewrite the Org Mobile section
* doc/misc/org.texi (Org Mobile): Rewritten from "MobileOrg" section.
Remove all references to non-free software.
Moved into "Miscellaneous", much like Org Crypt library. No longer an
appendix.
(Footnotes): Remove a reference to "MobileOrg".
(Bug#32722)
2018-09-30 14:40:14 +03:00
Eli Zaretskii
d309994aff Fix typos in documentation
* doc/misc/vhdl-mode.texi (Custom Indentation Functions):
* doc/misc/url.texi (Customization):
* doc/misc/tramp.texi (Overview):
* doc/misc/srecode.texi (Developing Template Functions):
* doc/misc/sieve.texi (Sieve Mode):
* doc/misc/reftex.texi (Options - Creating Citations):
* doc/misc/org.texi (Cooperation, Conflicts):
* doc/misc/gnus.texi (Misc Group Stuff):
* doc/misc/eshell.texi (Bugs and ideas):
* doc/misc/calc.texi (Summary):
* doc/man/emacsclient.1:
* doc/lispref/os.texi (Security Considerations):
* doc/lispref/control.texi (pcase Macro):
* CONTRIBUTE: Fix typos.  Reported by Mak Kolybabi
<mak@kolybabi.com>  (Bug#32853)
2018-09-27 18:48:06 +03:00
Stefan Monnier
dc7fdee08c * doc/emacs/kmacro.texi (Basic Keyboard Macro): Mention old bindings
According to Apple gospel, function keys are partly going the way of the dodo
so F3/F4 can, like in the good old days, be hard to reach for some users.
2018-09-24 14:58:11 -04:00
Eli Zaretskii
8b8a4c0aeb Improve documentation of directory-local variables
* lisp/files.el (hack-local-variables, normal-mode)
(after-find-file, find-file-hook): Mention directory-local
variables in the doc strings.  Suggested by Marcin Borkowski
<mbork@mbork.pl>.

* doc/emacs/custom.texi (File Variables, Directory Variables):
Clarify that directory-local variables are overridden by
file-local ones.
2018-09-22 12:06:51 +03:00
Eli Zaretskii
c9c9756d21 Don't use obsolete variable 'save-place' in documentation
* doc/lispref/customize.texi (Variable Definitions): Replace
example of saveplace defcustom with a fictitious one, which
will not bit-rot with time.  (Bug#32741)
2018-09-22 10:54:58 +03:00
Eli Zaretskii
d28d54c767 More accurate docs for 'text-char-description'
* src/keymap.c (Ftext_char_description):
* doc/lispref/help.texi (Describing Characters): More accurate
description of 'text-char-description'.  Remove incorrect
examples from the ELisp manual.  (Bug#32743)
2018-09-20 09:41:55 +03:00
Noam Postavsky
b3baf997c8 Document synchronous behavior of eshell/make (Bug#32513)
* doc/misc/eshell.texi (Built-ins):
* lisp/eshell/em-unix.el (eshell/make): Mention that it falls back to
the external 'make' command when called synchronously.
2018-09-19 18:57:37 -04:00
Eli Zaretskii
72a2a36654 Improve wording of last change in dired-x.texi
* doc/misc/dired-x.texi (Shell Command Guessing): Clarify
wording in description of 'dired-guess-shell-alist-user'.
Avoid passive tense.  (Bug#32733)
2018-09-19 10:08:03 +03:00
Eli Zaretskii
cc8f334d2d Document changes called out in NEWS
* doc/lispref/lists.texi (Association Lists): Document
'assoc-delete-all'.
* doc/lispref/minibuf.texi (Minibuffers): Adapt menu.
(Multiple Queries): Document 'read-answer'.

* etc/NEWS: Reflect the above documentation in the respective
entries.
2018-09-15 11:51:34 +03:00
Glenn Morris
24f240d51e Tiny doc updates re yum/dnf etc
* INSTALL: Mention dnf and Debian unversioned emacs package.
* doc/misc/efaq.texi (Installing Emacs): Mention dnf.
2018-09-14 08:54:28 -07:00
Robert Pluim
219893a519 Clarify meaning of '*'
* doc/misc/dired-x.texi (Shell Command Guessing): Clarify meaning
of '*'. (Bug#32733)
2018-09-14 15:58:17 +02:00
Alex Branham
1c22f037fd Increase default value for imenu-auto-rescan-maxout
* lisp/imenu.el (imenu-auto-rescan-maxout): Increase default value to
  600000.  (Bug#18426)
* doc/emacs/programs.texi (imenu-auto-rescan-maxout): Add
  documentation for imenu-auto-rescan-maxout.

Copyright-paperwork-exempt: yes
2018-09-12 15:20:25 +02:00
Eli Zaretskii
ee843895cb Improve recent change to ELisp manual
* doc/lispref/commands.texi (Keyboard Events): Add index entry
for "character event".  (Bug#32562)
2018-09-11 21:33:28 +03:00
Eli Zaretskii
ff374e4491 * doc/lispref/display.texi (SVG Images): Improve wording. 2018-09-11 10:30:25 +03:00
Eli Zaretskii
3a0caf6b7d * doc/lispref/display.texi (SVG Images): Fix a typo. (Bug#32690) 2018-09-11 10:12:49 +03:00
Eli Zaretskii
7efcdf7b3e Clarify completion text in the ELisp manual
* doc/lispref/minibuf.texi (Programmed Completion): Clarify
text.  Suggested by Stefan Monnier <monnier@iro.umontreal.ca>.
2018-09-10 16:20:42 +03:00
Eli Zaretskii
5cf282d65f Clarify documentation of functions reading character events
* doc/lispref/help.texi (Describing Characters):
* doc/lispref/commands.texi (Keyboard Events)
(Reading One Event, Classifying Events): Make the distinction
between characters and character events more explicit.

* src/keymap.c (Ftext_char_description)
(Fsingle_key_description):
* src/lread.c (Fread_char, Fread_char_exclusive): Doc fixes,
to make a clear distinction between a character input event
and a character code.  (Bug#32562)
2018-09-10 12:46:22 +03:00
Glenn Morris
ddc7c648d2 Standardize calc bug reporting instructions
* doc/misc/calc.texi (Reporting Bugs): Use standard commands.
* lisp/calc/calc-misc.el (report-calc-bug, calc-report-bug):
* lisp/calc/calc.el (calc-bug-address): Change to be
obsolete aliases for standard Emacs bug reporting items.
2018-09-03 10:28:07 -07:00
Michael Albinus
ac7936cb8f Rename thread-alive-p to thread-live-p
* doc/lispref/threads.texi (Basic Thread Functions): Use thread-live-p.

* etc/NEWS: 'thread-alive-p' has been renamed to 'thread-live-p'.

* src/thread.c (thread_live_p): Rename from thread_alive_p.  Adapt
all callees.
(Fthread_live_p): Rename from Fthread_alive_p.
(syms_of_threads): Make thread-alive-p an alias of thread-live-p.

* test/src/thread-tests.el (all): Replace `thread-alive-p' by
`thread-live-p'.
(threads-live): Rename from `threads-alive'.
2018-08-31 10:47:03 +02:00
Miciah Masters
3d09d533d1 rcirc: Document /reconnect as a built-in command (Bug#29656)
The change "New command rcirc-cmd-reconnect" from 2014-04-09 (shipped
in Emacs 25.1) added a /reconnect command to rcirc but did not
document it and did not delete the example /reconnect command
definition in the manual.
* doc/misc/rcirc.texi (rcirc commands): Document the built-in /reconnect
command.
(Hacking and Tweaking): Delete example reconnect command.

Copyright-paperwork-exempt: yes
2018-08-29 22:53:43 -04:00
Noam Postavsky
9d61344499 Index profiler commands in elisp manual
* doc/lispref/debugging.texi (Profiling): Add index entries for
profiler-start, profiler-report, profiler-stop.
2018-08-28 08:04:17 -04:00
Eli Zaretskii
51ef6d5576 Clarify in the Emacs manual that ChangeLog files are not used
* doc/emacs/trouble.texi (Sending Patches): Use "commit log"
instead of "change log", to avoid the interpretation that we
are talking about literal ChangeLog files.  (Bug#32359)
2018-08-23 20:02:27 +03:00
Eli Zaretskii
a9cf9387d9 Fix outdated text in the Calc manual
* doc/misc/calc.texi (Internals): Don't advertise
'calc-extensions' which no longer exists.  Reported by Francis
Wright <francis.j.wright@gmail.com>.
2018-08-17 17:22:44 +03:00
Eli Zaretskii
5132a5856d Improve documentation of 'set-fontset-font'
* doc/lispref/display.texi (Fontsets): Fix description of
'set-fontset-font'.
* src/fontset.c (Fset_fontset_font): Doc fix.  (Bug#32401)
2018-08-08 18:24:45 +03:00
Eli Zaretskii
cd9032532d Improve documentation of M-?
* doc/emacs/maintaining.texi (Identifier Search):
* lisp/progmodes/xref.el (xref-find-references): Improve
documentation of xref-find-references and
xref-prompt-for-identifier.  (Bug#32389)
2018-08-07 19:15:41 +03:00
Eli Zaretskii
38b6748856 Update the list of special forms in the ELisp manual
* doc/lispref/eval.texi (Special Forms):
* doc/lispref/frames.texi (Mouse Tracking): 'track-mouse' is
nowadays a macro.  (Bug#32284)
2018-07-28 10:22:04 +03:00
Eli Zaretskii
2e2f00f8a5 ; * doc/emacs/mule.texi (International Chars): Fix last change. 2018-07-27 08:54:44 +03:00
Eli Zaretskii
00561b59c4 Fix inaccurate text in the user manual
* doc/emacs/mule.texi (International Chars): Correct inaccurate
description of raw bytes display by "C-x =".
2018-07-26 21:38:09 +03:00
Michael Albinus
5cfb7a39ba Copyedits in tramp.texi, improved example with bash's readline
* doc/misc/tramp.texi (all): Unify some wordings.
(Frequently Asked Questions): Update example with bash's readline.
2018-07-26 11:54:33 +02:00
Michael Albinus
6f8f358e73 Minor Tramp doc update
* doc/misc/tramp.texi (Frequently Asked Questions): Disable bash's
INPUTRC.
2018-07-25 20:26:22 +02:00
Michael Albinus
2585fcb1d7 File Shadowing is not available on MS Windows
* doc/emacs/files.texi (File Shadowing): File Shadowing is not
available on MS Windows.

* test/lisp/shadowfile-tests.el (shadow-test00-clusters)
(shadow-test01-sites, shadow-test02-files)
(shadow-test03-expand-cluster-in-file-name)
(shadow-test04-contract-file-name, shadow-test05-file-match)
(shadow-test06-literal-groups, shadow-test07-regexp-groups)
(shadow-test08-shadow-todo, shadow-test09-shadow-copy-files):
Skip under MS Windows.
2018-07-25 17:34:55 +02:00
Eli Zaretskii
39da592da8 ; Minor markup change in indent.texi
* doc/emacs/indent.texi (Indentation Commands): Use
@kbd{@key{...}} for better looks.  (Bug#32248)
2018-07-25 17:22:29 +03:00
Michael Albinus
61de292c72 Fix (Bug#32218). Do not merge with master
* doc/misc/trampver.texi:
* lisp/net/trampver.el: Change version to "2.3.4.26.2".
(customize-package-emacs-version-alist): Add Tramp version
integrated in Emacs 26.2.

* lisp/net/tramp.el (tramp-handle-file-truename):
* lisp/net/tramp-adb.el (tramp-adb-handle-file-truename):
* lisp/net/tramp-sh.el (tramp-sh-handle-file-truename): Fix problem
with trailing slash.  (Bug#32218)

* test/lisp/net/tramp-tests.el (tramp-test21-file-links):
Remove `tramp--test-emacs27-p' check.
2018-07-20 10:56:41 +02:00
Eli Zaretskii
f4e7f6d73d Improve documentation of 'seqp'
* doc/lispref/sequences.texi (Sequence Functions): Add text to
explain the relation between 'seqp' and 'sequencep'.  (Bug#32125)
2018-07-14 11:18:04 +03:00
Eli Zaretskii
9b49a8ed4a Improve documentation of Flyspell
For the background, see
http://lists.gnu.org/archive/html/help-gnu-emacs/2018-07/msg00099.html.

* doc/emacs/fixit.texi (Spelling): Add a couple of caveats.
* lisp/textmodes/flyspell.el: Update commentary.
2018-07-12 18:59:18 +03:00
Basil L. Contovounesios
db3874b161 Refer to "proper lists" instead of "true lists"
* doc/lispref/lists.texi (Cons Cells, Building Lists):
* doc/lispref/sequences.texi (Vector Functions): Use the more
popular term "proper", rather than "true", to qualify nil-terminated
lists.

For discussion, see the following emacs-devel subthreads:
https://lists.gnu.org/archive/html/emacs-devel/2018-06/msg00112.html
https://lists.gnu.org/archive/html/emacs-devel/2018-06/msg00138.html
2018-07-10 19:54:31 -07:00
Michael Albinus
51bf4e4650 Fix Bug#32085
* doc/misc/tramp.texi (GVFS based methods): `dav' and `davs' do
not support paths in the volume name.  (Bug#32085)
2018-07-10 09:49:49 +02:00
Basil L. Contovounesios
da5d6dbe39 Fix (length NON-SEQUENCE) documentation
Suggested by Eli Zaretskii <eliz@gnu.org> in the following threads:
https://lists.gnu.org/archive/html/emacs-devel/2018-07/msg00171.html
https://lists.gnu.org/archive/html/emacs-devel/2018-07/msg00206.html

* doc/lispref/sequences.texi (Sequence Functions): Mention that
'length' signals a 'wrong-type-argument' also when given a
non-sequencep argument.
2018-07-07 20:05:42 +03:00
Eli Zaretskii
fdd7e7d8a8 Improve indexing of 'eval-defun' in ELisp manual
* doc/lispref/display.texi (Defining Faces):
* doc/lispref/debugging.texi (Explicit Debug):
* doc/lispref/customize.texi (Variable Definitions):
* doc/lispref/variables.texi (Defining Variables): Add index
entries for 'eval-defun'.  (Bug#32066)
2018-07-07 11:37:43 +03:00
Paul Eggert
10af989024 Fix (length CIRCULAR) documentation
* doc/lispref/sequences.texi (Sequence Functions):
Correct documentation of what (length X) does when
X is a circular list.
2018-07-06 11:00:22 -07:00
Michael Albinus
271d1f778e Tramp editorials
* doc/misc/tramp.texi (Android shell setup): Mention Termux.

* lisp/net/tramp-sh.el (tramp-remote-process-environment):
Use proper spelling "Tramp" in docstring.
2018-07-06 14:03:42 +02:00
Glenn Morris
00fdce071c * doc/emacs/docstyle.texi: Avoid messing up the html output.
Previously the @hyphenation commands somehow caused the <head>
section to go missing, with makeinfo 4.13 at least.
2018-07-02 22:37:22 -07:00
Eli Zaretskii
2f149c074d Fix a factual error in Introduction to Emacs Lisp
* doc/lispintro/emacs-lisp-intro.texi (Buffer Names): Update the
key that exits the splash screen.  (Bug#32019)
2018-06-30 16:13:01 +03:00
Michael Albinus
1f5037925b Sync with Tramp 2.3.4. Do not merge with master
* doc/misc/trampver.texi:
* lisp/net/trampver.el: Change version to "2.3.4".

* lisp/net/tramp-smb.el (tramp-smb-handle-delete-directory):
Check, that the directory has been removed indeed.

* test/lisp/net/tramp-tests.el (tramp-test21-file-links): Adapt test.
(tramp--test-emacs25-p): New defun.
(tramp-test34-vc-registered): Use it.
2018-06-27 13:08:18 +02:00
Karl Fogel
c7848767c9 Tighten a cross-reference in documentation
* doc/lispref/internals.texi (Writing Emacs Primitives): Switch to
  a simple parenthetical cross-reference, following up to my
  commit 9a53b6d426 of 2018-06-24.

See discussion:

  https://lists.gnu.org/archive/html/emacs-devel/2018-06/msg00826.html
  From: Eli Zaretskii
  Subject: Re: [Emacs-diffs] \
           emacs-26 9a53b6d: Say how to override a primitive interactive spec
  To: Karl Fogel
  CC: Stefan Monnier, Emacs Devel
  Date: Mon, 25 Jun 2018 17:41:53 +0300
  Message-Id: <83r2kvrkr2.fsf@gnu.org>
2018-06-25 12:23:23 -05:00
Eli Zaretskii
b419f27a43 ; * doc/emacs/files.texi (Interlocking): Fix a non-portable @xref. 2018-06-24 19:23:13 +03:00
Karl Fogel
9a53b6d426 Say how to override a primitive interactive spec
* doc/lispref/internals.texi (Writing Emacs Primitives): Mention that
  the `interactive-form' property can be used to override a primitive
  interactive specification, and refer to the detailed documentation
  for setting that property.

From this thread on Emacs Devel:

  https://lists.gnu.org/archive/html/emacs-devel/2018-03/msg00923.html
  From: Eli Zaretskii
  To: Karl Fogel
  CC: Juri Linkov, Emacs Devel
  Subject: Re: [Emacs-diffs] \
           master b88e7c8: Make transpose-regions interactive (Bug#30343)
  Date: Thu, 29 Mar 2018 14:38:15 +0300
  Message-Id: <834lkzdsd4.fsf@gnu.org>
2018-06-24 07:10:43 -05:00
Eli Zaretskii
decdfedf02 Clarify wording about functions' argument lists
* doc/lispref/functions.texi (Argument List): Clarify the
wording.  (Bug#31872)
2018-06-23 10:38:44 +03:00