Commit graph

249 commits

Author SHA1 Message Date
Chong Yidong
d18a0d2460 More documentation fixes for changes to defun, defmacro, etc.
* doc/lispref/functions.texi (Anonymous Functions): Explicitly list the
docstring, declare, and interactive arguments to lambda.
(Defining Functions): Likewise for defun.
(Inline Functions): Likewise for defsubst.
(Declare Form): Tweak description.

* doc/lispref/macros.texi (Defining Macros):  defmacro is now a macro.
Explicitly list the docstring and declare arguments.

* emacs-lisp/byte-run.el (defsubst): Doc fix.
2012-10-15 12:03:04 +08:00
Glenn Morris
e8757f091a Merge from emacs-24; up to 2012-05-08T14:11:47Z!monnier@iro.umontreal.ca 2012-10-05 00:38:05 -07:00
Bruno Félix Rezende Ribeiro
26026637d3 * doc/lispref/functions.texi (Function Safety): Copyedit (tiny change)
Fixes: debbugs:12562
2012-10-03 00:25:17 -07:00
Chong Yidong
48de8b1221 Update docs for a bunch of 24.3 changes.
* doc/emacs/killing.texi (Rectangles): Document copy-rectangle-as-kill.

* doc/emacs/search.texi (Special Isearch): Document the lax space search
feature and M-s SPC.
(Regexp Search): Move main search-whitespace-regexp description to
Special Isearch.
(Replace): Document replace-lax-whitespace.

* doc/emacs/basic.texi (Position Info): Document C-u M-=.
(Moving Point): Document move-to-column.

* doc/emacs/display.texi (Useless Whitespace): Add delete-trailing-lines.

* doc/emacs/misc.texi (emacsclient Options): Document the effect of
initial-buffer-choice on client frames.  Document server-auth-dir.
Do not document server-host, which is bad security practice.

* doc/emacs/building.texi (Lisp Libraries): Docstring lookups can trigger
autoloading.  Document help-enable-auto-load.

* doc/emacs/mini.texi (Yes or No Prompts): New node.

* doc/emacs/ack.texi (Acknowledgments): Remove obsolete packages.

* doc/lispref/commands.texi (Click Events): Define "mouse position list".
Remove mention of unimplemented horizontal scroll bars.
(Drag Events, Motion Events): Refer to "mouse position list".
(Accessing Mouse): Document posnp.

* doc/lispref/errors.texi (Standard Errors): Tweak arith-error description.
Tweak markup.  Remove domain-error and friends, which seem to be
unused after the floating-point code revamp.

* doc/lispref/functions.texi (Obsolete Functions): Obsolescence also affects
documentation commands.  Various clarifications.
(Declare Form): New node.

* doc/lispref/loading.texi (Autoload):
* doc/lispref/help.texi (Documentation Basics): The special sequences can
trigger autoloading.

* doc/lispref/macros.texi (Defining Macros): Move description of `declare' to
Declare Form node.

* doc/lispref/numbers.texi (Integer Basics): Copyedits.
(Float Basics): Consider IEEE floating point always available.
(Random Numbers): Document actual limits.
(Arithmetic Operations): Clarify division by zero.  Don't mention
the machine-independence of negative division since it does not
happen in practice.

* doc/lispref/os.texi (Idle Timers): Minor clarifications.
(User Identification): Add system-users and system-groups.

* doc/lispref/strings.texi (String Basics): Copyedits.

* lisp/minibuffer.el (minibuffer-local-filename-syntax): Doc fix.

* lisp/server.el (server-host): Document the security implications.
(server-auth-key): Doc fix.

* lisp/startup.el (initial-buffer-choice): Doc fix.

* src/fns.c (Frandom): Doc fix.
2012-09-30 17:18:38 +08:00
Chong Yidong
9f6f48455f Merge from emacs-24; up to 2012-05-02T07:12:52Z!rgm@gnu.org. 2012-08-07 11:33:37 +08:00
Eli Zaretskii
a08eadfecc Fix bug #12138 with indexing "closures".
doc/lispref/functions.texi (Closures): Put the main index entry for
 "closures" here.
 doc/lispref/variables.texi (Lexical Binding): Disambiguate the index entry
 for "closures".
2012-08-06 19:55:41 +03:00
Stefan Monnier
1053a8716b Fix return value of `defun' and un-define it.
* src/data.c (Fdefalias): Return `symbol'.
* doc/lispref/functions.texi (Defining Functions):
* doc/lispref/macros.texi (Defining Macros): Un-define the return value of
`defun', `defmacro' and `defalias'.

Fixes: debbugs:11686
2012-06-18 11:57:41 -04:00
Chong Yidong
41b7f8bc6c Merge changes from emacs-24; up to 2012-04-26T02:03:19Z!ueno@unixuser.org 2012-06-17 13:13:40 +08:00
Chong Yidong
84f4a53180 More minor manual copyedits to fix 7x9 manual underfull/overfull hboxes.
* doc/emacs/emacs.texi: Remove urlcolor setting.

* doc/lispref/elisp.texi, vol1.texi, vol2.texi: Remove urlcolor setting.

* doc/lispref/vol2.texi: Include package.texi.
2012-06-11 14:48:47 +08:00
Glenn Morris
ecc6530da9 Nuke hand-written node pointers in doc/lispref
Let makeinfo figure them out, as is recommended.
2012-05-26 18:34:14 -07:00
Glenn Morris
33017fafd1 Merge from emacs-24; up to 2012-04-24T08:35:02Z!lekktu@gmail.com 2012-05-26 18:06:44 -07:00
Chong Yidong
27d1f87a35 Misc docfixes.
Suggested by Martin Rudalics.

* doc/lispref/display.texi (Face Functions): Fix define-obsolete-face-alias.

* doc/lispref/functions.texi (Obsolete Functions): Fix doc for
set-advertised-calling-convention.

* doc/lispref/modes.texi (Mode Help): Fix describe-mode.

* doc/lispref/variables.texi (Variable Aliases): Fix make-obsolete-variable.

* lisp/help.el (describe-mode): Doc fix.
2012-05-15 23:43:06 +08:00
Glenn Morris
666b903b91 Merge from emacs-24; up to 2012-04-21T14:12:27Z!sdl.web@gmail.com 2012-05-08 20:06:08 -07:00
Glenn Morris
ddff335186 More small edits for doc/lispref
* control.texi: Where possible, use example rather than smallexample.
(Sequencing, Conditionals, Signaling Errors, Handling Errors):
Tweak page breaks.

* customize.texi: Where possible, use example rather than smallexample.
(Common Keywords, Variable Definitions, Applying Customizations)
(Custom Themes): Tweak page breaks.

* eval.texi, functions.texi, loading.texi, macros.texi:
Where possible, use example rather than smallexample.

* sequences.texi (Arrays): Tweak page breaks.

* symbols.texi: Where possible, use example rather than smallexample.
(Symbol Components): Fix typo.
(Other Plists): Tweak page break.
2012-05-04 20:37:30 -04:00
Chong Yidong
a8e7d6d783 Merge changes from emacs-24 branch 2012-04-27 11:10:38 +08:00
Stefan Monnier
88ed9e87e5 Deprecate the ((lambda ...) ...) form.
* doc/lispref/functions.texi (Simple Lambda, Argument List):
* doc/lispref/eval.texi (Function Indirection): Avoid deprecated form.
2012-04-25 23:06:36 -04:00
Glenn Morris
1e103a7cd8 Remove unnecessary @setfilename commands from many doc/lispref/*.texi 2012-04-13 18:59:01 -07:00
Chong Yidong
735cc5ca6f Update Functions chapter of Lisp manual; document closures.
* doc/emacs/functions.texi (What Is a Function): Add closures.  Mention
"return value" terminology.  Add xref for command-execute.  Remove
unused "keystroke command" terminology.
(Lambda Expressions): Give a different example than in the
following subsection.  Add xref to Anonymous Functions.
(Function Documentation): Remove gratuitous markup.
(Function Names): Move introductory text to `What Is a Function'.
(Defining Functions): Fix defun argument spec.
(Anonymous Functions): Document lambda macro explicitly.  Mention
effects on lexical binding.
(Function Cells): Downplay direct usage of fset.
(Closures): New node.
(Inline Functions): Remove "open-code" terminology.
(Declaring Functions): Minor tweak; .m is not C code.

* doc/emacs/variables.texi (Variables): Don't refer to "global value".
(Local Variables, Void Variables): Copyedits.
(Lexical Binding): Minor clarification of example.
(File Local Variables): Mention :safe and :risky defcustom args.
(Lexical Binding): Add xref to Closures node.
2012-02-04 22:56:32 +08:00
Glenn Morris
acaf905b11 Add 2012 to FSF copyright years for Emacs files 2012-01-05 01:46:05 -08:00
Lars Magne Ingebrigtsen
413c488ddb * functions.texi (Calling Functions): Link to the "Interactive
Call" node.

Fixes: debbugs:1001
2011-07-06 20:34:55 +02:00
Lars Magne Ingebrigtsen
c7844a2764 * functions.texi (What Is a Function): Document the autoload
object.

Fixes: debbugs:6496
2011-07-03 14:33:37 +02:00
Glenn Morris
73b0cd5003 Convert consecutive FSF copyright years to ranges. 2011-01-24 20:08:28 -08:00
Glenn Morris
0d9f702fd0 Nuke arch-tags. 2011-01-15 15:16:57 -08:00
Glenn Morris
5df4f04cd3 Add 2011 to FSF/AIST copyright years. 2011-01-02 15:50:46 -08:00
Chong Yidong
3e99b8257b Document byte-to-string in Lisp manual.
* objects.texi (Symbol Type):
* text.texi (Near Point):
* help.texi (Help Functions):
* functions.texi (Mapping Functions): Use string instead of
char-to-string in examples.

* nonascii.texi (Converting Representations): Document
byte-to-string.

* strings.texi (Creating Strings): Don't mention semi-obsolete
function char-to-string.
(String Conversion): Shorten discussion of semi-obsolete function
string-to-char.  Link to Converting Representations.
2010-11-21 13:07:47 -05:00
Glenn Morris
d24880de8b Untabify doc/lispref/*.texi.
* abbrevs.texi, commands.texi, compile.texi, debugging.texi:
* display.texi, edebug.texi, elisp.texi, eval.texi, files.texi:
* frames.texi, functions.texi, internals.texi, keymaps.texi:
* loading.texi, minibuf.texi, numbers.texi, os.texi, processes.texi:
* searching.texi, sequences.texi, strings.texi, syntax.texi:
* text.texi, tips.texi, vol1.texi, vol2.texi, windows.texi:
Untabify Texinfo files.
2010-06-22 20:36:56 -07:00
Chong Yidong
eb5ed549f4 Document Emacs 23.2 changes.
* functions.texi (Obsolete Functions): Document
set-advertised-calling-convention.

* minibuf.texi (Basic Completion): Document completion-in-region.
(Programmed Completion): Document completion-annotate-function.

* commands.texi (Reading One Event): Document read-key.
(Distinguish Interactive): Document KIND arg to
called-interactively-p.  Delete obsolete interactive-p.

* elisp.texi (Top): Update node description.

* misc.texi (Printing): Document htmlfontify-buffer.
2010-04-25 17:21:51 -04:00
Glenn Morris
114f9c9679 Add 2010 to copyright years. 2010-01-13 00:35:10 -08:00
Glenn Morris
3d9842c67e (Declaring Functions): Mention that we also search for ".m" files in
the src/ directory.
2009-10-01 02:05:32 +00:00
Chong Yidong
5d6ab67259 * functions.texi (Anonymous Functions): Rearrange discussion,
giving usage of unquoted lambda forms first.  Mention that
`function' and `#'' are no longer required (Bug#4290).
2009-09-13 01:47:03 +00:00
Glenn Morris
bfd0fe7b60 Minor rearrangements to improve TeX line-filling. 2009-07-09 03:05:35 +00:00
Glenn Morris
6ed161e1d6 Add 2009 to copyright years. 2009-01-08 05:28:46 +00:00
Richard M. Stallman
27610f35e2 (Function Safety): Texinfo usage fix. 2009-01-05 16:03:29 +00:00
Chong Yidong
b0fbc5000c (Declaring Functions): Fix typo. 2008-11-25 03:51:57 +00:00
Eli Zaretskii
834b54855c (Calling Functions): Use defalias' instead of fset'. Fix wording. 2008-10-21 09:21:02 +00:00
Eli Zaretskii
a18a6d497c (Calling Functions): Wording fixes from RMS. 2008-10-20 10:22:16 +00:00
Eli Zaretskii
80f85d7cda (Calling Functions): Document `apply-partially'. 2008-10-19 14:57:50 +00:00
Eli Zaretskii
9b240644fb (What Is a Function): `functionp' returns nil for special forms. Add an xref. 2008-10-13 11:18:02 +00:00
Stefan Monnier
fc944cd4c5 (functionp): Return nil for special forms. 2008-04-05 20:22:22 +00:00
Miles Bader
59ce725a3b Merge from emacs--rel--22
Revision: emacs@sv.gnu.org/emacs--devo--0--patch-987
2008-01-08 20:46:54 +00:00
Glenn Morris
6297397b28 (Declaring Functions): Improve previous change (arguments by name, not number). 2007-12-01 02:32:20 +00:00
Glenn Morris
8f4b37d892 (Declaring Functions): Add optional fourth
argument of declare-function, setting third argument to `t'.
2007-11-30 07:51:41 +00:00
Glenn Morris
c45400672f (Declaring Functions): Add findex. Mention `external' files. 2007-11-29 04:41:17 +00:00
Juanma Barranquero
7a6a17280d (Declaring Functions): Fix typo in directive. 2007-11-26 08:48:31 +00:00
Richard M. Stallman
a0925923a2 (Declaring Functions): Clarify previous change. 2007-11-24 16:00:57 +00:00
Glenn Morris
e31dfb12ac (Declaring Functions): New section. 2007-11-24 03:06:15 +00:00
Miles Bader
fdc9061358 Merge from emacs--rel--22
Patches applied:

 * emacs--rel--22  (patch 131-137)

   - Update from CVS
   - Merge from gnus--rel--5.10

 * gnus--rel--5.10  (patch 261-262)

   - Update from CVS

Revision: emacs@sv.gnu.org/emacs--devo--0--patch-908
2007-10-27 09:07:17 +00:00
Glenn Morris
6336d8c3d7 (setfilename): Go up one more level to ../../info. 2007-09-06 04:27:43 +00:00
Glenn Morris
b8d4c8d0e9 Move here from ../../lispref 2007-09-06 04:25:08 +00:00