]> git.donarmstrong.com Git - perltidy.git/commitdiff
update docs
authorSteve Hancock <perltidy@users.sourceforge.net>
Sun, 29 May 2022 18:55:44 +0000 (11:55 -0700)
committerSteve Hancock <perltidy@users.sourceforge.net>
Sun, 29 May 2022 18:55:44 +0000 (11:55 -0700)
bin/perltidy
lib/Perl/Tidy.pod

index 5b7f1e7a667e05999c08835d6797fd9040947d5c..01db44247dfe822fb6c449cc643d194adfd22213 100755 (executable)
@@ -36,6 +36,11 @@ perltidy - a perl script indenter and reformatter
 =head1 DESCRIPTION
 
 Perltidy reads a perl script and writes an indented, reformatted script.
+This document describes the parameters available for controlling this formatting.
+
+Perltidy is a commandline frontend to the module Perl::Tidy.  For documentation
+describing how to call the Perl::Tidy module from other applications see the
+separate documentation for Perl::Tidy.  It is the file Perl::Tidy.pod in the source distribution.
 
 Many users will find enough information in L<"EXAMPLES"> to get
 started.  New users may benefit from the short tutorial
@@ -5167,12 +5172,10 @@ This man page documents perltidy version 20220601
 
 =head1 BUG REPORTS
 
-A list of current bugs and issues can be found at the CPAN site L<https://rt.cpan.org/Public/Dist/Display.html?Name=Perl-Tidy>
-
-To report a new bug or problem, use the link on this page.
-
 The source code repository is at L<https://github.com/perltidy/perltidy>.
 
+To report a new bug or problem, use the "issues" link on this page.
+
 =head1 COPYRIGHT
 
 Copyright (c) 2000-2022 by Steve Hancock
index 1057cd8fb6306a9dced9ee115c577593d20418a6..311bf17402e764abec37a40b104d7e6fcdd7ac29 100644 (file)
@@ -452,12 +452,7 @@ identifier is found, its actual text is checked to see if it is one
 being sought.  If so, the above write_line prints the token and its
 line number.
 
-The B<formatter> feature is relatively new in perltidy, and further
-documentation needs to be written to complete its description.  However,
-several example programs have been written and can be found in the
-B<examples> section of the source distribution.  Probably the best way
-to get started is to find one of the examples which most closely matches
-your application and start modifying it.
+The B<examples> section of the source distribution has some examples of programs which use the B<formatter> option.
 
 For help with perltidy's peculiar way of breaking lines into tokens, you
 might run, from the command line,
@@ -468,7 +463,7 @@ where F<filename> is a short script of interest.  This will produce
 F<filename.DEBUG> with interleaved lines of text and their token types.
 The B<-D> flag has been in perltidy from the beginning for this purpose.
 If you want to see the code which creates this file, it is
-C<write_debug_entry> in Tidy.pm.
+C<sub Perl::Tidy::Debugger::write_debug_entry>
 
 =head1 EXPORT
 
@@ -491,12 +486,10 @@ Please refer to the file "COPYING" for details.
 
 =head1 BUG REPORTS
 
-A list of current bugs and issues can be found at the CPAN site L<https://rt.cpan.org/Public/Dist/Display.html?Name=Perl-Tidy>
-
-To report a new bug or problem, use the link on this page.
-
 The source code repository is at L<https://github.com/perltidy/perltidy>.
 
+To report a new bug or problem, use the "issues" link on this page.
+
 =head1 SEE ALSO
 
 The perltidy(1) man page describes all of the features of perltidy.  It