[hcoop/debian/openafs.git] / doc / man-pages / check-pod

#!/usr/bin/perl
#
# Written by Jason Edgecombe based on the Test::Pod documentation.  The
# best way to run it is to run:
#
#     prove check-pod
#
# from the doc/man-pages directory, which will show any errors found in
# any of the POD files.
#
# Extended by Davor Ocelic to support explicit list of POD files or
# sections to check:
#
#     check-pod pod1/fs.pod
#     check-pod pod5
#     check-pod pod1 pod8/volserver.pod
#

use strict;
use Test::More;
eval "use Test::Pod 1.00";

plan skip_all => "Test::Pod 1.00 required for testing POD" if $@;
my @poddirs = qw( pod1 pod3 pod5 pod8 );

my @list;
for ( @ARGV ? @ARGV : @poddirs ) {
	if ( -f ) {
		push @list, $_
	} elsif ( -d ) {
		push @list, grep { !m,fragments/, } all_pod_files( $_ )
	}
}

all_pod_files_ok( @list );
Commit	Line	Data
805e021f CE	1	#!/usr/bin/perl
	2	#
	3	# Written by Jason Edgecombe based on the Test::Pod documentation. The
	4	# best way to run it is to run:
	5	#
	6	# prove check-pod
	7	#
	8	# from the doc/man-pages directory, which will show any errors found in
	9	# any of the POD files.
	10	#
	11	# Extended by Davor Ocelic to support explicit list of POD files or
	12	# sections to check:
	13	#
	14	# check-pod pod1/fs.pod
	15	# check-pod pod5
	16	# check-pod pod1 pod8/volserver.pod
	17	#
	18
	19	use strict;
	20	use Test::More;
	21	eval "use Test::Pod 1.00";
	22
	23	plan skip_all => "Test::Pod 1.00 required for testing POD" if $@;
	24	my @poddirs = qw( pod1 pod3 pod5 pod8 );
	25
	26	my @list;
	27	for ( @ARGV ? @ARGV : @poddirs ) {
	28	if ( -f ) {
	29	push @list, $_
	30	} elsif ( -d ) {
	31	push @list, grep { !m,fragments/, } all_pod_files( $_ )
	32	}
	33	}
	34
	35	all_pod_files_ok( @list );