From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#58071: 28.2; [PATCH] jumprel: A tool to find/create related files Date: Thu, 29 Sep 2022 11:54:56 +0300 Message-ID: <835yh6h867.fsf@gnu.org> References: <878rm7wvib.fsf@cassou.me> <83k05qlgyw.fsf@gnu.org> <874jwr9u6c.fsf@cassou.me> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="11186"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 58071@debbugs.gnu.org To: Damien Cassou Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Sep 29 10:56:52 2022 Return-path: Envelope-to: geb-bug-gnu-emacs@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 1odpLe-0002gg-Sq for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 29 Sep 2022 10:56:51 +0200 Original-Received: from localhost ([::1]:52844 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1odpLd-00035B-Ut for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 29 Sep 2022 04:56:49 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:52584) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1odpKt-00033k-2x for bug-gnu-emacs@gnu.org; Thu, 29 Sep 2022 04:56:08 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:36839) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1odpKs-0001oh-Qg for bug-gnu-emacs@gnu.org; Thu, 29 Sep 2022 04:56:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1odpKs-0002n6-Hn for bug-gnu-emacs@gnu.org; Thu, 29 Sep 2022 04:56:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 29 Sep 2022 08:56:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 58071 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 58071-submit@debbugs.gnu.org id=B58071.166444170910659 (code B ref 58071); Thu, 29 Sep 2022 08:56:02 +0000 Original-Received: (at 58071) by debbugs.gnu.org; 29 Sep 2022 08:55:09 +0000 Original-Received: from localhost ([127.0.0.1]:35915 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1odpK1-0002lr-0O for submit@debbugs.gnu.org; Thu, 29 Sep 2022 04:55:09 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:45318) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1odpJy-0002lR-J3 for 58071@debbugs.gnu.org; Thu, 29 Sep 2022 04:55:06 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:57910) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1odpJs-0001bH-NI; Thu, 29 Sep 2022 04:55:00 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=hgwRDXqK9a2ZYCibHQ2S/Lqo4UktjJX4jq0nhfsYnsM=; b=ngL33xEAJSHy Y0DpmBWTLaHhsQAnwm0lPN67iI7d8AxVKHQyI0k2sugzkA++2eh8e2bIgB/6AvdSzj+5Busqq5FV5 hwCWL+c78xyYTIeXA0NFdoiDxlmEEhVKN95D8n5b03MGgVe4SE6eWcXQA9qAjNCMszyLEN5LCVxW7 x/Xp4Q8uG40x/Z+S34UD+RXPbsc57fufvTQtkQNNKrxQBAvb+K1/+VdsFVH8R+rLWj4YsdYDimX+r FtcDsM2S335KXE6juZO07D5Fn7DUR4f2zjTN95kk8U/4KkslBbwfutCWghDt1YeJdap4fY3j7b1HJ EtaGRH+r2C6dues43waQIA==; Original-Received: from [87.69.77.57] (port=3692 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1odpJs-00042F-2l; Thu, 29 Sep 2022 04:55:00 -0400 In-Reply-To: <874jwr9u6c.fsf@cassou.me> (message from Damien Cassou on Wed, 28 Sep 2022 21:26:51 +0200) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:243880 Archived-At: > From: Damien Cassou > Cc: 58071@debbugs.gnu.org > Date: Wed, 28 Sep 2022 21:26:51 +0200 > > > - what you call "recipes", i.e. descriptors of how to generate the > > name of related files from a given file name, should be documented in > > a single doc string, and the other places that use recipes should > > reference the symbol whose doc string documents them > > do you have any suggestion for this? The only place I can find is > `jumprel-recipe--apply-filename-jumper' which is private. I could also > add it to the override of `jumprel-apply' but I'm not sure how to > reference an override from a docstring. I guess the doc string of jumprel-jumpers would be a possibility. > > > - I find no documentation of how to describe alternatives -- several > > alternative file names produced from a single original file name > > several alternatives can be produced with: > > 1. several jumpers produce several alternatives: all jumpers are > executed on the current file name and their results are merged into a > single list of candidates (see `jumprel--collect-existing-places' and > `jumprel--call-jumpers'). > > 2. a function-based jumper returning a list (this is described in the > docstring of `jumprel-apply') > > 3. a regexp-based jumper may also return a list of candidates if the > globs match several existing filenames > > 4. a recipe-based jumper may also return a list of candidates if > :add-directory is used and several matching directories exist > > Does that answer your question or did I miss the point? It does answer, but this should be documented. > What do you expect from me now? Send a new patch with the new package > name? Or do you plan to give more feedback first? A new patch, I guess. With a better name and with the documentation-related issues mentioned above fixed. We should then discuss whether to have this in core or on ELPA. Such a discussion would perhaps need to be on emacs-devel, not here, to catch a wider audience.