Ticket #1954: tt1954_first.diff

File tt1954_first.diff, 10.0 KB (added by jkeenan, 4 years ago)

first attempt at removing 'make docs'

  • MANIFEST

    diff --git a/MANIFEST b/MANIFEST
    index 70b203b..21fb98d 100644
    a b  
    223223config/gen/config_pm/myconfig.in                            [] 
    224224config/gen/core_pmcs.pm                                     [] 
    225225config/gen/makefiles.pm                                     [] 
    226 config/gen/makefiles/docs.in                                [] 
    227226config/gen/makefiles/editor.in                              [] 
    228227config/gen/makefiles/ext.in                                 [] 
     228config/gen/makefiles/html.in                                [] 
    229229config/gen/makefiles/parrot_embed_pl.in                     [] 
    230230config/gen/makefiles/parrot_pc.in                           [] 
    231231config/gen/makefiles/root.in                                [] 
  • config/auto/perldoc.pm

    diff --git a/config/auto/perldoc.pm b/config/auto/perldoc.pm
    index 8ff8465..d210422 100644
    a b  
    4646 
    4747    _handle_version($conf, $version, $cmd); 
    4848 
    49     my $TEMP_pod_build = <<'E_NOTE'; 
    50  
    51 # the following part of the Makefile was built by 'config/auto/perldoc.pm' 
    52  
    53 E_NOTE 
    54  
    55     opendir my $OPS, 'src/ops' or die "opendir ops: $!"; 
    56     my @ops = sort grep { !/^\./ && /\.ops$/ } readdir $OPS; 
    57     closedir $OPS; 
    58  
    59     my $TEMP_pod = join q{ } => 
    60         map { my $t = $_; $t =~ s/\.ops$/.pod/; "ops/$t" } @ops; 
    61  
    62     my $new_perldoc = $conf->data->get('new_perldoc'); 
    63  
    64     foreach my $ops (@ops) { 
    65         my $pod = $ops; 
    66         $pod =~ s/\.ops$/.pod/; 
    67         if ( $new_perldoc ) { 
    68             $TEMP_pod_build .= <<"END" 
    69 ops/$pod: ../src/ops/$ops 
    70 \t\$(PERLDOC_BIN) -ud ops/$pod ../src/ops/$ops 
    71 \t\$(CHMOD) 0644 ops/$pod 
    72  
    73 END 
    74         } 
    75         else { 
    76             $TEMP_pod_build .= <<"END" 
    77 ops/$pod: ../src/ops/$ops 
    78 \t\$(PERLDOC_BIN) -u ../ops/$ops > ops/$pod 
    79 \t\$(CHMOD) 0644 ../ops/$pod 
    80  
    81 END 
    82         } 
    83     } 
    84  
    85     $conf->data->set( 
    86         TEMP_pod             => $TEMP_pod, 
    87         TEMP_pod_build       => $TEMP_pod_build, 
    88     ); 
    89  
    9049    return 1; 
    9150} 
    9251 
     
    9857            has_perldoc => 0, 
    9958            new_perldoc => 0, 
    10059            perldoc     => 'echo', 
    101             TEMP_pod        => '', 
    102             TEMP_pod_build  => '', 
    10360        ); 
    10461        $self->set_result('no'); 
    10562        return; 
  • config/gen/makefiles.pm

    diff --git a/config/gen/makefiles.pm b/config/gen/makefiles.pm
    index 0be30c9..4de7a0e 100644
    a b  
    1515use strict; 
    1616use warnings; 
    1717 
    18  
    1918use base qw(Parrot::Configure::Step); 
    2019 
    2120use Parrot::Configure::Utils ':gen'; 
     
    5756            { SOURCE => 'config/gen/makefiles/editor.in' }, 
    5857 
    5958        'parrot.pc'     => { SOURCE => 'config/gen/makefiles/parrot_pc.in' }, 
    60         'docs/Makefile' => { SOURCE => 'config/gen/makefiles/docs.in' }, 
     59        'html/Makefile' => { SOURCE => 'config/gen/makefiles/html.in' }, 
    6160    }; 
    6261    return \%data; 
    6362} 
     
    8584    foreach my $target (@targets) { 
    8685        my $args   = $self->{makefiles}->{$target}; 
    8786        my $source = delete $args->{SOURCE}; 
    88  
    8987        $conf->genfile($source => $target, %$args ); 
    9088    } 
    9189    return; 
  • (a) a/config/gen/makefiles/docs.in vs. (b) /dev/null

    diff --git a/config/gen/makefiles/docs.in b/config/gen/makefiles/docs.in
    deleted file mode 100644
    index 4965daa..0000000
    a b  
    1 # Copyright (C) 2001-2010, Parrot Foundation. 
    2  
    3 # Setup of some commands 
    4 PERL    = @perl@ 
    5 CHMOD   = @chmod@ 
    6 MKPATH  = @mkpath@ 
    7 TOUCH   = @touch@ 
    8 RM_F    = @rm_f@ 
    9 RM_RF   = @rm_rf@ 
    10 PERLDOC_BIN = @perldoc@ 
    11 VERSION = @VERSION@@DEVEL@ 
    12  
    13 # long list of .pod files 
    14 POD = @TEMP_pod@ 
    15  
    16 # 
    17 # Targets 
    18 # 
    19  
    20 # The default target 
    21 all: packfile-c.pod $(POD) 
    22  
    23 # This is a listing of all targets, that are meant to be called by users 
    24 # Most of them are proxied in the root makefile parrot/Makefile 
    25 help : 
    26         @echo "" 
    27         @echo "Following targets are available to the user:" 
    28         @echo "" 
    29         @echo "all:             Generate documentation from .pod files or from the sources." 
    30         @echo "                 This is the default target." 
    31         @echo "" 
    32         @echo "htmlhelp:        windows only, generate a .chm file." 
    33         @echo "htmlhelp-clean:  Remove generated .chm" 
    34         @echo "" 
    35         @echo "pdf:             Generate a PDF from the html docs" 
    36         @echo "pdf-clean:       Remove generated pdf" 
    37         @echo "" 
    38         @echo "   clean:        Remove the generated documentation." 
    39         @echo "" 
    40  
    41 $(POD): doc-prep 
    42  
    43 doc-prep: 
    44         $(MKPATH) ops 
    45         $(TOUCH) doc-prep 
    46  
    47 packfile-c.pod: ../src/packfile/api.c 
    48 #IF(new_perldoc):       $(PERLDOC_BIN) -ud packfile-c.pod ../src/packfile/api.c 
    49 #ELSE:  $(PERLDOC_BIN) -u ../src/packfile/api.c > packfile-c.pod 
    50  
    51 clean: 
    52         $(RM_F) packfile-c.pod $(POD) doc-prep 
    53  
    54 html: 
    55         $(PERL) -I../lib ../tools/docs/make_html_docs.pl --version=$(VERSION) 
    56 html-clean: 
    57         $(RM_RF) html 
    58  
    59 # If you are missing the command 'pdflatex' then you have first to install a 
    60 # LaTeX distribution with it. For Windows and UNIX downloads are for example 
    61 # available from: http://miktex.org, http://tug.org/texlive or 
    62 # http://www.ctan.org 
    63 pdf: ../tools/docs/filename_and_chapter.pl 
    64         $(MKPATH) build/modified_pod 
    65         $(PERL) ../tools/docs/filename_and_chapter.pl 
    66         cd build && pdflatex parrot-book.tex && pdflatex parrot-book.tex 
    67  
    68 #pdf-release: build/parrot-book.pdf 
    69 #       cp build/parrot-book.pdf build/parrot-book-$$(date +"%Y.%m").pdf 
    70  
    71 pdf-clean: 
    72         $(RM_RF) build 
    73  
    74 htmlhelp: html 
    75 #IF(win32):     cd .. && $(PERL) tools/docs/mk_chm.pl 
    76 #IF(win32):     -cd html && hhc parrot.hhp 
    77  
    78 htmlhelp-clean: 
    79 #IF(win32):     $(RM_F) "html/*.hhc" "html/*.hhk" "html/*.hhp" "html/*.chm" 
    80  
    81 @TEMP_pod_build@ 
    82  
    83 # Local variables: 
    84 #   mode: makefile 
    85 # End: 
    86 # vim: ft=make: 
  • (a) /dev/null vs. (b) b/config/gen/makefiles/html.in

    diff --git a/config/gen/makefiles/html.in b/config/gen/makefiles/html.in
    new file mode 100644
    index 0000000..d1cbb2b
    a b  
     1# Copyright (C) 2001-2010, Parrot Foundation. 
     2 
     3# Setup of some commands 
     4PERL    = @perl@ 
     5CHMOD   = @chmod@ 
     6MKPATH  = @mkpath@ 
     7TOUCH   = @touch@ 
     8RM_F    = @rm_f@ 
     9RM_RF   = @rm_rf@ 
     10PERLDOC_BIN = @perldoc@ 
     11VERSION = @VERSION@@DEVEL@ 
     12 
     13 
     14# 
     15# Targets 
     16# 
     17 
     18# The default target 
     19all: html 
     20 
     21html: 
     22        $(PERL) -I../lib ../tools/docs/make_html_docs.pl --version=$(VERSION) 
     23html-clean: 
     24        $(RM_RF) html 
     25 
     26clean: html-clean 
     27 
     28htmlhelp: html 
     29#IF(win32):     cd .. && $(PERL) tools/docs/mk_chm.pl 
     30#IF(win32):     -cd html && hhc parrot.hhp 
     31 
     32htmlhelp-clean: 
     33#IF(win32):     $(RM_F) "html/*.hhc" "html/*.hhk" "html/*.hhp" "html/*.chm" 
     34 
     35# This is a listing of all targets, that are meant to be called by users 
     36# Most of them are proxied in the root makefile parrot/Makefile 
     37help : 
     38        @echo "" 
     39        @echo "Following targets are available to the user:" 
     40        @echo "" 
     41        @echo "all:             Generate .html documentation." 
     42        @echo "                 This is the default target." 
     43        @echo "" 
     44        @echo "htmlhelp:        windows only, generate a .chm file." 
     45        @echo "htmlhelp-clean:  Remove generated .chm" 
     46        @echo "" 
     47        @echo "pdf:             Generate a PDF from the html docs" 
     48        @echo "pdf-clean:       Remove generated pdf" 
     49        @echo "" 
     50        @echo "   clean:        Remove the generated documentation." 
     51        @echo "" 
     52 
     53# If you are missing the command 'pdflatex' then you have first to install a 
     54# LaTeX distribution with it. For Windows and UNIX downloads are for example 
     55# available from: http://miktex.org, http://tug.org/texlive or 
     56# http://www.ctan.org 
     57pdf: ../tools/docs/filename_and_chapter.pl 
     58        $(MKPATH) build/modified_pod 
     59        $(PERL) ../tools/docs/filename_and_chapter.pl 
     60        cd build && pdflatex parrot-book.tex && pdflatex parrot-book.tex 
     61 
     62#pdf-release: build/parrot-book.pdf 
     63#       cp build/parrot-book.pdf build/parrot-book-$$(date +"%Y.%m").pdf 
     64 
     65pdf-clean: 
     66        $(RM_RF) build 
     67 
     68# Local variables: 
     69#   mode: makefile 
     70# End: 
     71# vim: ft=make: 
  • config/gen/makefiles/root.in

    diff --git a/config/gen/makefiles/root.in b/config/gen/makefiles/root.in
    index 6655eaf..1b01e16 100644
    a b  
    145145 
    146146GEN_MAKEFILES = \ 
    147147    Makefile \ 
    148     docs/Makefile \ 
     148    html/Makefile \ 
    149149    editor/Makefile \ 
    150150    ext/Makefile \ 
    151151    src/dynoplibs/Rules.mak \ 
     
    606606 
    607607all : \ 
    608608    corevm \ 
    609     docs \ 
    610609#IF(has_glut):    $(LIBGLUTCB_SO) \ 
    611610#IF(has_dynamic_linking): $(EXTRANCITHUNKS_SO) \ 
    612611    $(DIS) \ 
     
    754753        @echo "" 
    755754        @echo "Documentation:" 
    756755        @echo "  help:              Print this help message." 
    757         @echo "  docs:              Generate documentation from POD in the sources." 
    758756        @echo "  html:              Generate HTML documentation from POD in the sources." 
    759757        @echo "  html-clean:        Remove the HTML documentation." 
    760758        @echo "  htmlhelp:          Compile HTML documentation (CHM format)." 
     
    18891887# 
    18901888############################################################################### 
    18911889 
    1892 #IF(has_perldoc):docs : docs.dummy 
    1893 #ELSE:docs : docs.stub 
    1894  
    1895 docs.stub: 
    1896         @echo "Perldoc is required, but not detected." 
    1897  
    1898 docs.dummy : 
    1899         $(MAKE) docs 
    1900  
    1901 docs-clean : 
    1902         $(MAKE) docs clean 
    1903  
    19041890#IF(has_perldoc):html : html.dummy 
    19051891#ELSE:html : html.stub 
    19061892 
     
    19081894        @echo "Perldoc is required, but not detected." 
    19091895 
    19101896html.dummy : 
    1911         $(MAKE) docs html 
     1897        $(MAKE) html html 
    19121898 
    19131899html-clean : 
    1914         $(MAKE) docs html-clean 
     1900        $(MAKE) html html-clean 
    19151901 
    19161902#IF(has_perldoc):htmlhelp : htmlhelp.dummy 
    19171903#ELSE:htmlhelp : htmlhelp.stub 
     
    19201906        @echo "Perldoc is required, but not detected." 
    19211907 
    19221908htmlhelp.dummy : 
    1923         $(MAKE) docs htmlhelp 
     1909        $(MAKE) html htmlhelp 
    19241910 
    19251911htmlhelp-clean : 
    1926         $(MAKE) docs htmlhelp-clean 
     1912        $(MAKE) html htmlhelp-clean 
    19271913 
    19281914pdf: 
    1929         $(MAKE) docs pdf 
     1915        $(MAKE) html pdf 
    19301916 
    19311917pdf-clean: 
    1932         $(MAKE) docs pdf-clean 
     1918        $(MAKE) html pdf-clean 
    19331919 
    19341920############################################################################### 
    19351921# 
     
    22042190    test-clean \ 
    22052191    prog-clean \ 
    22062192    dynext-clean \ 
    2207 #IF(has_perldoc):    docs-clean \ 
    22082193#IF(has_perldoc):    html-clean \ 
    22092194    examples-clean \ 
    22102195    ext-clean \