Skip to content

Commit

Permalink
tweak SEE ALSO/COPYRIGHT across the board
Browse files Browse the repository at this point in the history
  • Loading branch information
rcaputo committed Dec 20, 2000
1 parent f77c574 commit f126962
Show file tree
Hide file tree
Showing 19 changed files with 107 additions and 61 deletions.
9 changes: 9 additions & 0 deletions Changes
Expand Up @@ -26,6 +26,15 @@ Version numbers have four fields: X.YYZZAA
`------------------------------------------------------------------------------


0.1202 2000.??.??
-----------------

Documented FollowTail's SeekBack parameter. Whoops!

Added a conceptual cross-reference to POE's "SEE ALSO" section, so now
it acts as a table of contents for the entire distribution.


0.1201 2000.12.15
-----------------

Expand Down
6 changes: 3 additions & 3 deletions NEEDS
Expand Up @@ -12,9 +12,9 @@
#
# module-mask (wants|needs) dependent-mask
#
# Core modules must be able to load all their "needed" dependencies.
# Core modules must be able to load all their "needs" dependencies.
# The program exits with a failure code (designed to stop a makefile)
# if any of the distribution's core modules requires a dependent that
# if any of the distribution's core modules needss a dependent that
# can't be loaded.
#
# Data modules are ignored.
Expand Down Expand Up @@ -43,7 +43,7 @@ MANIFEST is data
NEEDS is data

# Test 8 uses a module which it knows doesn't exist. Skip dependency
# checking for this test.
# checking for that file.

t/08_errors.t is data

Expand Down
7 changes: 6 additions & 1 deletion lib/POE/Component.pm
Expand Up @@ -33,13 +33,18 @@ The POE::Component namespace was started to provide a place for others
publish their POE modules without requiring coordination with the main
POE distribution.
=head1 SEE ALSO
The SEE ALSO section in L<POE> contains a table of contents covering
the entire POE distribution.
=head1 BUGS
The POE::Component namespace should probably be coordinated, but who
has time for that?
=head1 AUTHORS & COPYRIGHTS
Please see the POE manpage or manpages for specific components.
Please see L<POE> for more information about authors and contributors.
=cut
7 changes: 4 additions & 3 deletions lib/POE/Driver.pm
Expand Up @@ -98,14 +98,15 @@ top message is partially flushed, it is still counted as a full one.
=head1 SEE ALSO
POE::Driver::SysRW
The SEE ALSO section in L<POE> contains a table of contents covering
the entire POE distribution.
=head1 BUGS
There is no POE::Driver::SendRecv
There is no POE::Driver::SendRecv, but nobody has needed one so far.
=head1 AUTHORS & COPYRIGHTS
Please see the POE manpage.
Please see L<POE> for more information about authors and contributors.
=cut
7 changes: 5 additions & 2 deletions lib/POE/Driver/SysRW.pm
Expand Up @@ -160,14 +160,17 @@ If omitted, $block_size defaults to 512.
=head1 SEE ALSO
POE::Driver
POE::Driver.
The SEE ALSO section in L<POE> contains a table of contents covering
the entire POE distribution.
=head1 BUGS
Oh, probably some.
=head1 AUTHORS & COPYRIGHTS
Please see the POE manpage.
Please see L<POE> for more information about authors and contributors.
=cut
6 changes: 3 additions & 3 deletions lib/POE/Filter.pm
Expand Up @@ -119,15 +119,15 @@ switching filters.
=head1 SEE ALSO
POE::Filter::HTTPD; POE::Filter::Line; POE::Filter::Reference;
POE::Filter::Stream
The SEE ALSO section in L<POE> contains a table of contents covering
the entire POE distribution.
=head1 BUGS
Oh, probably some.
=head1 AUTHORS & COPYRIGHTS
Please see the POE manpage.
Please see L<POE> for more information about authors and contributors.
=cut
9 changes: 5 additions & 4 deletions lib/POE/Filter/Block.pm
Expand Up @@ -140,8 +140,10 @@ Please see POE::Filter.
=head1 SEE ALSO
POE::Filter; POE::Filter::HTTPD; POE::Filter::Reference;
POE::Filter::Stream; POE::Filter::Line
POE::Filter.
The SEE ALSO section in L<POE> contains a table of contents covering
the entire POE distribution.
=head1 BUGS
Expand All @@ -152,7 +154,6 @@ None known.
The Block filter was contributed by Dieter Pearcey, with changes by
Rocco Caputo.
Please see the POE manpage for more information about authors and
contributors.
Please see L<POE> for more information about authors and contributors.
=cut
9 changes: 5 additions & 4 deletions lib/POE/Filter/HTTPD.pm
Expand Up @@ -232,8 +232,10 @@ Please see POE::Filter.
=head1 SEE ALSO
POE::Filter; POE::Filter::Line; POE::Filter::Reference;
POE::Filter::Stream; HTTP::Request; HTTP::Response
POE::Filter.
The SEE ALSO section in L<POE> contains a table of contents covering
the entire POE distribution.
=head1 BUGS
Expand All @@ -243,7 +245,6 @@ Keep-alive is not supported.
The HTTPD filter was contributed by Artur Bergman.
Please see the POE manpage for more information about authors and
contributors.
Please see L<POE> for more information about authors and contributors.
=cut
8 changes: 5 additions & 3 deletions lib/POE/Filter/Line.pm
Expand Up @@ -279,8 +279,10 @@ Please see POE::Filter.
=head1 SEE ALSO
POE::Filter; POE::Filter::HTTPD; POE::Filter::Reference;
POE::Filter::Stream
POE::Filter.
The SEE ALSO section in L<POE> contains a table of contents covering
the entire POE distribution.
=head1 BUGS
Expand All @@ -289,6 +291,6 @@ newlines can generate spurious blank input lines.
=head1 AUTHORS & COPYRIGHTS
Please see the POE manpage.
Please see L<POE> for more information about authors and contributors.
=cut
9 changes: 5 additions & 4 deletions lib/POE/Filter/Reference.pm
Expand Up @@ -248,8 +248,10 @@ streamable representations.
=head1 SEE ALSO
POE::Filter; POE::Filter::HTTPD; POE::Filter::Line;
POE::Filter::Stream
POE::Filter.
The SEE ALSO section in L<POE> contains a table of contents covering
the entire POE distribution.
=head1 BUGS
Expand All @@ -260,7 +262,6 @@ Oh, probably some.
The Reference filter was contributed by Arturn Bergman, with changes
by Philip Gwyn.
Please see the POE manpage for more information about authors and
contributors.
Please see L<POE> for more information about authors and contributors.
=cut
10 changes: 6 additions & 4 deletions lib/POE/Filter/Stream.pm
Expand Up @@ -51,19 +51,21 @@ POE::Filter::Stream - POE Stream (Null) Protocol Abstraction
=head1 DESCRIPTION
This filter passes data through unchanged. It is a "null" filter.
This filter passes data through unchanged.
=head1 SEE ALSO
POE::Filter; POE::Filter::HTTPD; POE::Filter::Line;
POE::Filter::Reference; POE::Filter::Stream
POE::Filter.
The SEE ALSO section in L<POE> contains a table of contents covering
the entire POE distribution.
=head1 BUGS
Oh, probably some.
=head1 AUTHORS & COPYRIGHTS
Please see the POE manpage.
Please see L<POE> for more information about authors and contributors.
=cut
12 changes: 6 additions & 6 deletions lib/POE/Kernel.pm
Expand Up @@ -3544,10 +3544,9 @@ Rather than waste the window, POE exports it as $poe_main_window.
=head1 PRIVATE KERNEL METHODS
The private kernel methods are private. All the usual "here there be
private methods" caveats apply. As such, they won't be documented
here. The terminally curious, however, will note that POE::Kernel
contains a lot of comments.
All the usual "here there be private methods" caveats apply, so
they're not documented here. The terminally curious, however, will
note that POE::Kernel contains a lot of comments.
=head1 PUBLIC KERNEL METHODS
Expand Down Expand Up @@ -4306,14 +4305,15 @@ reference to the Kernel.
=head1 SEE ALSO
The POE manpages contains holistic POE information.
The SEE ALSO section in L<POE> contains a table of contents covering
the entire POE distribution.
=head1 BUGS
There are no currently known bugs. If you find one, tell the author!
=head1 AUTHORS & COPYRIGHTS
Please see the POE manpage for authors and licenses.
Please see L<POE> for more information about authors and contributors.
=cut
11 changes: 6 additions & 5 deletions lib/POE/NFA.pm
Expand Up @@ -779,10 +779,11 @@ invoking the C<call_state>'s RETURN_EVENT, possibly with RETURN_ARGS.
=head1 SEE ALSO
The POE manpage contains holistic POE information, including an up to
date list of the modules comprising it. The POE::Session manpage is a
"must read", says the New York Times, and it covers many concepts
which this manpage casually glosses over.
Many of POE::NFA's features are taken directly from POE::Session.
Please see L<POE::Session> for more information.
The SEE ALSO section in L<POE> contains a table of contents covering
the entire POE distribution.
=head1 BUGS
Expand All @@ -796,6 +797,6 @@ The documentation is slapped together hastily, too.
=head1 AUTHORS & COPYRIGHTS
Please see the POE manpage for authors and licenses.
Please see L<POE> for more information about authors and contributors.
=cut
8 changes: 5 additions & 3 deletions lib/POE/Session.pm
Expand Up @@ -1509,8 +1509,10 @@ using the first form.
=head1 SEE ALSO
The POE manpage contains holstic POE information, including an up to
date list of the modules comprising it.
POE::Kernel.
The SEE ALSO section in L<POE> contains a table of contents covering
the entire POE distribution.
=head1 BUGS
Expand All @@ -1521,6 +1523,6 @@ If you find another, tell the author!
=head1 AUTHORS & COPYRIGHTS
Please see the POE manpage for authors and licenses.
Please see L<POE> for more information about authors and contributors.
=cut
6 changes: 3 additions & 3 deletions lib/POE/Wheel.pm
Expand Up @@ -118,8 +118,8 @@ state for that TYPE of event.
=head1 SEE ALSO
POE::Wheel::FollowTail; POE::Wheel::ListenAccept;
POE::Wheel::ReadWrite; POE::Wheel::SocketFactory.
The SEE ALSO section in L<POE> contains a table of contents covering
the entire POE distribution.
=head1 BUGS
Expand All @@ -129,6 +129,6 @@ SocketFactory.
=head1 AUTHORS & COPYRIGHTS
Please see the POE manpage for authors and licenses.
Please see L<POE> for more information about authors and contributors.
=cut
20 changes: 16 additions & 4 deletions lib/POE/Wheel/FollowTail.pm
Expand Up @@ -253,6 +253,7 @@ POE::Wheel - POE FollowTail Protocol Logic
PollInterval => 1, # How often to check it
InputState => $input_event_name, # State to call upon input
ErrorState => $error_event_name, # State to call upon error
SeekBack => $offset, # How far from EOF to start
);
=head1 DESCRIPTION
Expand Down Expand Up @@ -339,19 +340,30 @@ A sample ErrorState state:
warn "$operation error $errnum: $errstr\n";
}
=item *
SeekBack
The SeekBack parameter tells FollowTail how far from EOF to start
following the file. Its value is specified in bytes, and seeking
before the beginning of a file will quietly cause FollowTail to start
from the file's beginning.
=back
=head1 SEE ALSO
POE::Wheel; POE::Wheel::ListenAccept; POE::Wheel::ReadWrite;
POE::Wheel::SocketFactory
POE::Wheel.
The SEE ALSO section in L<POE> contains a table of contents covering
the entire POE distribution.
=head1 BUGS
This wheel can't tail pipes and consoles. Blargh.
This wheel can't tail pipes and consoles. This may have been fixed.
=head1 AUTHORS & COPYRIGHTS
Please see the POE manpage.
Please see L<POE> for more information about authors and contributors.
=cut
8 changes: 5 additions & 3 deletions lib/POE/Wheel/ListenAccept.pm
Expand Up @@ -225,15 +225,17 @@ A sample ErrorState state:
=head1 SEE ALSO
POE::Wheel; POE::Wheel::FollowTail; POE::Wheel::ReadWrite;
POE::Wheel::SocketFactory
POE::Wheel.
The SEE ALSO section in L<POE> contains a table of contents covering
the entire POE distribution.
=head1 BUGS
Oh, probably some.
=head1 AUTHORS & COPYRIGHTS
Please see the POE manpage.
Please see L<POE> for more information about authors and contributors.
=cut

0 comments on commit f126962

Please sign in to comment.