id	summary	reporter	owner	description	type	status	priority	milestone	component	version	severity	resolution	keywords	cc	lang	patch	platform
1725	tools/build/headerizer.pl:  documentation is confusing	jkeenan	jkeenan	"The POD for this program has two sections called `NAME` and two called `SYNOPSIS`.  The material in `DESCRIPTION`, `DIRECTIVES` and perhaps some other sections would be better combined into one `=head1`.
{{{
$ grep -nE '^=head(1|2)' tools/build/headerizer.pl 
5:=head1 NAME
10:=head1 SYNOPSIS
14:=head1 DESCRIPTION
20:=head1 TODO
26:=head1 NOTES
35:=head1 COMMAND-LINE OPTIONS
45:=head1 COMMAND-LINE ARGUMENTS
69:=head1 FUNCTIONS
71:=head2 extract_function_declaration_and_update_source( $cfile_name )
446:=head1 NAME
450:=head1 SYNOPSIS
457:=head1 DIRECTIVES
}}}
So, a fresh look at this file's documentation is in order.

Thank you very much.

kid51"	todo	closed	normal		docs	2.6.0	medium	fixed		mikehh petdance		applied