From 5f6ed9478ddc0cc1e6582f76488e39391c3c011d Mon Sep 17 00:00:00 2001 From: Steve Hancock Date: Sun, 29 May 2022 11:55:44 -0700 Subject: [PATCH] update docs --- bin/perltidy | 11 +++++++---- lib/Perl/Tidy.pod | 15 ++++----------- 2 files changed, 11 insertions(+), 15 deletions(-) diff --git a/bin/perltidy b/bin/perltidy index 5b7f1e7a..01db4424 100755 --- a/bin/perltidy +++ b/bin/perltidy @@ -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 - -To report a new bug or problem, use the link on this page. - The source code repository is at L. +To report a new bug or problem, use the "issues" link on this page. + =head1 COPYRIGHT Copyright (c) 2000-2022 by Steve Hancock diff --git a/lib/Perl/Tidy.pod b/lib/Perl/Tidy.pod index 1057cd8f..311bf174 100644 --- a/lib/Perl/Tidy.pod +++ b/lib/Perl/Tidy.pod @@ -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 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 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 section of the source distribution has some examples of programs which use the B 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 is a short script of interest. This will produce F 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 in Tidy.pm. +C =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 - -To report a new bug or problem, use the link on this page. - The source code repository is at L. +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 -- 2.39.5