diff options
author | Yuan Fu <casouri@gmail.com> | 2022-10-29 13:51:45 -0700 |
---|---|---|
committer | Yuan Fu <casouri@gmail.com> | 2022-10-29 14:47:01 -0700 |
commit | baacad1771e3551ffdb1b88c41224fa1957e766c (patch) | |
tree | df76620229531693dcac8dd458d1c321c4462f80 /doc/lispref/modes.texi | |
parent | 3a784d1321487be4031555d19ace635598bba21c (diff) | |
download | emacs-baacad1771e3551ffdb1b88c41224fa1957e766c.tar.gz emacs-baacad1771e3551ffdb1b88c41224fa1957e766c.tar.bz2 emacs-baacad1771e3551ffdb1b88c41224fa1957e766c.zip |
Reflect recent change in tree-sitter manual sections
* doc/lispref/modes.texi (Parser-based Font Lock):
treesit-font-lock-enable is replaced by treesit-major-mode-setup.
* doc/lispref/modes.texi (Parser-based Indentation): Mention
treesit-major-mode-setup,
* doc/lispref/parsing.texi (Tree-sitter major modes): Remove
treesit-mode and global-treesit-mode, explain setup guideline.
Diffstat (limited to 'doc/lispref/modes.texi')
-rw-r--r-- | doc/lispref/modes.texi | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 6212c7cd87f..614bbe1293c 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -3890,10 +3890,6 @@ also provides complete syntactic font lock with the help of a parser. Currently, Emacs uses the tree-sitter library (@pxref{Parsing Program Source}) for this purpose. -@defun treesit-font-lock-enable -This function enables parser-based font lock in the current buffer. -@end defun - Parser-based font lock and other font lock mechanisms are not mutually exclusive. By default, if enabled, parser-based font lock runs first, then the syntactic font lock (if enabled), then the regexp-based @@ -3930,6 +3926,11 @@ would be highlighted in @code{font-lock-keyword} face. For more information about queries, patterns, and capture names, see @ref{Pattern Matching}. +To setup tree-sitter fontification, a major mode should first set +@code{treesit-font-lock-settings} with the output of +@code{treesit-font-lock-rules}, then call +@code{treesit-major-mode-setup}. + @defun treesit-font-lock-rules :keyword value query... This function is used to set @var{treesit-font-lock-settings}. It takes care of compiling queries and other post-processing, and outputs @@ -4012,12 +4013,14 @@ For example, the value of this variable could be: @end example Major modes should set this variable before calling -@code{treesit-font-lock-enable}. +@code{treesit-major-mode-setup}. @findex treesit-font-lock-recompute-features For this variable to take effect, a Lisp program should call @code{treesit-font-lock-recompute-features} (which resets -@code{treesit-font-lock-settings} accordingly). +@code{treesit-font-lock-settings} accordingly), or +@code{treesit-major-mode-setup} (which calls +@code{treesit-font-lock-recompute-features}). @end defvar @defvar treesit-font-lock-settings @@ -4771,7 +4774,9 @@ It is more convenient to use the simple indentation engine described below: then the major mode needs only to write some indentation rules and the engine takes care of the rest. -To enable the parser-based indentation engine, set the value of +To enable the parser-based indentation engine, either set +@var{treesit-simple-indent-rules} and call +@code{treesit-major-mode-setup}, or equivalently, set the value of @code{indent-line-function} to @code{treesit-indent}. @defvar treesit-indent-function |