1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-01-07 15:21:46 +00:00
Commit Graph

58 Commits

Author SHA1 Message Date
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
Paul Eggert
5c7dd8a783 Update copyright year to 2018
Run admin/update-copyright.
2018-01-01 00:57:59 -08:00
Glenn Morris
cf36c82127 Avoid some overfull lines in PDF lispref
* doc/lispref/commands.texi (Reading One Event):
* doc/lispref/display.texi (SVG Images):
* doc/lispref/frames.texi (Size Parameters):
* doc/lispref/syntax.texi (Categories):
* doc/lispref/windows.texi (Frame Layouts with Side Windows):
Avoid overfull lines.
2017-12-22 16:26:08 -05:00
Alan Mackenzie
913808e224 Doc amendment for syntax-ppss.
* doc/elisp/syntax.texi (Position Parse): Note, twice, that syntax-ppss is
equivalent to parse-partial-sexp from the beginning of THE VISIBLE PART OF the
buffer.  Final part of the fix for bug #22983.
2017-10-01 16:08:20 +00:00
Alan Mackenzie
539d8626cd Remove inadvertent changes to syntax.texi in last commit.
* doc/lispref/syntax.texi (Position Parse): revert changes.
2017-10-01 11:27:16 +00:00
Alan Mackenzie
8c18dcbc78 Amend documentation for text-quoting-style becoming a user option.
* doc/lispref/control.texi (Signaling Errors):
* doc/lispref/display.texi (Displaying Messages):
* doc/lispref/strings.texi (Formatting Strings):
Edit for brevity, farming out the details to the new
Text Quoting Style node.
* doc/lispref/help.texi (Text Quoting Style): New section.
Move detailed discussion of text-quoting-style here.
Add discussion about how to output grave accent and apostrophe in
documentation and messages.  Adjust xrefs to point to this section
when appropriate.
* etc/NEWS: text-quoting-style semantics have not changed.
2017-10-01 11:27:16 +00:00
Paul Eggert
bcf244ef9b Merge from origin/emacs-25
2e2a806 Fix copyright years by hand
5badc81 Update copyright year to 2017
2017-01-01 01:10:47 -08:00
Paul Eggert
5badc81c1c Update copyright year to 2017
Run admin/update-copyright.
2016-12-31 19:42:26 -08:00
Alan Mackenzie
9dcf599893 Amend parse-partial-sexp correctly to handle two character comment delimiters
Do this by adding a new field to the parser state: the syntax of the last
character scanned, should that be the first char of a (potential) two char
construct, nil otherwise.
This should make the parser state complete.
Also document element 9 of the parser state.  Also refactor the code a bit.

* src/syntax.c (struct lisp_parse_state): Add a new field.
(SYNTAX_FLAGS_COMSTARTEND_FIRST): New function.
(internalize_parse_state): New function, extracted from scan_sexps_forward.
(back_comment): Call internalize_parse_state.
(forw_comment): Return the syntax of the last character scanned to the caller
when that character might be the first of a two character construct.
(Fforward_comment, scan_lists): New dummy variables, passed to forw_comment.
(scan_sexps_forward): Remove a redundant state parameter.  Access all `state'
information via the address parameter `state'.  Remove the code which converts
from external to internal form of `state'.  Access buffer contents only from
`from' onwards.  Reformulate code at the top of the main loop correctly to
recognize comment openers when starting in the middle of one.  Call
forw_comment with extra argument (for return of syntax value of possible first
char of a two char construct).
(Fparse_partial_sexp): Document elements 9, 10 of the parser state in the
doc string.  Clarify the doc string in general.  Call
internalize_parse_state.  Take account of the new elements when consing up the
output parser state.

* doc/lispref/syntax.texi: (Parser State): Document element 9 and the new
element 10.  Minor wording corrections (remove reference to "trivial
cases").
(Low Level Parsing): Minor corrections.

* etc/NEWS: Note new element 10, and documentation of element 9 of parser
state.
2016-03-20 13:19:48 +00:00
Alan Mackenzie
f7adb8a4ef Clarify the documentation of nested comments.
* doc/lispref/syntax.texi (Syntax Flags): State that only comments of the same
style are recognized inside nestable comments.
(Low-Level Parsing): Clarify that parsing will stop after the start or end of
UNNESTED comments.
2016-03-10 11:42:32 +00:00
Eli Zaretskii
303141ae6e Update documentation for obsoleting 'syntax-begin-function'
* doc/lispref/syntax.texi (Position Parse): Undocument
'syntax-begin-function' that is now obsolete.
2016-01-10 20:05:46 +02:00
Paul Eggert
0e963201d0 Update copyright year to 2016
Run admin/update-copyright.
2016-01-01 01:34:24 -08:00
Alan Mackenzie
326ffcce5f Allow line comments ending with escaped NL to be continued to the next line.
Use this in C, C++, and Objective C Modes.  Fixes bug#22246

* src/syntax.c (comment-end-can-be-escaped): New buffer local variable.
(forw-comment, back-comment): On encountering an end of comment character,
test whether it is escaped when `comment-end-can-be-escaped' is non-nil.

* doc/lispref/syntax.texi (Control Parsing): Describe
`comment-end-can-be-escaped'.

* etc/NEWS (Lisp Changes): Describe `comment-end-can-be-escaped'.

* lisp/progmodes/cc-langs.el: New c-lang-setvar `comment-end-can-be-escaped'.
2015-12-28 16:01:05 +00:00
Paul Eggert
ef7dbdf587 Quote less in manuals
The manuals often used quotes ``...'' when it is better to use @dfn or
@code or capitalized words or no quoting at all.  For example, there is
no need for the `` and '' in “if a variable has one effect for
@code{nil} values and another effect for ``non-@code{nil}'' values”.
Reword the Emacs, Lisp intro, and Lisp reference manuals to eliminate
unnecessary quoting like this, and to use @dfn etc. instead when called
for (Bug#21472).
2015-09-15 08:48:44 -07:00
Eli Zaretskii
0fafb58295 Improve documentation of categories
* doc/lispref/syntax.texi (Categories): Clarify the example of
using define-category and modify-category-entry.  (Bug#21448)
2015-09-10 20:39:02 +03:00
Eli Zaretskii
74baea086d Fix indentation of an @example in ELisp manual
* doc/lispref/syntax.texi (Categories): Untabify the example.
(Bug#21448)
2015-09-09 22:06:28 +03:00
Paul Eggert
a2940cd43e Minor quoting etc. fixes to lispref manual
* doc/lispref/tips.texi (Documentation Tips):
Distinguish more clearly among grave accent, apostrophe,
and single quote.
* doc/lispref/README, doc/lispref/buffers.texi:
* doc/lispref/commands.texi, doc/lispref/control.texi:
* doc/lispref/customize.texi, doc/lispref/display.texi:
* doc/lispref/elisp.texi, doc/lispref/files.texi:
* doc/lispref/frames.texi, doc/lispref/hash.texi:
* doc/lispref/help.texi, doc/lispref/internals.texi:
* doc/lispref/loading.texi, doc/lispref/makefile.w32-in:
* doc/lispref/markers.texi, doc/lispref/modes.texi:
* doc/lispref/nonascii.texi, doc/lispref/objects.texi:
* doc/lispref/os.texi, doc/lispref/positions.texi:
* doc/lispref/strings.texi, doc/lispref/syntax.texi:
* doc/lispref/text.texi, doc/lispref/tips.texi:
* doc/lispref/two-volume-cross-refs.txt, doc/lispref/windows.texi:
Use American-style double quoting in ordinary text,
and quote 'like this' when single-quoting in ASCII text.
Also, fix some minor spacing issues.
2015-04-10 11:28:52 -07:00
Paul Eggert
7e09ef09a4 Update copyright year to 2015
Run admin/update-copyright.
2015-01-01 14:26:41 -08:00
Eli Zaretskii
20cfd2480d Improve indexing on the chapter/section/subsection levels.
doc/lispref/windows.texi (Recombining Windows): Index subject of sections.
 doc/lispref/variables.texi (Variables with Restricted Values)
 (Generalized Variables): Index subject of sections.
 doc/lispref/text.texi (Buffer Contents, Examining Properties)
 (Changing Properties, Property Search, Substitution): Index
 subject of sections.
 doc/lispref/syntax.texi (Motion and Syntax, Parsing Expressions)
 (Motion via Parsing, Position Parse, Control Parsing): Index
 subject of sections.
 doc/lispref/strings.texi (Predicates for Strings, Creating Strings)
 (Modifying Strings, Text Comparison): Index subject of sections.
 doc/lispref/searching.texi (Syntax of Regexps, Regexp Special)
 (Regexp Functions, Regexp Functions): Index subject of sections.
 doc/lispref/processes.texi (Subprocess Creation, Process Information): Index
 subject of sections.
 doc/lispref/positions.texi (Screen Lines): Index subject of sections.
 doc/lispref/nonascii.texi (Scanning Charsets, Specifying Coding Systems):
 Index subject of sections.
 doc/lispref/minibuf.texi (Text from Minibuffer, Object from Minibuffer)
 (Multiple Queries, Minibuffer Contents): Index subject of
 sections.
 doc/lispref/markers.texi (Predicates on Markers, Creating Markers)
 (Information from Markers, Moving Markers): Index subject of
 sections.
 doc/lispref/macros.texi (Defining Macros, Problems with Macros): Index
 subject of sections.
 doc/lispref/loading.texi (Loading Non-ASCII, Where Defined): Index subject
 of sections.
 doc/lispref/lists.texi (List-related Predicates, List Variables, Setcar)
 (Setcdr, Plist Access): Index subject of sections.
 doc/lispref/keymaps.texi (Controlling Active Maps, Scanning Keymaps)
 (Modifying Menus): Index subject of sections.
 doc/lispref/help.texi (Accessing Documentation, Help Functions): Index
 subject of sections.
 doc/lispref/hash.texi (Hash Access): Index subject of sections.
 doc/lispref/functions.texi (Core Advising Primitives)
 (Advising Named Functions, Porting old advices): Index subject of
 sections.
 doc/lispref/frames.texi (Creating Frames, Initial Parameters)
 (Position Parameters, Buffer Parameters, Minibuffers and Frames)
 (Pop-Up Menus, Drag and Drop): Index subject of sections.
 doc/lispref/files.texi (Visiting Functions, Kinds of Files)
 (Unique File Names): Index subject of sections.
 doc/lispref/display.texi (Refresh Screen, Echo Area Customization)
 (Warning Variables, Warning Options, Delayed Warnings)
 (Temporary Displays, Managing Overlays, Overlay Properties)
 (Finding Overlays, Size of Displayed Text, Defining Faces)
 (Attribute Functions, Displaying Faces, Face Remapping)
 (Basic Faces, Font Lookup, Fontsets, Replacing Specs)
 (Defining Images, Showing Images): Index subject of sections.
 doc/lispref/debugging.texi (Debugging, Explicit Debug)
 (Invoking the Debugger, Excess Open, Excess Close): Index subject
 of sections.
 doc/lispref/customize.texi (Defining New Types, Applying Customizations)
 (Custom Themes): Index subject of sections.
 doc/lispref/control.texi (Sequencing, Combining Conditions)
 (Processing of Errors, Cleanups): Index subject of sections.
 doc/lispref/compile.texi (Eval During Compile): Index subject of sections.
 doc/lispref/commands.texi (Using Interactive, Distinguish Interactive)
 (Command Loop Info, Classifying Events, Event Mod)
 (Invoking the Input Method): Index subject of sections.
 doc/lispref/buffers.texi (Buffer List, Buffer Gap): Index subject of sections.
 doc/lispref/backups.texi (Making Backups, Numbered Backups, Backup Names)
 (Reverting): Index subject of sections.
 doc/lispref/abbrevs.texi (Abbrev Tables, Defining Abbrevs, Abbrev Files)
 (Abbrev Expansion, Standard Abbrev Tables, Abbrev Properties)
 (Abbrev Table Properties): Index subject of sections.
 doc/lispref/os.texi (Time of Day, Time Conversion, Time Parsing)
 (Time Calculations, Idle Timers): Index subject of sections.
2014-12-23 20:42:30 +02:00
Paul Eggert
ba3189039a Update copyright year to 2014 by running admin/update-copyright. 2014-01-01 07:43:34 +00:00
Xue Fuqiao
9e73b24216 * doc/lispref/syntax.texi (Categories): Add an index for category sets. 2013-10-05 19:49:02 +08:00
Xue Fuqiao
c9358b45b9 Add an index for modify-syntax-entry. 2013-10-03 23:32:10 +08:00
Xue Fuqiao
79b3ad55f6 * doc/lispref/syntax.texi (Syntax Flags): Add an index for comment style. 2013-10-03 23:09:18 +08:00
Xue Fuqiao
8c1f51ffff Add an index for the table of syntax classes.
* doc/lispref/syntax.texi (Syntax Class Table): Add an index for syntax class table.
2013-10-02 23:14:06 +08:00
Glenn Morris
253e30aa89 Manual fixes re describe-syntax
* doc/emacs/help.texi (Misc Help): Index describe-syntax.

* doc/lispref/syntax.texi (Syntax Table Functions): Mention describe-syntax.
2013-06-26 00:16:20 -07:00
Glenn Morris
75e78d1e90 Tweak some lispref line breaks
* doc/lispref/processes.texi (System Processes):
* doc/lispref/syntax.texi (Syntax Table Functions):
Tweak some line breaks.
2013-01-02 18:23:39 -08:00
Paul Eggert
ab422c4d68 Update copyright notices for 2013. 2013-01-01 09:11:05 +00:00
Eli Zaretskii
151d90884b Fix bug #13292 with use of @var in @def.. commands in ELisp manual.
doc/lispref/functions.texi (Declare Form):
 doc/lispref/intro.texi (A Sample Function Description):
 doc/lispref/syntax.texi (Syntax Table Internals, Syntax Table Functions):
 doc/lispref/variables.texi (Using Lexical Binding): Don't use @var or CAPS
 in @def.. commands.
2012-12-29 10:23:21 +02:00
Paul Eggert
1df7defd80 Fix minor whitespace issues after "." in manual.
Be more systematic about using "@." (not ".") at end of sentence that
ends in a capital letter, and about appending "@:" after non-ends of
sentences that end in a lower case letter followed by "." followed by
whitespace.  Omit unnecessary use of "@:" and "@.".  Similarly for "?"
and "!".  Be more consistent about putting a comma after "i.e." and
"e.g."; this is the typical American style and it's easier to code in
Texinfo.

Fixes: debbugs:12973
2012-12-05 14:27:56 -08:00
Chong Yidong
6dcef6eca7 Introduce "raw syntax descriptor" terminology, and use it.
* syntax.texi (Syntax Table Internals): Define "raw syntax
descriptor" terminology.
(Syntax Descriptors): Mention raw syntax descriptors.

* lisp/subr.el (syntax-after, syntax-class): Doc fix.

* syntax.c (Fstring_to_syntax): Doc fix.

Fixes: debbugs:12383
2012-09-08 22:23:01 +08:00
Chong Yidong
52404181ac Add a couple of xrefs to the Lisp manual.
* markers.texi (Moving Markers): Add xref to Point.

* syntax.texi (Low-Level Parsing): Add xref to Parser State.

Fixes: debbugs:12269
2012-09-07 12:51:26 +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
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
Chong Yidong
a8e7d6d783 Merge changes from emacs-24 branch 2012-04-27 11:10:38 +08:00
Glenn Morris
16152b76a4 Use Texinfo recommended convention for quotes+punctuation. 2012-04-25 20:31:47 -04:00
Glenn Morris
1e103a7cd8 Remove unnecessary @setfilename commands from many doc/lispref/*.texi 2012-04-13 18:59:01 -07:00
Chong Yidong
7b926f3f3d Clarify doc of scan-lists.
* doc/lispref/syntax.texi (Motion via Parsing): Doc fix for scan-lists.

* src/syntax.c (Fscan_lists): Doc fix.

Fixes: debbugs:10833
2012-02-17 22:01:05 +08:00
Chong Yidong
4230351b56 Update Syntax chapter of Lisp manual.
* doc/lispref/syntax.texi (Syntax Tables, Syntax Descriptors)
(Syntax Table Functions): Copyedits.
(Syntax Basics): Don't repeat the material in the preceding node.
(Syntax Class Table): Use a table.
(Syntax Properties): Document syntax-propertize-function and
syntax-propertize-extend-region-functions.
(Motion via Parsing): Fix indentation.
(Parser State): Update for the new "c" comment style.  Fix
description of item 7 (comment style).

* doc/lispref/modes.texi (Syntactic Font Lock): Add xref to Syntactic Font Lock node.
2012-02-16 22:43:41 +08:00
Chong Yidong
f700caa38b Updates to Font Lock docs in Lisp manual.
* doc/lispref/modes.texi (Minor Modes): Update how mode commands should treat
arguments now.
(Mode Line Basics): Clarify force-mode-line-update.
(Mode Line Top): Note that the example is not realistic.
(Mode Line Variables, Mode Line Data, %-Constructs, Header Lines)
(Emulating Mode Line): Use "mode line" instead of "mode-line", and
"mode line construct" instead of "mode line specification".
(Syntactic Font Lock): Remove mention of obsolete variable
font-lock-syntactic-keywords.
(Setting Syntax Properties): Node deleted.
(Font Lock Mode): Note that Font Lock mode is a minor mode.
(Font Lock Basics): Note that syntactic fontification falls back
on `syntax-table'.
(Search-based Fontification): Emphasize that font-lock-keywords
should not be set directly.
(Faces for Font Lock): Avoid some confusing terminology.
(Syntactic Font Lock): Minor clarifications.
2012-02-16 14:04:38 +08:00
Chong Yidong
a037c17168 Minor tweaks to the Lisp manual.
* syntax.texi (Parsing Expressions): Clarify intro.
(Parser State): Remove unnecessary statement (Bug#10661).

* eval.texi (Intro Eval): Add footnote about "sexp" terminology.

Fixes: debbugs:10657
2012-01-31 14:51:33 +08:00
Chong Yidong
837a390a91 * doc/lispref/syntax.texi (Syntax Class Table): Tweak description of newline char syntax.
Fixes: debbugs:9619
2012-01-29 15:35:58 +08:00
Glenn Morris
acaf905b11 Add 2012 to FSF copyright years for Emacs files 2012-01-05 01:46:05 -08:00
Eli Zaretskii
1ea897d542 Improve documentation of regexp search for categories.
doc/lispref/searching.texi (Regexp Backslash): Document how to display
 existing categories.  Mention the possibility of adding
 categories, and add an xref to where this is described.  Add an
 index entry.
 doc/lispref/syntax.texi (Categories): Add an example of defining a new
 category and category table.
2011-08-16 10:53:33 +03:00
Lars Magne Ingebrigtsen
ad21a12a3a Clarify that the ". 23" syntax description is a string
Fixes: debbugs:3313
2011-07-11 17:30:28 +02:00
Nix
35a30759f3 Misc small lispref fixes.
* windows.texi (Displaying Buffers): pop-to-buffer is not a command.

* text.texi (Parsing HTML): Update for function name changes.

* syntax.texi (Syntax Flags): Small fix.

* keymaps.texi (Active Keymaps): Typo fix.
(Changing Key Bindings): Grammar fix.

* frames.texi (Minibuffers and Frames): Grammar fix.
(Window System Selections): x-select-enable-clipboard now defaults to t.

* customize.texi (Common Keywords):
* display.texi (Abstract Display):
* modes.texi (Auto-Indentation):
* nonascii.texi (Converting Representations): Typo fixes.

* control.texi (Examples of Catch): Call it "goto" not "go to".
2011-05-18 23:54:27 -07: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
Stefan Monnier
77ab81d054 Merge from emacs-23 2011-01-14 12:18:41 -05:00
Glenn Morris
5df4f04cd3 Add 2011 to FSF/AIST copyright years. 2011-01-02 15:50:46 -08:00
Stefan Monnier
7cf78aac59 * doc/lispref/syntax.texi (Syntax Flags): Document new `c' flag. 2010-09-11 15:58:57 +02:00