threads / patch / 33370

patchDocumentation: Strip texinfo anchors to avoid duplicates

Subject: [PATCH] Documentation: Strip texinfo anchors to avoid duplicates

## tl;dr

3 messages between Apr 3, 2013 and Apr 3, 2013. Diffs are folded; open one to read it.

replies: 2people: 2as markdown or json

Martin von Gagern· Apr 3, 2013, 19:54 UTC · lore
This keeps texinfo 5.x happy. See https://bugs.gentoo.org/464210.
Signed-off-by: Martin von Gagern <Martin.vGagern@gmx.net>
---
 Documentation/cat-texi.perl | 1 +
 1 file changed, 1 insertion(+)
Show changes to Documentation/cat-texi.perl +1 −0
diff --git a/Documentation/cat-texi.perl b/Documentation/cat-texi.perl
index dbc133c..b52660d 100755
--- a/Documentation/cat-texi.perl
+++ b/Documentation/cat-texi.perl
@@ -12,6 +12,7 @@ while (<STDIN>) {
 		push @menu, $1;
 	}
 	s/\(\@pxref{\[(URLS|REMOTES)\]}\)//;
+	s/\@anchor\{[^{}]*\}//g;
 	print TMP;
 }
 close TMP;

-- 
1.8.1.5
Junio C Hamano· Apr 3, 2013, 20:07 UTC · re: Martin von Gagern · lore

Re: [PATCH] Documentation: Strip texinfo anchors to avoid duplicates

Martin von Gagern <Martin.vGagern@gmx.net> writes:
> This keeps texinfo 5.x happy. See https://bugs.gentoo.org/464210.

I see why duplicates are bad, but does that mean not having any is better?

Show 18 quoted lines
>
> Signed-off-by: Martin von Gagern <Martin.vGagern@gmx.net>
> ---
>  Documentation/cat-texi.perl | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/Documentation/cat-texi.perl b/Documentation/cat-texi.perl
> index dbc133c..b52660d 100755
> --- a/Documentation/cat-texi.perl
> +++ b/Documentation/cat-texi.perl
> @@ -12,6 +12,7 @@ while (<STDIN>) {
>  		push @menu, $1;
>  	}
>  	s/\(\@pxref{\[(URLS|REMOTES)\]}\)//;
> +	s/\@anchor\{[^{}]*\}//g;
>  	print TMP;
>  }
>  close TMP;
Martin von Gagern· Apr 3, 2013, 21:08 UTC · re: Junio C Hamano · lore

Re: [PATCH] Documentation: Strip texinfo anchors to avoid duplicates

On 03.04.2013 22:07, Junio C Hamano wrote:
> I see why duplicates are bad, but does that mean not having any is
> better?

I'd say yes: duplicate anchors cause current versions of texinfo to reject the document outright, and older versions will likely cause a broken interpretation of any anchor names.

What are possible scenarios where anchors could be useful?
a) Internal cross reference. I'm not sure whether texinfo checks for
   broken internal links. If it does, it did not report any.
b) Goto command issued by the user. I suppose most users would be happy
   with node-level navigation, and not use it for navigation to
   sub-node sections.
c) URLs in bookmarks or mails. I suppose people are more likely to use
   the html documents built by asciidoc, instead of a version
   constructed from the texinfo document. So not our issue.
Did I miss a relevant use case?

Automatically (or even manually?) generated unique names might be better than none. But I'm not sure they are worth the trouble.

Martin von Gagern

← back to recent threads