[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Tree-sitter introduction documentation
From: |
Eli Zaretskii |
Subject: |
Re: Tree-sitter introduction documentation |
Date: |
Fri, 16 Dec 2022 21:37:07 +0200 |
> From: Perry Smith <pedz@easesoftware.com>
> Date: Fri, 16 Dec 2022 13:08:45 -0600
> Cc: emacs-devel@gnu.org
>
> >>> My main problem is where to put this stuff.
> >>
> >> There are tree sitter Info pages in the ELisp topic but I would add some
> >> to Emacs topic as well. Perhaps under
> >> Advanced Features
> >> Tree Sitter
> >> Setup and Getting Started
> >> Font lock — describe the “features” concept, treesit-font-lock-level
> >> and treesit-font-lock-recompute-features
> >>
> >> The other topics seem more appropriate in ELisp which already exist.
> >
> > This is not relevant to ELisp, so the ELisp Reference manual is not an
> > appropriate place for this stuff.
>
> We might be talking about two different things. In
> admin/notes/tree-sitter/html-manual are 10 html documents. For
> example one is titled "Accessing Node Information". All of those come
> from nodes within the ELisp Info doc. e.g.
>
> https://git.savannah.gnu.org/cgit/emacs.git/tree/doc/lispref/parsing.texi#n875
>
> That seems like the right place for those nodes since they are rather
> low level.
>
> The higher level user interface concepts I would think would need to
> be in the Emacs Info tree as I suggested.
This all started (for me, anyway), when you wrote:
> Emacs needs to be compiled with tree-sitter enabled
> The tree sitter binary needs to be installed
> The tree sitter language specific parser needs to be installed
> The appropriate major mode needs to be loaded and enabled
>
> Is there a page either in Info or on the web that contains all these steps?
I interpreted "all these steps" as meaning the description of how to
do all of the above: compile Emacs with tree-sitter enabled, install
the tree-sitter library, install the language grammar libraries. By
contrast, the information to which you point is about writing code
that accesses parsing results provided by the tree-sitter library, a
very different kind of topic. That topic _is_ described in the ELisp
manual, see the file doc/lispref/parsing.texi.
- Re: Tree-sitter introduction documentation, (continued)
- Re: Tree-sitter introduction documentation, Gregory Heytings, 2022/12/28
- Re: Tree-sitter introduction documentation, Stefan Monnier, 2022/12/28
- Re: Tree-sitter introduction documentation, Dmitry Gutov, 2022/12/27
- Re: Tree-sitter introduction documentation, tomas, 2022/12/27
- Re: Tree-sitter introduction documentation, Stefan Monnier, 2022/12/27
Re: Tree-sitter introduction documentation, Perry Smith, 2022/12/16
Re: Tree-sitter introduction documentation, Payas Relekar, 2022/12/17
Re: Re: Tree-sitter introduction documentation, Pedro Andres Aranda Gutierrez, 2022/12/18
Re: Re: Tree-sitter introduction documentation, Pedro Andres Aranda Gutierrez, 2022/12/31