1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-01-01 01:41:01 -08:00
Commit graph

180 commits

Author SHA1 Message Date
Glenn Morris
551a89e12d Standardize case of "Front-Cover Texts" in texi file permissions notices.
Ref: http://lists.gnu.org/archive/html/bug-texinfo/2014-05/msg00015.html
2014-05-07 13:34:53 -04:00
Paul Eggert
09b73f0820 Style fixes for floating-point doc.
* commands.texi, customize.texi, display.texi, elisp.texi, files.texi:
* frames.texi, hash.texi, internals.texi, keymaps.texi, lists.texi:
* minibuf.texi, nonascii.texi, numbers.texi, objects.texi, os.texi:
* processes.texi, streams.texi, strings.texi, text.texi:
* variables.texi, windows.texi:
Hyphenate "floating-point" iff it precedes a noun.
Reword to avoid nouns and hyphenation when that's easy.
Prefer "integer" to "integer number" and "is floating point"
to "is a floating point number".
Prefer "@minus{}" to "-" when it's a minus.
2014-03-17 18:19:03 -07:00
Martin Rudalics
7e940b6546 Update docs for window dividers and `window-text-pixel-size'.
* xdisp.c (Fwindow_text_pixel_size): Adjust doc-string.
* elisp.texi (Top): Rename section "Width" to "Size of Displayed
Text".
* text.texi (Primitive Indent):
* strings.texi (String Basics):
* sequences.texi (Sequence Functions): Update references
accordingly.
* display.texi (Size of Displayed Text): Rename section from
"Width".  Add description for `window-text-pixel-size'.
(Window Dividers): Reword description of window dividers.
* frames.texi (Layout Parameters): Improve description of window
divider parameters.
* windows.texi (Window Sizes): Add descriptions of
`window-mode-line-height' and `window-header-line-height'.
(Coordinates and Windows): Mention window dividers.
2014-03-09 12:36:51 +01:00
Martin Rudalics
2c6053e838 Update docs for select-window and buffer-list-update-hook.
* buffer.c (Vbuffer_list_update_hook): Doc-string fix.
* window.c (Fselect_window): Explain NORECORD and
`buffer-list-update-hook' in doc-string.
* buffers.texi (The Buffer List): Rename node to Buffer List.
Describe `buffer-list-update-hook'.
* elisp.texi (Top): "The Buffer List" renamed to "Buffer List".
Add node for Window Dividers.
* hooks.texi (Standard Hooks): Add reference to
`buffer-list-update-hook'.
* windows.texi (Selecting Windows): Update description of
`select-window'.
2014-03-07 16:11:12 +01:00
Glenn Morris
47b73b35c1 Try to document some smie changes
* doc/lispref/modes.texi (SMIE Customization): New section.

* doc/lispref/elisp.texi (Top): Update detailed menu.

* etc/NEWS: Related edits.
2014-03-04 23:41:48 -08:00
Glenn Morris
d2b94b157c Document zlib-decompress-region
* doc/lispref/text.texi (Decompression): New node.

* doc/lispref/elisp.texi (Top): Update detailed menu.

* etc/NEWS: Related markup.
2014-03-01 19:34:36 -08:00
Xue Fuqiao
0fcfa97418 Document `define-alternatives'.
* doc/lispref/elisp.texi (Top):
* doc/lispref/commands.texi (Generic Commands):
(Defining Commands): Document `define-alternatives'.

* etc/NEWS: Related edit.  Unrelated copyedit.
2014-02-28 09:49:25 +08:00
Glenn Morris
458e643be8 Some doc updates for default process sentinels and filters not being nil
* doc/lispref/internals.texi (Process Internals):
* doc/lispref/processes.texi (Deleting Processes, Output from Processes)
(Process Buffers, Filter Functions, Accepting Output, Sentinels)
(Network, Network Servers, Network Processes, Serial Ports):
Filters and sentinels can no longer be nil.

* doc/lispref/elisp.texi (Top): Menu update.

* doc/misc/flymake.texi (Starting the syntax check process): Grammar fix.

* doc/misc/tramp.texi (External packages): Grammar fix.
Reword for default sentinel not being nil any more.

* src/process.c (Fprocess_buffer, Faccept_process_output)
(Finternal_default_process_filter, Finternal_default_process_sentinel):
Doc fixes.
2014-02-21 00:04:15 -08:00
Stefan Monnier
122ff675df * doc/lispref/functions.texi (Advising Functions): New section.
* doc/lispref/modes.texi (Running Hooks): Don't document with-wrapper-hook and
run-hook-wrapped any more.
(Hooks): Link to the new Advising Functions node.
* doc/lispref/elisp.texi (Top): Don't include advice.texi.
* doc/lispref/advice.texi: Remove.
* doc/lispref/makefile.w32-in (srcs):
* doc/lispref/Makefile.in (srcs): Adjust accordingly.
* doc/misc/cl.texi (Function Bindings): Fix incorrect description of cl-let.
2014-01-10 14:40:32 -05:00
Chong Yidong
81c7d631e9 More doc updates.
* backups.texi (Making Backups): Document backup-buffer change.

* commands.texi (Defining Commands): Document the interactive-form
property more carefully.  Document interactive-only.

* compile.texi (Compiler Errors): Copyedits.  Note that the
details for byte-compile-warnings are in its docstring.

* customize.texi (Variable Definitions): Likewise.

* files.texi (Visiting Files): Copyedits.
(Testing Accessibility): Mention ACLs.  Move file-modes here from
File Attributes.
(Truenames): Move file-equal-p here from Kinds of Files.
(File Attributes): Move file-newer-than-file-p here from Testing
Accessibility.
(Extended Attributes): New node.  Add file-extended-attributes.
(Changing Files): Document set-file-extended-attributes.

* minibuf.texi (Minibuffer Contents): Remove obsolete function
minibuffer-completion-contents.

* variables.texi (Defining Variables): Note that defvar acts
always on the dynamic value.
2014-01-06 07:36:13 +08:00
Paul Eggert
6bc383b1a4 Fix copyright years by hand.
These are dates that admin/update-copyright did not update,
or updated incorrectly.
2014-01-01 00:31:29 -08:00
Eli Zaretskii
634425957a Revert @documentencoding changes in the docs. 2013-12-30 19:08:32 +02:00
Paul Eggert
dcd812be6a Specify info encoding and language.
* emacs.texi, emacs-xtra.texi:
* emacs-lisp-intro.texi:
* back.texi, book-spine.texi, elisp.texi, lay-flat.texi:
* ada-mode.texi, auth.texi, autotype.texi, bovine.texi, calc.texi:
* cc-mode.texi, cl.texi, dbus.texi, dired-x.texi, ebrowse.texi:
* ede.texi, ediff.texi, edt.texi, efaq-w32.texi, efaq.texi:
* eieio.texi, emacs-gnutls.texi, emacs-mime.texi, epa.texi, erc.texi:
* ert.texi, eshell.texi, eudc.texi, flymake.texi, forms.texi:
* gnus-coding.texi, gnus-faq.texi, gnus.texi, htmlfontify.texi:
* idlwave.texi, ido.texi, info.texi, mairix-el.texi, message.texi:
* mh-e.texi, newsticker.texi, nxml-mode.texi, octave-mode.texi:
* org.texi, pcl-cvs.texi, pgg.texi, rcirc.texi, reftex.texi:
* remember.texi, sasl.texi, sc.texi, semantic.texi, ses.texi:
* sieve.texi, smtpmail.texi, speedbar.texi, srecode.texi:
* todo-mode.texi, tramp.texi, url.texi, vip.texi, viper.texi:
* widget.texi, wisent.texi, woman.texi:
Add @documentencoding, @documentlanguage as needed.

Fixes: debbugs:16292
2013-12-29 19:19:25 -08:00
Glenn Morris
b55e11bf85 Generate info/dir from .texi files rather than .info files
* Makefile.in (install-info): Handle missing info/dir.
(info_dir_deps): New variable.
(${srcdir}/info/dir): Depend on .texi files rather than .info files.
(check-info): Update topics.

* build-aux/make-info-dir: Use .texi files rather than .info files.
Update topics.

* doc/lispintro/emacs-lisp-intro.texi:
* doc/lispref/elisp.texi:
Tweak dircategory (all the others use "Emacs" + lower-case).
2013-12-12 17:41:31 -05:00
Glenn Morris
f9405d87cd Add support for auto-generating info/dir
* admin/update_autogen: Add option to generate info/dir.
(Usage): Add -I.
(info_flag): New variable.
(-I): New option.
(doc): Maybe check its status.
(info_dir): New function.

* admin/dir_top: New file.

* doc/emacs/emacs.texi:
* doc/lispintro/emacs-lisp-intro.texi:
* doc/lispref/elisp.texi:
* doc/misc/autotype.texi, doc/misc/cc-mode.texi, doc/misc/ediff.texi:
* doc/misc/ert.texi, doc/misc/htmlfontify.texi, doc/misc/ido.texi:
* doc/misc/octave-mode.texi, doc/misc/org.texi, doc/misc/srecode.texi:
* doc/misc/todo-mode.texi, doc/misc/tramp.texi:
Sync direntry with info/dir version.
2013-12-11 19:37:38 -08:00
Xue Fuqiao
64a695bd91 Doc fix.
* doc/emacs/custom.texi (Specifying File Variables): Fix cross-references.

* doc/emacs/mule.texi (Unibyte Mode): Fix cross-references.

* doc/lispref/nonascii.texi (Non-ASCII Characters): Update menu.
(Disabling Multibyte): Move here from doc/emacs/mule.texi.  Fix cross-references.

* doc/lispref/elisp.texi (Top): Update menu.
2013-07-31 20:59:10 +08:00
Michael Albinus
32813ea795 * files.texi (Magic File Names): Add file-notify-add-watch,
file-notify-rm-watch and file-notify-supported-p.  Move
file-remote-p down.

* errors.texi (Standard Errors): Add file-notify-error.

* os.texi (Desktop Notifications): Rename from Notifications.
(File Notifications): New node.

* elisp.texi (Top): Update menu for these changes.
2013-07-22 11:19:00 +02:00
Glenn Morris
4431e6d9b3 Merge from emacs-24; up to 2012-12-30T19:34:25Z!jan.h.d@swipnet.se 2013-07-05 18:39:21 -07:00
Glenn Morris
d4aa7284bc Tweak html header for manuals
* doc/lispintro/emacs-lisp-intro.texi (Top):
Move WWW_GNU_ORG section outside @copying, update URL.

* doc/lispref/elisp.texi (Top): Move WWW_GNU_ORG section outside @copying.

@copying appears as a comment on every page, there is no need for the
WWW_GNU_ORG stuff to be in there.
2013-07-04 18:32:13 -07:00
Stefan Monnier
78be8b6465 Merge from emacs-24 2013-03-16 18:08:22 -04:00
Glenn Morris
c076590546 Tweaks for www.gnu.org html versions of manuals
* admin/admin.el (manual-html-mono, manual-html-node): Add -DWWW_GNU_ORG.

* doc/emacs/emacs.texi (Top): Add some stuff specific to www.gnu.org.

* doc/lispintro/emacs-lisp-intro.texi: Add some stuff specific to www.gnu.org.

* doc/lispref/elisp.texi: Add some stuff specific to www.gnu.org.
2013-03-12 00:15:15 -07:00
Paul Eggert
681ebc3315 Prefer UTF-8 for documentation.
With GNU Texinfo 5.0, this generates nicer-looking info files,
since they can use curly quotes.  With older Texinfo it doesn't matter.
2013-03-04 00:45:03 -08:00
Glenn Morris
1e56f8ef34 Lispref updates for multi-frame images
* doc/lispref/display.texi (GIF Images, TIFF Images): Delete these nodes.
(ImageMagick Images): For :index, use an xref rather than duplicating.
(Other Image Types): Add GIF, adjust formatting.
(Multi-Frame Images): Rename from Animated Images.  Expand section.

* doc/lispref/elisp.texi (Top): Update menu for these changes.
2013-02-20 00:34:28 -08:00
Eli Zaretskii
8549f9e89b Remove all references to buffer-file-type and related features.
src/xdisp.c (decode_mode_spec): Remove handling of %t.

 lisp/net/ange-ftp.el (ange-ftp-insert-file-contents): Don't reference
 buffer-file-type.
 lisp/mail/feedmail.el (feedmail-force-binary-write): Doc fix.
 (feedmail-run-the-queue, feedmail-dump-message-to-queue)
 (feedmail-send-it-immediately): Don't bind buffer-file-type, bind
 coding-system-for-write instead.
 lisp/jka-compr.el (jka-compr-write-region): Don't bind
 buffer-file-type.
 lisp/emacs-lisp/bytecomp.el (byte-compile-file): Don't bind
 buffer-file-type.
 lisp/files.el (file-name-buffer-file-type-alist): Remove defvar.
 (insert-file-contents-literally): Remove reference to
 file-name-buffer-file-type-alist.
 lisp/dos-w32.el (file-name-buffer-file-type-alist): Deprecate and
 make-obsolete.
 (find-buffer-file-type-match, find-buffer-file-type): Remove.
 (find-buffer-file-type-coding-system): Remove references to
 find-buffer-file-type-match, find-buffer-file-type, and
 buffer-file-type.
 Don't put find-buffer-file-type-coding-system into
 file-coding-system-alist.
 (find-file-binary, find-file-text): Bind coding-system-for-read
 instead of file-name-buffer-file-type-alist.
 lisp/erc/erc-dcc.el (erc-dcc-get-file): Don't reference buffer-file-type.

 doc/emacs/msdog.texi (Text and Binary): Delete the description of
 file-name-buffer-file-type-alist.

 doc/lispref/modes.texi (%-Constructs): Remove the description of %t.
 doc/lispref/nonascii.texi (MS-DOS File Types): Delete node.

Fixes: debbugs:12989
2013-02-09 14:52:01 +02:00
Glenn Morris
0a8bf3afca Merge from emacs-24; up to 2012-12-06T07:33:20Z!rgm@gnu.org 2013-01-02 18:37:57 -08:00
Glenn Morris
1cbb9ed6ae * doc/lispref/elisp.texi (DATE): Bump to Jan 2013. 2013-01-02 17:53:13 -08:00
Paul Eggert
0877d0dc24 Merge from emacs-24; up to 2012-12-06T01:39:03Z!monnier@iro.umontreal.ca 2013-01-02 08:13:04 -08:00
Paul Eggert
ab422c4d68 Update copyright notices for 2013. 2013-01-01 09:11:05 +00:00
Glenn Morris
00afe3a454 Merge from emacs-24; up to 2012-12-02T06:22:32Z!cyd@gnu.org 2012-12-22 11:09:52 -08:00
Paul Eggert
f99f164170 Hyphen and dash fixes in texinfo files. 2012-12-22 08:25:40 -08:00
Glenn Morris
c5bc2d1d05 Merge from emacs-24; up to 2012-11-23T06:23:28Z!cyd@gnu.org 2012-12-02 17:08:31 -08:00
Chong Yidong
f02f19bd4e Lisp manual improvements for plists and symbol plists.
* doc/lispref/commands.texi (Using Interactive): Fix index entry.

* doc/lispref/customize.texi (Variable Definitions):
* doc/lispref/display.texi (Defining Faces):
* doc/lispref/sequences.texi (Char-Tables): Fix xref.

* doc/lispref/lists.texi (Property Lists): Move here from symbols.texi.
(Plist Access): Rename from Other Plists.

* doc/lispref/symbols.texi (Symbol Properties): New node.
(Symbol Plists): Make it a subsection under Symbol Properties.
(Standard Properties): New node.
2012-12-02 17:14:16 +08:00
Paul Eggert
c07a6ded1d * doclicense.texi, gpl.texi: Update to latest version from FSF.
These are just minor editorial changes.
2012-11-24 13:37:18 -08:00
Glenn Morris
5b776637e1 Make a start on a Profiling section in the lispref
* doc/lispref/debugging.texi (Profiling): New section, in progress.
* doc/lispref/tips.texi (Compilation Tips): Move profiling to separate section.
* doc/lispref/elisp.texi: Add Profiling to detailed menu.
2012-11-20 00:02:54 -08:00
Martin Rudalics
fdaf534a7b Fix and rewrite doc on window recombining facilities.
* window.c (Fsplit_window_internal): Set combination limit of
new parent window to t iff Vwindow_combination_limit is t;
fixing a regression introduced with the change from 2012-09-22.
(Fwindow_combination_limit, Fset_window_combination_limit): Fix
doc-strings.

* elisp.texi (Top): Add Recombining Windows to menu.
* windows.texi (Recombining Windows): New subsection.
(Splitting Windows): Rewrite text on handling of window
combinations and move it to new subsection.
2012-11-07 10:41:52 +01:00
Glenn Morris
ebdbfb9535 Add some documentation on defining new generalized variables
* doc/lispref/variables.texi (Setting Generalized Variables):
Split most of previous contents into this subsection.
(Adding Generalized Variables): New subsection.

* doc/lispref/elisp.texi:
Add Generalized Variables subsections to detailed menu.

* etc/NEWS: Mention some gv.el macros by name.
2012-11-05 20:42:17 -05:00
Glenn Morris
5887564d5b Move generalized variable documentation from misc/cl.texi to lispref
* doc/lispref/variables.texi (Generalized Variables): New section,
adapted from misc/cl.texi.

* doc/lispref/elisp.texi (Top): Add Generalized Variables to menu.

* doc/lispref/lists.texi (List Elements, List Variables):
Mention generalized variables.

* doc/misc/cl.texi (Control Structure): Update for setf now being in core.
(Setf Extensions): Rename from Basic Setf.  Move much of the
former content to lispref/variables.texi.
(Modify Macros): Move pop, push details to lispref/variables.texi.
(Customizing Setf): Copyedits for setf etc being in core.
(Modify Macros, Efficiency Concerns, Porting Common Lisp):
Further namespaces updates.
2012-10-27 15:42:07 -07:00
Chong Yidong
75e8f9d2de Improve documentation of easy-menu-define.
* lisp/emacs-lisp/easymenu.el (easy-menu-define): Doc fix.

* doc/lispref/keymaps.texi (Toolkit Differences): Node deleted.
(Easy Menu): New node.

Fixes: debbugs:12628
2012-10-24 11:48:50 +08: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
ed1f0bd388 Doc fixes for defface and friends.
* lisp/cus-edit.el (custom-unlispify-remove-prefixes): Add warning.

* lisp/custom.el (defface): Doc fix.

* doc/lispref/customize.texi (Customization): Define customization more
carefully.
(Common Keywords): Add xref to Constant Variables.

* doc/lispref/display.texi (Faces): Discuss anonymous faces.
(Face Attributes): Tweak intro.
(Defining Faces): Move after the Face Attributes node.  Copyedits.
(Displaying Faces): Describe role of inheritance.

* doc/lispref/variables.texi (Defining Variables): Link to defcustom's node
instead of the higher-level Customization chapter.

Fixes: debbugs:11440
2012-09-18 13:14:42 +08:00
Chong Yidong
02676e5d3d Doc fixes and improvements for syntax tables.
* src/syntax.c (Fmodify_syntax_entry): Doc fix.

* doc/lispref/syntax.texi (Syntax Basics): Rearrange the text for clarity.
Fix description of syntax table inheritance.
(Syntax Table Functions): Don't refer to internal contents of
syntax table, since that is not explained yet.  Copyedits.
(Standard Syntax Tables): Node deleted.
(Syntax Table Internals): Misc clarifications.  Improve table
formatting.

* doc/lispref/keymaps.texi (Inheritance and Keymaps):
* doc/lispref/text.texi (Sticky Properties): Tweak index entry.
2012-08-04 22:33:00 +08:00
Paul Eggert
09ae5da1b8 Prefer typical American spelling for "acknowledgment". 2012-07-24 22:48:19 -07:00
Chong Yidong
d4913798ad Misc fixes for Lisp manual.
* doc/lispref/intro.texi (A Sample Function Description): Fix incorrect
markup, undoing previous change.
(A Sample Variable Description): Minor clarifications and markup
improvements.

* doc/lispref/elisp.texi (Top):
* doc/lispref/text.texi (Text): Fix menu order.
2012-07-06 12:25:04 +08: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
5b6eebcf2b Remove the need for lispref vol1.texi and vol2.texi
* vol1.texi, vol2.texi: Remove files.
* elisp.texi: Add VOL1,2 conditionals equivalent to vol1,2.texi
* two-volume.make: Use elisp.texi as input rather than vol1,2.texi.
2012-05-08 20:11:41 -07:00
Glenn Morris
ca4b98faff Stop keeping 3 copies of the lispref menu structure for no reason
vol1.texi and vol2.texi are only used to generate TeX output, and this
constructs its own table of contents and does not use the @menu stuff.

* vol1.texi, vol2.texi: No need to keep menus in these files.
* elisp.texi, anti.texi: Comments.
2012-05-07 23:38:27 -07:00
Chong Yidong
eceeb5fca6 Merge from emacs-24; up to 2012-04-20T05:47:55Z!eliz@gnu.org 2012-05-05 12:32:58 +08:00
Glenn Morris
cfed8eeb2f * elisp.texi (DATE): Forgot to change the month in 2012-04-21 change. 2012-05-04 00:04:40 -07:00