Compile error on FreeBSD: `idn2-help.texi': No such file or directory.

./libidn2.texi:6: warning: unrecognized encoding name `utf-8'.
./libidn2.texi:489: @verbatiminclude `idn2-help.texi': No such file or directory.

In /var/ports/usr/ports/dns/libidn2/work/libidn2-2.3.1/doc/libidn2.texi:

  4 @include version.texi
  5 @documentencoding utf-8
  6 @settitle Libidn2 @value{VERSION}
...
484 @code{idn2 -r -- -foo}.
485
486 @section Options
487 @code{idn2} recognizes these commands:
488
489 @verbatiminclude idn2--help.texi
490
491 @section Environment Variables
492


# find / -name "idn2-help.texi"

no results

but
# find / -name "idn2--help.texi"
/var/ports/usr/ports/dns/libidn2/work/libidn2-2.3.1/doc/idn2--help.texi

Unfortunately the work directory doesn't persist between rebuilds or it would be easy to test the -- vs. -

It appears the core of the bug is BSD vs. Linux Grep syntax.
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=255999

As a workaround, see attached patches for Makefile and pkg-plist. This builds and installs:

===>>> Deleting stale distfile: libidn2-2.3.0.tar.gz
===>>> Installation of dns/libidn2 (libidn2-2.3.1) complete

It'd be nice if the OPTIONS_UNSET += DEBUG DOCS EXAMPLES make.conf directive was respected.

Makefile.patch pkg-plist.patch

./libidn2.texi:489: @verbatiminclude `idn2-help.texi': No such file or directory.

I can't reproduce that error message when idn2--help.texi is missing. Which makeinfo version are you using?

jas@latte:~/src/libidn2/doc$ makeinfo --version|head -1
texi2any (GNU texinfo) 6.7
jas@latte:~/src/libidn2/doc$ makeinfo -I . -o libidn2.info libidn2.texi 
libidn2.texi:489: @verbatiminclude: could not find idn2--help.texi
jas@latte:~/src/libidn2/doc$

However I don't believe this has anything to do with the real problem, it was a red herring. Most likely some older 'makeinfo' was confused about `--' in filenames somehow.

It appears the core of the bug is BSD vs. Linux Grep syntax.
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=255999

Indeed, thanks for the pointer! Requiring GNU grep was not intentional. Unfortunately I don't have any GitLab CI/CD FreeBSD runner (help most welcome!) that would have caught this, so I have to rely on manual bug reports like this one.

Let me try to find a FreeBSD box to experiment with a better command to filter out the `idn2 --help'.

@dgessel, what FreeBSD version are you using? Which grep did ./configure find for you? It appears to be working on a FreeBSD 13 box that I found.

$ echo foo|/usr/bin/grep '^ \+-'
$ echo ' -foo'|/usr/bin/grep '^ \+-'
 -foo
$ grep --version
grep (BSD grep, GNU compatible) 2.6.0-FreeBSD
$ uname -a
FreeBSD gcc303 13.0-RELEASE-p3 FreeBSD 13.0-RELEASE-p3 #0: Tue Jun 29 19:46:20 UTC 2021     root@amd64-builder.daemonology.net:/usr/obj/usr/src/amd64.amd64/sys/GENERIC  amd64
$

FreeBSD 11.3-RELEASE-p8 #0 r360490

root@claudel:/usr/ports/dns/libidn2 # echo foo|/usr/bin/grep '^ +-' root@claudel:/usr/ports/dns/libidn2 # echo ' -foo'|/usr/bin/grep '^ +-' -foo root@claudel:/usr/ports/dns/libidn2 # grep --version grep (GNU grep) 2.5.1-FreeBSD

makeinfo --version|head -1

makeinfo (GNU texinfo) 4.8

Olde version - I'm overseas since the start of Corona and am not comfortable doing a major remote update of my servers in case something goes wrong.

It may be an issue which doesn't occur in newer versions, though I'd guess 11.4 wouldn't be meaningfully different than 11.3. Simply adding the directives to parse OPTIONS_UNSET += DEBUG DOCS EXAMPLES in the Make file should suffice, no?

-David

Thank you! Meanwhile, I was able to reproduce this on an OpenBSD box that I found, including the strange idn2-help.texi error. I'll try to fix this properly.

I don't understand your comment about OPTIONS_UNSET though, isn't that something for the ports makefile to worry about? Is there anything that should go into upstream libidn2 about that? I'm not familiar with that variable or what it does.

Ok I believe I have identified and reproduced the two problems at hand here.

Older makeinfo (version < 5?) appears to not handle `--' in included filenames properly, it shows the output you got. I'll change the filename.

The second problem is the grep command failing, and I could reproduce it on OpenBSD 6.8:

gcc220$ echo foo|grep '^ \+-'  
gcc220$ echo $?
1
gcc220$ echo -foo|grep '^ \+-' 
gcc220$ echo $?
1
gcc220$

Changing the ' +' into ' *' ought to be identical, and worked fine:

gcc220$ echo ' -foo'|grep '^  *-' 
 -foo
gcc220$

I'm not sure this is required to work on all grep's out there, but I'll leave that for others to test and report.

mentioned in commit 64e483a4

The make file reference is really FreeBSD specific. If you look in /etc/make.conf on the BSD box you have, there are central make configuration options (I find this very convenient compared to building on the Linux flavors I'm familiar with). A common option set for servers is OPTIONS_UNSET += DEBUG DOCS EXAMPLES, which tells ports not to build documentation, debug symbols, or examples (for example).

The FreeBSD makefile for this port is maintained by # Created by: Sunpoet Po-Chuan Hsieh <sunpoet@FreeBSD.org> (who maintains quite a few ports, thank you Po-Chuan!)

Another option is to add a configurable variable so that # make config would toggle building documentation.

I'm happy to test and at least verify that FreeBSD 11.3 is resolved.

mentioned in merge request !89 (merged)

closed with commit 64e483a4

Compile error on FreeBSD: `idn2-help.texi': No such file or directory.

Designs

Child items 0

Activity

makeinfo --version|head -1