procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix tree-sitter manual entry for treesit-should-enable-p

Browse source 
* doc/lispref/parsing.texi: Move two entries in the front to "Using
Parser" section, replacing the old entry.
This commit is contained in:
Yuan Fu 2022-09-07 16:15:01 -07:00
parent a23aec59b3
commit c2a9fe0c1d
No known key found for this signature in database
GPG key ID: 56E19BC57664A442
1 changed files with 8 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
doc/lispref/parsing.texi
View file

@ -26,18 +26,6 @@ This function returns non-nil if tree-sitter features are available
for this Emacs instance.
@end defun
@defvar treesit-max-buffer-size
This variable contains the maximum size of buffers in which
tree-sitter can be activated. Major modes should check this value
when deciding whether to enable tree-sitter features.
@end defvar
@defun treesit-can-enable-p
This function checks whether the current buffer is suitable for
activating tree-sitter features. It basically checks
@code{treesit-available-p} and @var{treesit-max-buffer-size}.
@end defun
For tree-sitter integration with existing Emacs features,
@pxref{Parser-based Font Lock}, @ref{Parser-based Indentation}, and
@ref{List Motion}.
@ -334,25 +322,18 @@ parser. In Emacs, each tree-sitter parser is associated with a
buffer. As we edit the buffer, the associated parser is automatically
kept up-to-date.
@defvar treesit-maximum-size
If users want to turn off tree-sitter for buffers larger than a
particular size (because tree-sitter consumes memory ~10 times the
buffer size for storing the syntax tree), they set this variable to
that size.
@defvar treesit-max-buffer-size
This variable contains the maximum size of buffers in which
tree-sitter can be activated. Major modes should check this value
when deciding whether to enable tree-sitter features.
@end defvar
@defun treesit-should-enable-p &optional mode
This function returns non-nil if @var{mode} (default to the current
major mode) should activate tree-sitter features. The result depends
on the value of @var{treesit-disabled-modes} and
@var{treesit-maximum-size} described above. The result also
depends on, of course, the result of @code{treesit-avaliabe-p}.
Writer of major modes or other packages are responsible for calling
this function and determine whether to activate tree-sitter features.
@defun treesit-can-enable-p
This function checks whether the current buffer is suitable for
activating tree-sitter features. It basically checks
@code{treesit-available-p} and @var{treesit-max-buffer-size}.
@end defun
@cindex Creating tree-sitter parsers
@defun treesit-parser-create language &optional buffer no-reuse
To create a parser, we provide a @var{buffer} to keep track of and the