[svn:parrot] r47658 - in branches/html_cleanup: docs/pdds lib/Parrot lib/Parrot/Docs/Section tools/docs

coke at svn.parrot.org coke at svn.parrot.org
Wed Jun 16 17:03:59 UTC 2010


Author: coke
Date: Wed Jun 16 17:03:58 2010
New Revision: 47658
URL: https://trac.parrot.org/parrot/changeset/47658

Log:
Remove unused "--delete" option to tools/docs/write_docs.pl, we have 'make html-clean'
- also, we never used it.
- also, don't refer to the script in the docs, just the make target.

Modified:
   branches/html_cleanup/docs/pdds/pdd07_codingstd.pod
   branches/html_cleanup/lib/Parrot/Distribution.pm
   branches/html_cleanup/lib/Parrot/Docs/Section/Parrot.pm
   branches/html_cleanup/tools/docs/write_docs.pl

Modified: branches/html_cleanup/docs/pdds/pdd07_codingstd.pod
==============================================================================
--- branches/html_cleanup/docs/pdds/pdd07_codingstd.pod	Wed Jun 16 16:56:31 2010	(r47657)
+++ branches/html_cleanup/docs/pdds/pdd07_codingstd.pod	Wed Jun 16 17:03:58 2010	(r47658)
@@ -886,11 +886,8 @@
 
     */
 
-This inline Pod documentation is parsed to HTML by running:
+This inline Pod documentation is transformed to HTML with:
 
-    $ perl tools/docs/write_docs.pl --delete
-
-or:
     $ make html
 
 =item Optimizations

Modified: branches/html_cleanup/lib/Parrot/Distribution.pm
==============================================================================
--- branches/html_cleanup/lib/Parrot/Distribution.pm	Wed Jun 16 16:56:31 2010	(r47657)
+++ branches/html_cleanup/lib/Parrot/Distribution.pm	Wed Jun 16 17:03:58 2010	(r47658)
@@ -761,18 +761,6 @@
     return $self->docs_directory->directory_with_name('html');
 }
 
-=item C<delete_html_docs()>
-
-Deletes the HTML documentation directory.
-
-=cut
-
-sub delete_html_docs {
-    my $self = shift;
-
-    return $self->html_docs_directory->delete();
-}
-
 =item C<generated_files>
 
 Returns a hash where the keys are the files in F<MANIFEST.generated> and the

Modified: branches/html_cleanup/lib/Parrot/Docs/Section/Parrot.pm
==============================================================================
--- branches/html_cleanup/lib/Parrot/Docs/Section/Parrot.pm	Wed Jun 16 16:56:31 2010	(r47657)
+++ branches/html_cleanup/lib/Parrot/Docs/Section/Parrot.pm	Wed Jun 16 17:03:58 2010	(r47658)
@@ -123,27 +123,20 @@
 
 =over 4
 
-=item C<write_docs($silent, $delete)>
+=item C<write_docs($silent)>
 
 Writes the HTML documentation.
 
 If C<$silent> is true then progress is not reported.
 
-If C<$delete> is true then the contents of C<$target> will be deleted
-before any HTML is written. This argument is intended to be used only
-once by the root section, it is not passed to subsections.
-
 =cut
 
 sub write_docs {
     my $self    = shift;
     my $silent  = shift || 0;
-    my $delete  = shift || 0;
     my $version = shift || '';
     my $dist    = Parrot::Distribution->new;
 
-    $dist->delete_html_docs if $delete;
-
     $self->{VERSION} = $version;
     $self->write_html( $dist, $dist->html_docs_directory, $silent );
 

Modified: branches/html_cleanup/tools/docs/write_docs.pl
==============================================================================
--- branches/html_cleanup/tools/docs/write_docs.pl	Wed Jun 16 16:56:31 2010	(r47657)
+++ branches/html_cleanup/tools/docs/write_docs.pl	Wed Jun 16 17:03:58 2010	(r47658)
@@ -8,7 +8,7 @@
 
 =head1 SYNOPSIS
 
-    % perl tools/docs/write_docs.pl [--silent] [--delete]
+    % perl tools/docs/write_docs.pl [--silent]
 
 =head1 DESCRIPTION
 
@@ -22,16 +22,15 @@
 use Getopt::Long;
 use Parrot::Docs::Section::Parrot;
 
-my ( $silent, $delete, $version );
+my ( $silent, $version );
 
 die unless GetOptions( 'silent'    => \$silent,
-                       'delete'    => \$delete,
                        'version=s' => \$version,
                      );
 
 my $docs = Parrot::Docs::Section::Parrot->new;
 
-$docs->write_docs( $silent, $delete, $version );
+$docs->write_docs( $silent, $version );
 
 exit 0;
 


More information about the parrot-commits mailing list