[PATCH] org-ctags: Fix regexp to not break radio targets

[PATCH] org-ctags: Fix regexp to not break radio targets

[Martin Marshall]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Fix regexp for radio targets --]
[-- Type: text/x-diff, Size: 920 bytes --]

From 9b9e8ead6c175c76e4f37273a4e4f29b8e41b4f9 Mon Sep 17 00:00:00 2001
From: Martin Marshall <law@martinmarshall.com>
Date: Sun, 11 Feb 2024 12:36:46 -0500
Subject: [PATCH] org-ctags: Fix regexp to not break radio-target links

* org-ctags.el (org-ctags-tag-regexp): Add left angle-bracket to
excluded characters for tag text.
---
 lisp/org-ctags.el | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lisp/org-ctags.el b/lisp/org-ctags.el
index e56ed9cd8..6431a2765 100644
--- a/lisp/org-ctags.el
+++ b/lisp/org-ctags.el
@@ -149,7 +149,7 @@
 (defvar org-ctags-enabled-p t
   "Activate ctags support in org mode?")
 
-(defvar org-ctags-tag-regexp "/<<([^>]+)>>/\\1/d,definition/"
+(defvar org-ctags-tag-regexp "/<<([^<>]+)>>/\\1/d,definition/"
   "Regexp expression used by ctags external program.
 The regexp matches tag destinations in Org files.
 Format is: /REGEXP/TAGNAME/FLAGS,TAGTYPE/
-- 
2.39.2


[-- Attachment #2: Type: text/plain, Size: 995 bytes --]

This updates `org-ctags-tag-regexp' to avoid adding broken entries for
radio targets in the TAGS file.

With the old regexp, org-ctags would add radio targets to the TAGS file
with an extra angle bracket at the beginning.  So a target of
"<<<radio target>>>" would be entered in the TAGS file as
"<radio target", instead of just "radio target".

This meant that when you click on the linked text "radio target", the
link wouldn't match any of the TAGS file entries.  So org-ctags would
inquire about rebuilding the TAGS file.  Then, when it still couldn't
match the target, it would attempt to be helpful and ask about adding a
new target to the end of your org file.  Only after you declined that,
it would finally allow Org-mode to move point to the radio target as
intended.

This patch allows radio targets to coexist with org-ctags and to even
use them with org-ctags in external files, in the same manner as
dedicated targets.

-- 
Best regards,
Martin Marshall

Re: [PATCH] org-ctags: Fix regexp to not break radio targets

[Ihor Radchenko]

Martin Marshall <law@martinmarshall.com> writes:

> Subject: [PATCH] org-ctags: Fix regexp to not break radio-target links
>
> * org-ctags.el (org-ctags-tag-regexp): Add left angle-bracket to
> excluded characters for tag text.
> ...
> This updates `org-ctags-tag-regexp' to avoid adding broken entries for
> radio targets in the TAGS file.
>
> With the old regexp, org-ctags would add radio targets to the TAGS file
> with an extra angle bracket at the beginning.  So a target of
> "<<<radio target>>>" would be entered in the TAGS file as
> "<radio target", instead of just "radio target".

Thanks!
Applied, onto main, with amendments to the commit message.
I added a TINYCHANGE cookie and linked to this thread.
https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=38dd88268

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: [PATCH] org-ctags: Fix regexp to not break radio targets

[Martin Marshall]

Ihor Radchenko <yantar92@posteo.net> writes:

> Applied, onto main, with amendments to the commit message.
> I added a TINYCHANGE cookie and linked to this thread.
> https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=38dd88268

Thanks!  I just noticed that org-ctags breaks CUSTOM_ID property links
in the same way.  So I might submit a patch for that as well soon.

-- 
Best regards,
Martin Marshall

Re: [PATCH] org-ctags: Fix regexp to not break radio targets

[Ihor Radchenko]

Martin Marshall <law@martinmarshall.com> writes:

> ...  I just noticed that org-ctags breaks CUSTOM_ID property links
> in the same way.  So I might submit a patch for that as well soon.

Improvements are always welcome!

I also see that you submitted a number of patches recently.
For now, your contribution size is fairly small, but if you plan to
contribute a lot more, please consider signing FSF copyright assignment.
See https://orgmode.org/worg/org-contribute.html#copyright

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: [PATCH] org-ctags: Fix regexp to not break radio targets

[Martin Marshall]

Ihor Radchenko <yantar92@posteo.net> writes:
> I also see that you submitted a number of patches recently.
> For now, your contribution size is fairly small, but if you plan to
> contribute a lot more, please consider signing FSF copyright assignment.
> See https://orgmode.org/worg/org-contribute.html#copyright

Thanks, I submitted a copyright assignment a year or two ago with
respect to a pull-request submitted for the which-key package.  Not sure
if it's project-specific, or if I'll need to submit a separate one
(which I'm happy to do of course).

-- 
Best regards,
Martin Marshall

Re: [PATCH] org-ctags: Fix regexp to not break radio targets

[Ihor Radchenko]

Martin Marshall <law@martinmarshall.com> writes:

> Ihor Radchenko <yantar92@posteo.net> writes:
>> I also see that you submitted a number of patches recently.
>> For now, your contribution size is fairly small, but if you plan to
>> contribute a lot more, please consider signing FSF copyright assignment.
>> See https://orgmode.org/worg/org-contribute.html#copyright
>
> Thanks, I submitted a copyright assignment a year or two ago with
> respect to a pull-request submitted for the which-key package.  Not sure
> if it's project-specific, or if I'll need to submit a separate one
> (which I'm happy to do of course).

If your assignment has "GNU Emacs" in it, you are good to go.

Bastien, may you please check FSF records?

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: [PATCH] org-ctags: Fix regexp to not break radio targets

[Martin Marshall]

Ihor Radchenko <yantar92@posteo.net> writes:

> If your assignment has "GNU Emacs" in it, you are good to go.

Just found the scanned copy.  It refers to "GNU EMACS (herein called
the Program)" in paragraph 1.(a).  :-D

Also, in case it helps locate it, there is "RT:1798288" under my name on
the first page.  And the date of my signature is "January 29, 2022".
This copy doesn't have the Deputy Director's signature.

-- 
Best regards,
Martin Marshall

Re: [PATCH] org-ctags: Fix regexp to not break radio targets

[Bastien Guerry]

Ihor Radchenko <yantar92@posteo.net> writes:

> Martin Marshall <law@martinmarshall.com> writes:
>
>> Ihor Radchenko <yantar92@posteo.net> writes:
>>> I also see that you submitted a number of patches recently.
>>> For now, your contribution size is fairly small, but if you plan to
>>> contribute a lot more, please consider signing FSF copyright assignment.
>>> See https://orgmode.org/worg/org-contribute.html#copyright
>>
>> Thanks, I submitted a copyright assignment a year or two ago with
>> respect to a pull-request submitted for the which-key package.  Not sure
>> if it's project-specific, or if I'll need to submit a separate one
>> (which I'm happy to do of course).
>
> If your assignment has "GNU Emacs" in it, you are good to go.
>
> Bastien, may you please check FSF records?

Yes, Martin's FSF record is okay.  Thanks!

-- 
 Bastien Guerry

Re: [PATCH] org-ctags: Fix regexp to not break radio targets

[Ihor Radchenko]

Bastien Guerry <bzg@gnu.org> writes:

>> Bastien, may you please check FSF records?
>
> Yes, Martin's FSF record is okay.  Thanks!

Updated our records.
https://git.sr.ht/~bzg/worg/commit/a93fa90a

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>