X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=scan-adoc-refs;h=1ac1f908dd408fb97a44fc604c1c5d88999906df;hp=216b244b74f5a6a99da73723e9cb1a946ecc0716;hb=012445a51819a9b68b048421fe5597ba41519d93;hpb=86f28451c2a9241ca531ee6e11af195083376cdb diff --git a/scan-adoc-refs b/scan-adoc-refs index 216b244..1ac1f90 100755 --- a/scan-adoc-refs +++ b/scan-adoc-refs @@ -2,11 +2,18 @@ use strict; use warnings; +use Getopt::Long; use IO::File; use JSON; use Data::Dumper; +my $generate_depends; + +GetOptions("depends=s" => \$generate_depends) or + die("Error in command line arguments\n"); + + my $environments = { default => 1, wiki => 1, @@ -69,8 +76,6 @@ sub pop_environment { sub register_include { my ($filename, $include_filename, $env_list) = @_; - return if $include_filename !~ m/\.adoc$/; # skip attributes.txt - foreach my $e (@$env_list) { $fileinfo->{include}->{$e}->{$filename}->{$include_filename} = 1; } @@ -107,11 +112,14 @@ sub register_title { die "unable to change title (no doctype)" if !defined($fileinfo->{doctype}->{$env}->{$filename}); } + } elsif (!defined($doctype)) { + # change title via :title: attribute + $fileinfo->{titles}->{$env}->{$filename} = $title; + } - if (defined($doctype) && ($env eq 'manvolnum') && ($doctype == 0)) { - if ($title =~ m/.*\(([1-8])\)\s*$/) { - $fileinfo->{mansection}->{$env}->{$filename} = $1; - } + if (defined($doctype) && ($env eq 'manvolnum') && ($doctype == 0)) { + if ($title =~ m/.*\(([1-8])\)\s*$/) { + $fileinfo->{mansection}->{$env}->{$filename} = $1; } } @@ -225,6 +233,7 @@ sub scan_adoc_file { my $scanned_files = {}; while (my $filename = shift) { next if $filename !~ m/\.adoc$/; # skip attributes.txt + next if $filename =~ m/-(opts|synopsis)\.adoc$/; next if $scanned_files->{$filename}; scan_adoc_file($filename); @@ -241,8 +250,9 @@ sub resolve_link_target { while ($repeat) { $repeat = 0; foreach my $fn (keys %$include_hash) { - next if $fn eq 'pve-admin-guide.adoc'; if ($include_hash->{$fn}->{$filename}) { + next if ($fn eq 'pve-admin-guide.adoc') && + $fileinfo->{outfile}->{$env}->{$filename}; $filename = $fn; $repeat = 1; last; @@ -253,6 +263,45 @@ sub resolve_link_target { return $filename; } + +# try to generate output file mapping +foreach my $e (@$start_env) { + my $toplevel_hash = $fileinfo->{toplevel}->{$e}; + foreach my $fn (sort keys %$toplevel_hash) { + my $mansection = $fileinfo->{mansection}->{manvolnum}->{$fn}; + if ($e eq 'wiki') { + my $realfn = $fn; + $realfn =~ s/\.adoc$//; + if (defined($mansection) && ($mansection == 5)) { + $realfn .= ".$mansection"; + } + $realfn = "$realfn-plain.html"; + $fileinfo->{outfile}->{$e}->{$fn} = $realfn; + } elsif ($e eq 'manvolnum') { + my $realfn = $fn; + $realfn =~ s/\.adoc$//; + die "toplevel file '$fn' is not marked as manual page!" if !$mansection; + $realfn .= ".$mansection"; + $fileinfo->{outfile}->{$e}->{$fn} = $realfn; + } elsif ($e eq 'default') { + my $realfn = $fn; + $realfn =~ s/\.adoc$//; + if (defined($mansection) && ($mansection == 5)) { + $realfn .= ".$mansection"; + $realfn = "$realfn.html"; + } else { + if (($fn ne 'pve-admin-guide.adoc') && + $fileinfo->{doctype}->{$e}->{$fn} == 0) { + $realfn = "chapter-$realfn.html"; + } else { + $realfn = "$realfn.html"; + } + } + $fileinfo->{outfile}->{$e}->{$fn} = $realfn; + } + } +} + # now resolve blockids foreach my $e (@$start_env) { my $blockid_hash = $fileinfo->{blockid}->{$e}; @@ -263,15 +312,180 @@ foreach my $e (@$start_env) { $title =~ s/\s/_/g; die "found not title for '$fn' in env '$e'" if !$title; $fileinfo->{blockid_target}->{$e}->{$blockid} = "link:/wiki/$title#$blockid"; + + # we do not produce wiki pages for all content + #my $realfn = $fileinfo->{outfile}->{$e}->{$fn}; + #warn "no output file mapping for '$fn' ($e)\n" if !$realfn; + } elsif ($e eq 'default') { - my $realfn = "chapter-$fn"; - $realfn =~ s/\.adoc/.html/; + my $realfn = $fileinfo->{outfile}->{$e}->{$fn} || + die "no output file mapping for '$fn'\n"; $fileinfo->{blockid_target}->{$e}->{$blockid} = "link:/pve-docs/$realfn#$blockid"; - } else { + } elsif ($e eq 'manvolnum') { + # we do not produce manpages for all content + # my $realfn = $fileinfo->{outfile}->{$e}->{$fn} || + # warn "no output file mapping for '$fn'\n"; $fileinfo->{blockid_target}->{$e}->{$blockid} = $fn; } } } +my $makevar_hash = {}; + +sub makevar_define { + my ($varname) = @_; + + die "makefile variable '$varname' already defined\n" + if exists($makevar_hash->{$varname}); + + $makevar_hash->{$varname} = {}; +} + +sub makevar_list_add { + my ($varname, $value) = @_; + + die "makefile variable '$varname' not defined\n" + if !exists($makevar_hash->{$varname}); + + $makevar_hash->{$varname}->{$value} = 1; +} + +sub makevar_dump { + my $txt = ''; + + foreach my $varname (sort keys %$makevar_hash) { + $txt .= "$varname ="; + foreach my $value (sort keys %{$makevar_hash->{$varname}}) { + $txt .= " \\\n\t$value"; + } + $txt .= "\n\n"; + } + + return $txt; +} + +if ($generate_depends) { + + my $tmpfilename = "${generate_depends}.tmp"; + my $outfh = IO::File->new($tmpfilename, "w") || + die "unable to open temporary file '$tmpfilename'\n"; + + my $depends = {}; + foreach my $e (@$start_env) { + my $env_data = $fileinfo->{include}->{$e}; + + my $add_depends; + + $add_depends = sub { + my ($fn, $dep) = @_; + + $depends->{$fn}->{$dep} = 1; + foreach my $nd (keys %{$env_data->{$dep}}) { + &$add_depends($fn, $nd); + } + }; + + foreach my $fn (keys %$env_data) { + foreach my $dep (keys %{$env_data->{$fn}}) { + &$add_depends($fn, $dep); + } + } + } + + my $depend_varname_hash = {}; + + foreach my $fn (sort keys %$depends) { + my $basename = uc($fn); + $basename =~s/\.adoc$//i; + $basename =~s/[^A-Za-z0-9]/_/g; + + my $varname1 = "${basename}_ADOCSOURCES"; + my $varname2 = "${basename}_ADOCDEPENDS"; + + makevar_define($varname1); + makevar_define($varname2); + + $depend_varname_hash->{$fn} = $varname2; + + makevar_list_add($varname1, $fn); + makevar_list_add($varname2, "\$\{$varname1\}"); + + foreach my $dep (sort keys %{$depends->{$fn}}) { + if ($dep =~ m/-(opts|synopsis).adoc$/) { + makevar_list_add($varname2, $dep); + } else { + makevar_list_add($varname1, $dep); + } + } + } + + my $man_sources_hash = {}; + foreach my $sourcefile (keys %{$fileinfo->{outfile}->{manvolnum}}) { + $man_sources_hash->{$sourcefile} = 1; + my $ihash = $fileinfo->{include}->{manvolnum}->{$sourcefile}; + foreach my $include (keys %$ihash) { + if ($include !~ m/-(opts|synopsis).adoc$/) { + $man_sources_hash->{$include} = 1; + } + } + } + + my $varname = "MANUAL_SOURCES"; + makevar_define($varname); + foreach my $sourcefile (sort keys %$man_sources_hash) { + makevar_list_add($varname, $sourcefile); + } + + $varname = "CHAPTER_LIST"; + makevar_define($varname); + my $filelist = $fileinfo->{outfile}->{default}; + foreach my $sourcefile (sort keys %$filelist) { + my $target = $filelist->{$sourcefile}; + makevar_list_add($varname, $target); + } + + $varname = "MANUAL_PAGES"; + makevar_define($varname); + $filelist = $fileinfo->{outfile}->{manvolnum}; + foreach my $manpage (sort keys %$filelist) { + my $target = $filelist->{$manpage}; + makevar_list_add($varname, $target); + } + + $varname = "WIKI_IMPORTS"; + makevar_define($varname); + $filelist = $fileinfo->{outfile}->{wiki}; + foreach my $sourcefile (sort keys %$filelist) { + my $target = $filelist->{$sourcefile}; + makevar_list_add($varname, $target); + } + + my $res = makevar_dump(); + + my $make_targets = {}; + foreach my $e (@$start_env) { + my $filelist = $fileinfo->{outfile}->{$e}; + foreach my $sourcefile (sort keys %$filelist) { + my $varname = $depend_varname_hash->{$sourcefile}; + my $target = $filelist->{$sourcefile}; + my $dep = "\$\{$varname\}"; + $make_targets->{$target} = $dep; + if ($e eq 'manvolnum') { + $make_targets->{"$target.html"} = $dep; + $make_targets->{"$target-plain.html"} = $dep; + } + } + } + foreach my $target (sort keys%$make_targets) { + my $dep = $make_targets->{$target}; + $res .= "$target: $dep\n\n"; + } + + print $outfh $res; + close($outfh); + + rename($tmpfilename, $generate_depends) || + die "rename failed - $!"; +} print to_json($fileinfo, { pretty => 1, canonical => 1 } );