Comment 1 Glen Barber 2014-01-09 02:17:34 UTC

Responsible Changed
From-To: freebsd-bugs->novel

Fix synopsis and assign.

Comment 2 Yasuhiro Kimura 2014-01-09 06:33:32 UTC

Hello,

This problem seems to happen with perl 5.18. Attached patch, obtained
from Debain, fixes it(While here, converted to new LIB_DEPENDS format).

On 9/01/2014 5:03 pm, Yasuhiro KIMURA wrote:
> This problem seems to happen with perl 5.18. Attached patch, obtained
> from Debain, fixes it(While here, converted to new LIB_DEPENDS format).

I put that patch in /usr/ports/security/gnutls and applied with patch
-p0 < patch-gnutls

Seems to work, no more error, and yes I was using perl 5.18.

-- 
David Cecchin

Hello,

Different problem here with perl 5.14 but solved by the same patch. I also
have to apply sed magic to remove a hardcoded /usr/bin/perl in
gnutls-2.12.23/doc/scripts/sort2.pl (I'm using
"perl_OPTIONS_UNSET+=USE_PERL", and "OPTIONS_UNSET=DOCS EXAMPLES" in case
it matters).

# pkg info | grep perl
perl5.14-5.14.4_4              Practical Extraction and Report Language
# portmaster security/gnutls
[...]
gmake[6]: Entering directory
`/usr/ports/security/gnutls/work/gnutls-2.12.23/doc'
echo "" > gnutls-api.texi-tmp
for i in ../lib/auth_anon.c ../lib/gnutls_privkey.c ../lib/gnutls_num.c
../lib/gnutls_mem.c ../lib/gnutls_record.c ../lib/auth_dhe_psk.c
../lib/gnutls_anon_cred.c ../lib/gnutls_psk.c ../lib/gnutls_ui.c
../lib/gnutls_helper.c ../lib/auth_dh_common.c ../lib/gnutls_rsa_export.c
../lib/gnutls_v2_compat.c ../lib/gnutls_global.c ../lib/gnutls_cert.c
../lib/crypto.c ../lib/ext_srp.c ../lib/gnutls_dh.c ../lib/x509_b64.c
../lib/auth_srp_rsa.c ../lib/gnutls_auth.c ../lib/pkcs11_secret.c
../lib/auth_dhe.c ../lib/ext_server_name.c ../lib/gnutls_algorithms.c
../lib/gnutls_session_pack.c ../lib/locks.c ../lib/gnutls_cipher.c
../lib/gnutls_priority.c ../lib/gnutls_mpi.c ../lib/gnutls_pk.c
../lib/pkcs11.c ../lib/gnutls_mbuffers.c ../lib/gnutls_errors.c
../lib/gnutls_hash_int.c ../lib/ext_safe_renegotiation.c ../lib/auth_psk.c
../lib/gnutls_extensions.c ../lib/gnutls_cipher_int.c
../lib/gnutls_dh_primes.c ../lib/auth_srp_sb64.c ../lib/auth_rsa.c
../lib/auth_srp.c ../lib/gnutls_asn1_tab.c ../lib/gnutls_handshake.c
../lib/auth_srp_passwd.c ../lib/pkcs11_privkey.c ../lib/auth_cert.c
../lib/gnutls_psk_netconf.c ../lib/ext_session_ticket.c
../lib/gnutls_supplemental.c ../lib/auth_rsa_export.c ../lib/gnutls_kx.c
../lib/gnutls_srp.c ../lib/gnutls_x509.c ../lib/gnutls_compress.c
../lib/ext_cert_type.c ../lib/debug.c ../lib/gnutls_str.c
../lib/cryptodev.c ../lib/gnutls_datum.c ../lib/crypto-api.c
../lib/random.c ../lib/gnutls_buffers.c ../lib/gnutls_constate.c
../lib/system.c ../lib/gnutls_sig.c ../lib/gnutls_db.c
../lib/pkix_asn1_tab.c ../lib/gnutls_pubkey.c ../lib/gnutls_session.c
../lib/ext_signature.c ../lib/gnutls_state.c ../lib/ext_max_record.c
../lib/auth_psk_passwd.c ../lib/pkcs11_write.c ../lib/gnutls_alert.c; do \
        echo -n "Creating documentation for file $i... " && \
        ./scripts/gdoc -texinfo $i >> gnutls-api.texi-tmp && \
        echo "ok"; \
done
Creating documentation for file ../lib/auth_anon.c...   CC     errcodes.o
./scripts/gdoc: not found
Creating documentation for file ../lib/gnutls_privkey.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/gnutls_num.c... ./scripts/gdoc: not
found
  CC     printlist.o
Creating documentation for file ../lib/gnutls_mem.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/gnutls_record.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/auth_dhe_psk.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/gnutls_anon_cred.c...
./scripts/gdoc: not found
Creating documentation for file ../lib/gnutls_psk.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/gnutls_ui.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/gnutls_helper.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/auth_dh_common.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/gnutls_rsa_export.c...
./scripts/gdoc: not found
Creating documentation for file ../lib/gnutls_v2_compat.c...
./scripts/gdoc: not found
Creating documentation for file ../lib/gnutls_global.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/gnutls_cert.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/crypto.c... ./scripts/gdoc: not found
Creating documentation for file ../lib/ext_srp.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/gnutls_dh.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/x509_b64.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/auth_srp_rsa.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/gnutls_auth.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/pkcs11_secret.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/auth_dhe.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/ext_server_name.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/gnutls_algorithms.c...
./scripts/gdoc: not found
Creating documentation for file ../lib/gnutls_session_pack.c...
./scripts/gdoc: not found
Creating documentation for file ../lib/locks.c... ./scripts/gdoc: not found
Creating documentation for file ../lib/gnutls_cipher.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/gnutls_priority.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/gnutls_mpi.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/gnutls_pk.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/pkcs11.c... ./scripts/gdoc: not found
Creating documentation for file ../lib/gnutls_mbuffers.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/gnutls_errors.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/gnutls_hash_int.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/ext_safe_renegotiation.c...
./scripts/gdoc: not found
Creating documentation for file ../lib/auth_psk.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/gnutls_extensions.c...
./scripts/gdoc: not found
Creating documentation for file ../lib/gnutls_cipher_int.c...
./scripts/gdoc: not found
Creating documentation for file ../lib/gnutls_dh_primes.c...
./scripts/gdoc: not found
Creating documentation for file ../lib/auth_srp_sb64.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/auth_rsa.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/auth_srp.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/gnutls_asn1_tab.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/gnutls_handshake.c...
./scripts/gdoc: not found
Creating documentation for file ../lib/auth_srp_passwd.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/pkcs11_privkey.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/auth_cert.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/gnutls_psk_netconf.c...
./scripts/gdoc: not found
Creating documentation for file ../lib/ext_session_ticket.c...
./scripts/gdoc: not found
Creating documentation for file ../lib/gnutls_supplemental.c...
./scripts/gdoc: not found
Creating documentation for file ../lib/auth_rsa_export.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/gnutls_kx.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/gnutls_srp.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/gnutls_x509.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/gnutls_compress.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/ext_cert_type.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/debug.c... ./scripts/gdoc: not found
Creating documentation for file ../lib/gnutls_str.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/cryptodev.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/gnutls_datum.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/crypto-api.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/random.c... ./scripts/gdoc: not found
Creating documentation for file ../lib/gnutls_buffers.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/gnutls_constate.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/system.c... ./scripts/gdoc: not found
Creating documentation for file ../lib/gnutls_sig.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/gnutls_db.c... ./scripts/gdoc: not
found
Creating documentation for file ../lib/pkix_asn1_tab.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/gnutls_pubkey.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/gnutls_session.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/ext_signature.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/gnutls_state.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/ext_max_record.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/auth_psk_passwd.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/pkcs11_write.c... ./scripts/gdoc:
not found
Creating documentation for file ../lib/gnutls_alert.c... ./scripts/gdoc:
not found
gmake[6]: *** [gnutls-api.texi] Error 127
gmake[6]: *** Waiting for unfinished jobs....
gmake[6]: Leaving directory
`/usr/ports/security/gnutls/work/gnutls-2.12.23/doc'
gmake[5]: *** [all-recursive] Error 1
gmake[5]: Leaving directory
`/usr/ports/security/gnutls/work/gnutls-2.12.23/doc'
gmake[4]: *** [all] Error 2
gmake[4]: Leaving directory
`/usr/ports/security/gnutls/work/gnutls-2.12.23/doc'
gmake[3]: *** [all-recursive] Erreur 1
gmake[3] : on quitte le répertoire «
/usr/ports/security/gnutls/work/gnutls-2.12.23 »
gmake[2]: *** [all] Erreur 2
gmake[2] : on quitte le répertoire «
/usr/ports/security/gnutls/work/gnutls-2.12.23 »
===> Compilation failed unexpectedly.
Try to set MAKE_JOBS_UNSAFE=yes and rebuild before reporting the failure to
the maintainer.
*** Error code 1

Stop.
make[1]: stopped in /usr/ports/security/gnutls
*** Error code 1

Stop.
make: stopped in /usr/ports/security/gnutls

===>>> make failed for security/gnutls
===>>> Aborting update

# cd /tmp
# fetch '
http://www.freebsd.org/cgi/query-pr.cgi?pr=ports%2F185595&getpatch=1'
# cd /usr/ports/security/gnutls
# make clean
# svn patch /tmp/query-pr.cgi\?pr=ports%2F185595\&getpatch=1
# make patch
# sed -i '' '1 s:/perl:/env perl:' work/gnutls-2.12.23/doc/scripts/sort2.pl
# portmaster -C security/gnutls
[...]

===>>> Upgrade of gnutls-2.12.23_2 to gnutls-2.12.23_3 complete

===>>> Exiting

-- 
Olivier Smedts                                                 _
                                        ASCII ribbon campaign ( )
e-mail: olivier@gid0.org        - against HTML email & vCards  X
www: http://www.gid0.org    - against proprietary attachments / \

  "Il y a seulement 10 sortes de gens dans le monde :
  ceux qui comprennent le binaire,
  et ceux qui ne le comprennent pas."

Comment 5 Yasuhiro Kimura 2014-01-09 11:49:21 UTC

Hello Olivier,

I have updated patch so shebang line of doc/scripts/sort2.pl should be 
fixed properly. Would you please try and check if it works fine?

Best Regards.

Comment 6 Roman Bogorodskiy 2014-01-09 14:01:34 UTC

Hi Yasuhiro!

Thanks for the fix! One thing not clear from the fix is why
don't you add gdoc script to SHEBANG_FILES?

Thanks,
Roman Bogorodskiy

Comment 7 Yasuhiro Kimura 2014-01-11 08:28:32 UTC

Hi Roman,

After files/patch-doc-scripts-gdoc is applied the first line of
doc/scripts/gdoc is modified as following:

yasu@eastasia[23807]% head doc/scripts/gdoc
eval '(exit $?0)' && eval 'exec perl "$0" ${1+"$@"}'
  & eval 'exec perl "$0" $argv:q'
    if 0;

## Copyright (c) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Simon
Josefsson
##                    added -texinfo, -listfunc, -pkg-name
##                    man page revamp
##                    various improvements
## Copyright (c) 2001, 2002 Nikos Mavrogiannopoulos
##                    added -tex
yasu@eastasia[23808]%

So shebang fixing is not necessary.

The reason of change is simply because original patch from Debian does
it. I don't know why Debian maintainer modified shebang line as above.
But it seems work fine anyway.

Best regards.

Comment 8 Roman Bogorodskiy 2014-01-11 20:26:24 UTC

  Yasuhiro KIMURA wrote:

> Hi Roman,
> 
> After files/patch-doc-scripts-gdoc is applied the first line of
> doc/scripts/gdoc is modified as following:
> 
> yasu@eastasia[23807]% head doc/scripts/gdoc
> eval '(exit $?0)' && eval 'exec perl "$0" ${1+"$@"}'
>   & eval 'exec perl "$0" $argv:q'
>     if 0;
> 
> ## Copyright (c) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Simon
> Josefsson
> ##                    added -texinfo, -listfunc, -pkg-name
> ##                    man page revamp
> ##                    various improvements
> ## Copyright (c) 2001, 2002 Nikos Mavrogiannopoulos
> ##                    added -tex
> yasu@eastasia[23808]%
> 
> So shebang fixing is not necessary.
> 
> The reason of change is simply because original patch from Debian does
> it. I don't know why Debian maintainer modified shebang line as above.
> But it seems work fine anyway.

I see, thanks for the explanation.

Meanwhile, marino@ committed a partial fix:

http://docs.freebsd.org/cgi/getmsg.cgi?fetch=5104828+0+current/svn-ports-all

I've asked him to review this change, because I'm not good at perl.

Thanks,

Roman Bogorodskiy

Comment 9 dfilter service 2014-01-13 11:31:17 UTC

Author: novel
Date: Mon Jan 13 11:31:03 2014
New Revision: 339583
URL: http://svnweb.freebsd.org/changeset/ports/339583

Log:
  Fix build with perl 5.18.
  
  PR:		185595
  Reviewed by:	marino
  Obtained from:	Debian

Added:
  head/security/gnutls/files/patch-doc-scripts-gdoc   (contents, props changed)

Added: head/security/gnutls/files/patch-doc-scripts-gdoc
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ head/security/gnutls/files/patch-doc-scripts-gdoc	Mon Jan 13 11:31:03 2014	(r339583)
@@ -0,0 +1,612 @@
+--- doc/scripts/gdoc.orig	2014-01-13 15:08:22.000000000 +0400
++++ doc/scripts/gdoc	2014-01-13 15:10:10.000000000 +0400
+@@ -7,6 +7,8 @@
+ ## Copyright (c) 2001, 2002 Nikos Mavrogiannopoulos
+ ##                    added -tex
+ ## Copyright (c) 1998 Michael Zucchi
++## Copyright (c) 2013 Adam Sampson
++##                    made highlighting not depend on hash order, for Perl 5.18
+ 
+ # This program is free software: you can redistribute it and/or modify
+ # it under the terms of the GNU General Public License as published by
+@@ -132,57 +134,59 @@
+ use POSIX qw(strftime);
+ 
+ # match expressions used to find embedded type information
+-$type_constant = "((?<!\")\\\%(\\w+))";
+-$type_func = "(\\w+\\(\\))";
+-$type_param = "\\\@(\\w+)";
+-$type_struct = "\\\#(\\w+)";
+-$type_env = "(\\\$\\w+)";
++$type_constant = "\\\%([A-Za-z0-9_]+)";
++$type_func = "([A-Za-z0-9_]+\\(\\))";
++$type_param = '\@([A-Za-z0-9_]+)\s*';
++$type_struct = "\\\#([A-Za-z0-9_]+)";
++$type_env = "(\\\$[A-Za-z0-9_]+)";
+ 
+ 
+ # Output conversion substitutions.
+ #  One for each output format
+ 
+ # these work fairly well
+-%highlights_html = ( $type_constant, "<i>\$2</i>",
+-		     $type_func, "<b>\$1</b>",
+-		     $type_struct, "<i>\$1</i>",
+-		     $type_param, "<tt><b>\$1</b></tt>" );
++@highlights_html = ( [$type_constant, '"<i>$1</i>"'],
++		     [$type_func, '"<b>$1</b>"'],
++		     [$type_struct, '"<i>$1</i>"'],
++		     [$type_param, '" <tt><b>$1</b></tt> "'] );
+ $blankline_html = "<p>";
+ 
+-%highlights_texinfo = ( $type_constant, "\\\@code{\$2}",
+-			$type_func, "\\\@code{\$1}",
+-			$type_struct, "\\\@code{\$1}",
+-			$type_param, "\\\@code{\$1}" );
++@highlights_texinfo = ( [$type_param, '" \@code{$1} "'],
++			[$type_constant, '"\@code{$1} "'],
++			[$type_func, '"\@code{$1} "'],
++			[$type_struct, '"\@code{$1} "'],
++			 );
+ $blankline_texinfo = "";
+ 
+-%highlights_tex = ( $type_constant, "{\\\\it \$2}",
+-		     $type_func, "{\\\\bf \$1}",
+-		     $type_struct, "{\\\\it \$1}",
+-		     $type_param, "{\\\\bf \$1}" );
++@highlights_tex = ( [$type_param, '" {\\\bf $1} "'],
++		[$type_constant, '"{\\\it $1}"'],
++		[$type_func, '"{\\\bf $1}"'],
++		[$type_struct, '"{\\\it $1}"'],
++		      );
+ $blankline_tex = "\\\\";
+ 
+ # sgml, docbook format
+-%highlights_sgml = ( $type_constant, "<replaceable class=\"option\">\$2</replaceable>",
+-		     $type_func, "<function>\$1</function>",
+-		     $type_struct, "<structname>\$1</structname>",
+-		     $type_env, "<envar>\$1</envar>",
+-		     $type_param, "<parameter>\$1</parameter>" );
++@highlights_sgml = ( [$type_constant, '"<replaceable class=\"option\">$1</replaceable>"'],
++		     [$type_func, '"<function>$1</function>"'],
++		     [$type_struct, '"<structname>$1</structname>"'],
++		     [$type_env, '"<envar>$1</envar>"'],
++		     [$type_param, '" <parameter>$1</parameter> "'] );
+ $blankline_sgml = "</para><para>\n";
+ 
+ # these are pretty rough
+-%highlights_man = ( $type_constant, "\\\\fB\$2\\\\fP",
+-		    $type_func, "\\\\fB\$1\\\\fP",
+-		    $type_struct, "\\\\fB\$1\\\\fP",
+-		    $type_param, "\\\\fI\$1\\\\fP" );
++@highlights_man = ( [$type_constant, '"\\\fB$1\\\fP"'],
++		    [$type_func, '"\\\fB$1\\\fP"'],
++		    [$type_struct, '"\\\fB$1\\\fP"'],
++		    [$type_param, '" \\\fI$1\\\fP "'] );
+ $blankline_man = "";
+ 
+ # text-mode
+-%highlights_text = ( $type_constant, "\$2",
+-		     $type_func, "\$1",
+-		     $type_struct, "\$1",
+-		     $type_param, "\$1" );
++@highlights_text = ( [$type_constant, '"$1"'],
++		     [$type_func, '"$1"'],
++		     [$type_struct, '"$1"'],
++		     [$type_param, '"$1 "'] );
+ $blankline_text = "";
+-
++my $lineprefix = "";
+ 
+ sub usage {
+     print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man | -tex | -texinfo  -listfunc ]\n";
+@@ -201,7 +205,7 @@
+ 
+ $verbose = 0;
+ $output_mode = "man";
+-%highlights = %highlights_man;
++@highlights = @highlights_man;
+ $blankline = $blankline_man;
+ $modulename = "API Documentation";
+ $sourceversion = strftime "%Y-%m-%d", localtime;
+@@ -210,27 +214,27 @@
+     $cmd = shift @ARGV;
+     if ($cmd eq "-html") {
+ 	$output_mode = "html";
+-	%highlights = %highlights_html;
++	@highlights = @highlights_html;
+ 	$blankline = $blankline_html;
+     } elsif ($cmd eq "-man") {
+ 	$output_mode = "man";
+-	%highlights = %highlights_man;
++	@highlights = @highlights_man;
+ 	$blankline = $blankline_man;
+     } elsif ($cmd eq "-tex") {
+ 	$output_mode = "tex";
+-	%highlights = %highlights_tex;
++	@highlights = @highlights_tex;
+ 	$blankline = $blankline_tex;
+     } elsif ($cmd eq "-texinfo") {
+ 	$output_mode = "texinfo";
+-	%highlights = %highlights_texinfo;
++	@highlights = @highlights_texinfo;
+ 	$blankline = $blankline_texinfo;
+     } elsif ($cmd eq "-text") {
+ 	$output_mode = "text";
+-	%highlights = %highlights_text;
++	@highlights = @highlights_text;
+ 	$blankline = $blankline_text;
+     } elsif ($cmd eq "-docbook") {
+ 	$output_mode = "sgml";
+-	%highlights = %highlights_sgml;
++	@highlights = @highlights_sgml;
+ 	$blankline = $blankline_sgml;
+     } elsif ($cmd eq "-listfunc") {
+ 	$output_mode = "listfunc";
+@@ -270,6 +274,8 @@
+     my $name = shift @_;
+     my $contents = join "\n", @_;
+ 
++    $name = " $name";
++
+     if ($name =~ m/$type_constant/) {
+ 	$name = $1;
+ #	print STDERR "constant section '$1' = '$contents'\n";
+@@ -280,6 +286,7 @@
+ 	$parameters{$name} = $contents;
+     } else {
+ #	print STDERR "other section '$name' = '$contents'\n";
++	$name =~ tr/ //d;
+ 	$sections{$name} = $contents;
+ 	push @sectionlist, $name;
+     }
+@@ -296,35 +303,15 @@
+ #  sections => %descriont descriptions
+ #  
+ 
+-sub repstr {
+-    $pattern = shift;
+-    $repl = shift;
+-    $match1 = shift;
+-    $match2 = shift;
+-    $match3 = shift;
+-    $match4 = shift;
+-
+-    $output = $repl;
+-    $output =~ s,\$1,$match1,g;
+-    $output =~ s,\$2,$match2,g;
+-    $output =~ s,\$3,$match3,g;
+-    $output =~ s,\$4,$match4,g;
+-
+-    eval "\$return = qq/$output/";
+-
+-#    print "pattern $pattern matched 1=$match1 2=$match2 3=$match3 4=$match4 replace $repl yielded $output interpolated $return\n";
+-
+-    $return;
+-}
+-
+ sub just_highlight {
+     my $contents = join "\n", @_;
+     my $line;
+     my $ret = "";
+ 
+-    foreach $pattern (keys %highlights) {
+-#	print "scanning pattern $pattern ($highlights{$pattern})\n";
+-	$contents =~ s:$pattern:repstr($pattern, $highlights{$pattern}, $1, $2, $3, $4):gse;
++    foreach $highlight (@highlights) {
++	my ($pattern, $replace) = @$highlight;
++	#print "scanning pattern $pattern ($replace)\n";
++	$contents =~ s/$pattern/$replace/gees;
+     }
+     foreach $line (split "\n", $contents) {
+ 	if ($line eq ""){
+@@ -370,13 +357,45 @@
+ 	}
+     }
+     foreach $section (@{$args{'sectionlist'}}) {
++	$section =~ s/\@//g;
+ 	print "\n\@strong{$section:} " if $section ne $section_default;
+-	$args{'sections'}{$section} =~ s:([{}]):\@\1:gs;
++	$args{'sections'}{$section} =~ s:([{}]):\@$1:gs;
+ 	output_highlight($args{'sections'}{$section});
+     }
+     print "\@end deftypefun\n\n";
+ }
+ 
++sub output_enum_texinfo {
++    my %args = %{$_[0]};
++    my ($parameter, $section);
++    my $count;
++    my $name = $args{'enum'};
++    my $param;
++    my $param2;
++    my $sec;
++    my $check;
++    my $type;
++
++    print "\n\@c $name\n";
++    print "\@table \@code\n";
++
++    $check=0;
++    foreach $parameter (@{$args{'parameterlist'}}) {
++        $param1 = $parameter;
++	$param1 =~ s/_/_\@-/g;
++
++	$check = 1;
++	print "\@item ".$param1."\n";
++#	print "\n";
++
++        $param2 = $args{'parameters'}{$parameter};
++	$out = just_highlight($param2);
++	chomp $out;
++	print $out . "\n";
++    }
++    print "\@end table\n";
++}
++
+ # output in html
+ sub output_html {
+     my %args = %{$_[0]};
+@@ -428,7 +447,9 @@
+ 
+     $func =~ s/_/\\_/g;
+ 
+-    print "\n\n\\subsection{". $func . "}\n\\label{" . $args{'function'} . "}\n";
++    print "\n\n\\begin{function}\n";
++    print "\\functionTitle{". $func . "}\n";
++    print "\\index{". $func . "}\n";
+ 
+     $type = $args{'functiontype'};
+     $type =~ s/_/\\_/g;
+@@ -451,9 +472,8 @@
+     }
+     print ")\n";
+ 
+-    print "\n{\\large{Arguments}}\n";
++    print "\n\\begin{functionArguments}\n";
+ 
+-    print "\\begin{itemize}\n";
+     $check=0;
+     foreach $parameter (@{$args{'parameterlist'}}) {
+         $param1 = $args{'parametertypes'}{$parameter};
+@@ -462,11 +482,12 @@
+ 	$param2 =~ s/_/\\_/g;
+ 
+ 	$check = 1;
+-	print "\\item {\\it ".$param1."} {\\bf ".$param2."}: \n";
++	print "\\functionArgument {\\it ".$param1."} {\\bf ".$param2."}: \n";
+ #	print "\n";
+ 
+ 	$param3 = $args{'parameters'}{$parameter};
+-	$param3 =~ s/#([a-zA-Z\_]+)/{\\it \1}/g;
++	$param3 =~ s/\#([a-zA-Z\_]+)/{\\it $1}/g;
++	$param3 =~ s/\%([a-zA-Z\_]+)/{\\bf $1}/g;
+ 
+ 	$out = just_highlight($param3);
+ 	$out =~ s/_/\\_/g;
+@@ -475,31 +496,72 @@
+     if ($check==0) {
+ 	print "\\item void\n";
+     }
+-    print "\\end{itemize}\n";
++    print "\\end{functionArguments}\n";
+ 
+     foreach $section (@{$args{'sectionlist'}}) {
+ 	$sec = $section;
+ 	$sec =~ s/_/\\_/g;
+-	$sec =~ s/#([a-zA-Z\_]+)/{\\it \1}/g;
++	$sec =~ s/#([a-zA-Z\_]+)/{\\it $1}/g;
+ 
+-	print "\n{\\large{$sec}}\\\\\n";
+-	print "\\begin{rmfamily}\n";
++	print "\n\\begin{function${sec}}\n";
++	$out = $args{'sections'}{$section};
+ 
+-	$sec = $args{'sections'}{$section};
+-	$sec =~ s/\\:/:/g;
+-	$sec =~ s/#([a-zA-Z\_]+)/{\\it \1}/g;
+-	$sec =~ s/->/\$\\rightarrow\$/g;
+-	$sec =~ s/([0-9]+)\^([0-9]+)/\$\{\1\}\^\{\2\}\$/g;
+-
+-	$out = just_highlight($sec);
+-	$out =~ s/_/\\_/g;
++	$out =~ s/\#([a-zA-Z\_]+)/{\\it $1}/g;
++	$out =~ s/\%([a-zA-Z\_]+)/{\\bf $1}/g;
++	$out =~ s/\@([a-zA-Z\_]+)/{\\bf $1}/g;
++	$out =~ s/_/\\_\\-/g;
++        $out =~ s/\$/\\\$/g;
++	$out =~ s/#/\\#/g;
++	$out =~ s/\n\n/\n/g;
++	$out =~ s/\\:/:/g;
++	$out =~ s/\-\>/\$\\rightarrow\$/g;
++	$out =~ s/([0-9]+)\^([0-9]+)/\$\{$1\}\^\{$2\}\$/g;
+ 
+ 	print $out;
+-	print "\\end{rmfamily}\n";
++	print "\\end{function${sec}}\n";
+     }
+-    print "\n";
++    print "\\end{function}\n\n";
+ }
+ 
++sub output_enum_tex {
++    my %args = %{$_[0]};
++    my ($parameter, $section);
++    my $count;
++    my $name = $args{'enum'};
++    my $param;
++    my $param2;
++    my $sec;
++    my $check;
++    my $type;
++
++    print "\n\n\\begin{enum}\n";
++    $name =~ s/_/\\_/g;
++    print "\\enumTitle{". $name . "}\n";
++    print "\\index{". $name . "}\n";
++
++    print "\n\\begin{enumList}\n";
++
++    $check=0;
++    foreach $parameter (@{$args{'parameterlist'}}) {
++        $param1 = $parameter;
++	$param1 =~ s/_/\\_\\-/g;
++
++	$check = 1;
++	print "\\enumElement{".$param1."}{";
++#	print "\n";
++
++        $param2 = $args{'parameters'}{$parameter};
++	$param2 =~ s/\#([a-zA-Z\_]+)/{\\it $1}/g;
++	$param2 =~ s/\%([a-zA-Z\_]+)/{\\bf $1}/g;
++	$out = just_highlight($param2);
++	$out =~ s/_/\\_/g;
++	chomp $out;
++	print $out . "}\n";
++    }
++    print "\\end{enumList}\n";
++
++    print "\\end{enum}\n\n";
++}
+ 
+ # output in sgml DocBook
+ sub output_sgml {
+@@ -639,11 +701,14 @@
+     if ($args{'bugsto'}) {
+ 	print ".SH \"REPORTING BUGS\"\n";
+ 	print "Report bugs to <". $args{'bugsto'} . ">.\n";
++        print ".br\n";
++	print "General guidelines for reporting bugs: http://www.gnu.org/gethelp/\n";
++        print ".br\n";
+ 	if ($args{'pkgname'}) {
+ 	    print $args{'pkgname'} . " home page: " .
+ 		"http://www.gnu.org/software/" . $args{'module'} . "/\n";
+ 	}
+-	print "General help using GNU software: http://www.gnu.org/gethelp/\n";
++	print "\n";
+     }
+ 
+     if ($args{'copyright'}) {
+@@ -670,6 +735,10 @@
+ 	print ".B info " . $args{'seeinfo'} . "\n";
+ 	print ".PP\n";
+ 	print "should give you access to the complete manual.\n";
++	print "As an alternative you may obtain the manual from:\n";
++	print ".IP\n";
++	print ".B http://www.gnu.org/software/" . $args{'module'} . "/manual/\n";
++	print ".PP\n";
+     }
+ }
+ 
+@@ -705,6 +774,10 @@
+     eval "output_".$output_mode."(\@_);";
+ }
+ 
++sub output_enum {
++    eval "output_enum_".$output_mode."(\@_);";
++}
++
+ 
+ ##
+ # takes a function prototype and spits out all the details
+@@ -744,7 +817,7 @@
+ #	    print STDERR " :> @args\n";
+ 	    $type = join " ", @args;
+ 
+-	    if ($parameters{$param} eq "" && $param != "void") {
++	    if ((!defined($parameters{$param}) || $parameters{$param} eq "") && $param ne "void") {
+ 		$parameters{$param} = "-- undescribed --";
+ 		print STDERR "warning: $lineno: Function parameter '$param' not described in '$function_name'\n";
+ 	    }
+@@ -781,6 +854,56 @@
+     }
+ }
+ 
++sub dump_enum {
++    my $prototype = shift @_;
++
++    if (($prototype =~ m/^\s*typedef\s+enum\s*[a-zA-Z0-9_~:]*\s*\{([\-a-zA-Z0-9_~=,:\s\(\)\<]+)\s*\}\s*([a-zA-Z0-9_]+);.*/)) {
++#        || $prototype =~ m/^\s*enum\s+([a-zA-Z0-9_~:]+).*/) {
++        $args = $1;
++	$name = $2;
++
++	foreach $arg (split ',', $args) {
++	    # strip leading/trailing spaces
++	    $arg =~ s/^\s*//;
++	    $arg =~ s/\s*$//;
++	    $arg =~ s/([A-Za-z0-9_]+)\s*=.*/$1/g;
++#	    print STDERR "SCAN ARG: '$arg'\n";
++
++            next if $arg eq '';
++	    if ((!defined($parameters{$arg}) || $parameters{$arg} eq "")) {
++		$parameters{$arg} = "-- undescribed --";
++		print STDERR "warning: $lineno: Enumeration parameter '$arg' not described in '$name'\n";
++	    }
++
++	    push @parameterlist, $arg;
++
++#	    print STDERR "param = '$arg'\n";
++	}
++    } else {
++#	print STDERR "warning: $lineno: Cannot understand enumeration: '$prototype'\n";
++	return;
++    }
++
++    output_enum({'enum' => $name,
++			 'module' => $modulename,
++			 'sourceversion' => $sourceversion,
++			 'include' => $include,
++			 'includefuncprefix' => $includefuncprefix,
++			 'bugsto' => $bugsto,
++			 'pkgname' => $pkgname,
++			 'copyright' => $copyright,
++			 'verbatimcopying' => $verbatimcopying,
++			 'seeinfo' => $seeinfo,
++			 'functiontype' => $return_type,
++			 'parameterlist' => \@parameterlist,
++			 'parameters' => \%parameters,
++			 'parametertypes' => \%parametertypes,
++			 'sectionlist' => \@sectionlist,
++			 'sections' => \%sections,
++			 'purpose' => $function_purpose
++			 });
++}
++
+ ######################################################################
+ # main
+ # states
+@@ -797,7 +920,7 @@
+ $doc_end = "\\*/";
+ $doc_com = "\\s*\\*\\s*";
+ $doc_func = $doc_com."(\\w+):?";
+-$doc_sect = $doc_com."([".$doc_special."[:upper:]][\\w ]+):\\s*(.*)";
++$doc_sect = $doc_com."([".$doc_special."[:upper:]][\\w]+):\\s*(.*)";
+ $doc_content = $doc_com."(.*)";
+ 
+ %constants = ();
+@@ -809,6 +932,7 @@
+ $contents = "";
+ $section_default = "Description";	# default section
+ $section = $section_default;
++$enum = 0;
+ 
+ $lineno = 0;
+ foreach $file (@ARGV) {
+@@ -816,18 +940,21 @@
+ 	print STDERR "Error: Cannot open file $file\n";
+ 	next;
+     }
+-    while (<IN>) {
++    while ($line = <IN>) {
+ 	$lineno++;
+ 
+ 	if ($state == 0) {
+-	    if (/$doc_start/o) {
++	    if ($line =~ /$doc_start/o) {
+ 		$state = 1;		# next line is always the function name
++#	    print STDERR "XXX: start of doc comment\n";
+ 	    }
+ 	} elsif ($state == 1) {	# this line is the function name (always)
+-	    if (/$doc_func/o) {
++	    if ($line =~ /$doc_func/o) {
+ 		$function = $1;
+ 		$state = 2;
+-		if (/-\s*(.*)/) {
++#	    print STDERR "XXX: start of doc comment, looking for prototype\n";
++
++		if ($line =~ /-\s*(.*)/) {
+ 		    $function_purpose = $1;
+ 		} else {
+ 		    $function_purpose = "";
+@@ -841,11 +968,11 @@
+ 		$state = 0;
+ 	    }
+ 	} elsif ($state == 2) {	# look for head: lines, and include content
+-	    if (/$doc_sect/o) {
++	    if ($line =~ /$doc_sect/o) {
+ 		$newsection = $1;
+ 		$newcontents = $2;
+ 
+-		if ($contents ne "") {
++		if ($contents ne '') {
+ 		    dump_section($section, $contents);
+ 		    $section = $section_default;
+ 		}
+@@ -855,7 +982,7 @@
+ 		    $contents .= "\n";
+ 		}
+ 		$section = $newsection;
+-	    } elsif (/$doc_end/) {
++	    } elsif ($line =~ /$doc_end/) {
+ 
+ 		if ($contents ne "") {
+ 		    dump_section($section, $contents);
+@@ -863,13 +990,12 @@
+ 		    $contents = "";
+ 		}
+ 
+-#	    print STDERR "end of doc comment, looking for prototype\n";
+ 		$prototype = "";
+ 		$state = 3;
+-	    } elsif (/$doc_content/) {
++	    } elsif ($line =~ /$doc_content/) {
+ 		# miguel-style comment kludge, look for blank lines after
+ 		# @parameter line to signify start of description
+-		if ($1 eq "" && $section =~ m/^@/) {
++		if ($1 eq '' && $section =~ m/^@/) {
+ 		    dump_section($section, $contents);
+ 		    $section = $section_default;
+ 		    $contents = "";
+@@ -881,13 +1007,16 @@
+ 		print STDERR "warning: $lineno: Bad line: $_";
+ 	    }
+ 	} elsif ($state == 3) {	# scanning for function { (end of prototype)
+-	    if (m#\s*/\*\s+MACDOC\s*#io) {
++	    if ($line =~ m#\s*/\*\s+MACDOC\s*#io) {
+ 	      # do nothing
+ 	    }
+-	    elsif (/([^\{]*)/) {
++	    elsif ($enum == 1 && $line =~ /(^\s*\{).*/) {
++		$prototype .= "{";
++	    }
++	    elsif ($line =~ /([^\{]*)/) {
+ 		$prototype .= $1;
+ 	    }
+-	    if (/\{/) {
++	    if ($enum == 0 && $line =~ /\{/) {
+ 		$prototype =~ s@/\*.*?\*/@@gos;	# strip comments.
+ 		$prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
+ 		$prototype =~ s@^ +@@gos; # strip leading spaces
+@@ -901,9 +1030,32 @@
+ 		%sections = ();
+ 		@sectionlist = ();
+ 		$prototype = "";
++		$enum = 0;
+ 
+ 		$state = 0;
+ 	    }
++	    elsif ($enum == 1 && $line =~ /\}/) {
++		$prototype =~ s@/\*.*?\*/@@gos;	# strip comments.
++		$prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
++		$prototype =~ s@^ +@@gos; # strip leading spaces
++		dump_enum($prototype);
++
++		$function = "";
++		%constants = ();
++		%parameters = ();
++		%parametertypes = ();
++		@parameterlist = ();
++		%sections = ();
++		@sectionlist = ();
++		$prototype = "";
++		$enum = 0;
++
++		$state = 0;
++	    }
++	    elsif ($line =~ /([a-zA-Z\s]+)enum(.*)$/) {
++	        $enum = 1;
++	    }
++    
+ 	}
+     }
+ }
_______________________________________________
svn-ports-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-ports-all
To unsubscribe, send any mail to "svn-ports-all-unsubscribe@freebsd.org"

Comment 10 Roman Bogorodskiy 2014-01-13 15:11:26 UTC

State Changed
From-To: open->closed

Should be fixed now.