From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Alan Mackenzie Newsgroups: gmane.emacs.devel Subject: Re: Difficulty building tree-sitter grammars [was: Help sought from C++ expert: ....] Date: Thu, 19 Jan 2023 20:56:13 +0000 Message-ID: References: <83y1pyo9hs.fsf@gnu.org> <83tu0mo1ft.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="37636"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Thu Jan 19 21:57:25 2023 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1pIbyP-0009X1-9o for ged-emacs-devel@m.gmane-mx.org; Thu, 19 Jan 2023 21:57:25 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pIbxa-0006HR-30; Thu, 19 Jan 2023 15:56:34 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pIbxR-0006H8-B0 for emacs-devel@gnu.org; Thu, 19 Jan 2023 15:56:25 -0500 Original-Received: from mx3.muc.de ([193.149.48.5]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pIbxI-0002n1-Th for emacs-devel@gnu.org; Thu, 19 Jan 2023 15:56:24 -0500 Original-Received: (qmail 37974 invoked by uid 3782); 19 Jan 2023 21:56:14 +0100 Original-Received: from acm.muc.de (p4fe15cd6.dip0.t-ipconnect.de [79.225.92.214]) (using STARTTLS) by colin.muc.de (tmda-ofmipd) with ESMTP; Thu, 19 Jan 2023 21:56:13 +0100 Original-Received: (qmail 6531 invoked by uid 1000); 19 Jan 2023 20:56:13 -0000 Content-Disposition: inline In-Reply-To: <83tu0mo1ft.fsf@gnu.org> X-Submission-Agent: TMDA/1.3.x (Ph3nix) X-Primary-Address: acm@muc.de Received-SPF: pass client-ip=193.149.48.5; envelope-from=acm@muc.de; helo=mx3.muc.de X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=unavailable autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:302560 Archived-At: Hello, Eli. On Thu, Jan 19, 2023 at 19:53:58 +0200, Eli Zaretskii wrote: > > Date: Thu, 19 Jan 2023 17:14:43 +0000 > > Cc: emacs-devel@gnu.org > > From: Alan Mackenzie > > > > Just as a matter of interest, in c++-ts-mode a treesit-query-error gets > > > > thrown. > > > I don't see any such error. Maybe this is again your outdated grammar > > > library? > > Heh! Maybe you're right. So time to get around to installing one from > > github. So I look at the Emacs-29 NEWS for instructions on how to do > > this. These instructions are glib and insufficiently helpful. > Nothing is ever good enough, eh? Emacs isn't good enough. That's why we're continually working on it. ;-) [ .... ] > If you don't know how to do this given what's in NEWS, then I'm sorry, > but these instructions are not for you. You will have to wait until > someone else (your distro?) produces the grammar library and lets you > download and install it like you download and install all the image > libraries and the rest of the optional stuff for Emacs. > I'm not going to make NEWS a step-by-step tutorial for how to compile > a bunch of files into a shared library. That is too much to expect > from us. It is NOT our job to teach people how to do that. Believe it or not, I've never built a shared library in my life (aside from invoking makefiles) and I'm sure I'm far from being alone. > > (iv) Then we have precise instructions on where to put the newly built > > ..so file. This is good! > This is the only part that is specific to Emacs, so I deliberately > included there all the details, since you are unlikely to find it > elsewhere. > > This process has so far taken me over an hour, which is too long for > > something which should be purely routine. It is likely to take a > > typical Emacs user even longer. > Typical Emacs users who don't know how to build libraries from sources > will need someone else to do the job for them. Exactly like they do > with GMP or librsvg or HarfBuzz or any other library that Emacs can > link against. Eventually, there's no way around this. These libraries come with makefiles, so there is no need to get into the details of how to build them. > > I suggest that these instructions in NEWS should be enhanced with (i) > > Tips on downloading stuff from github; (ii) A sample command line for > > compiling the C/C++ source files; (iii) A sample command line for > > linking these to the needed .so file. Possibly two or three versions of > > these would be needed for the different environments Emacs runs in. > Sorry, but NO!! At Dmitry pointed out, it turns out there's a makefile-equivalent for these grammar libraries, namely treesit-install-language-grammar. This worked well for me. Why is it not mentioned first in NEWS, something like "Typically you can build and install a grammar with ....." followed by "To build a grammar outside of Emacs ..." and the description of compiling linking and so on? Then I would have seen it, and the noise of this thread would have been avoided. Again, I doubt I'm the only user who'll not see past the end of a first unconditional instruction. -- Alan Mackenzie (Nuremberg, Germany).