The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
SVK-Log-Filter-Mndrix-0.0.3
River stage zero No dependents
++
/ SVK::Log::Filter::Mndrix

NAME

SVK::Log::Filter::Mndrix - my pretty-ish output format

VERSION

This documentation refers to SVK::Log::Filter::Mndrix version 0.0.1

SYNOPSIS

 > svk log --output mndrix -l3 -q
 4353  mndrix   3-Aug-2006  Refactor log filters for a cleaner implementation
 4351  glasser  2-Aug-2006  In SVK::Root::Checkout, add a list of unimplemented
 4350  clkao    2-Aug-2006  Make nearest_copy work with 1.2.x. Spotted by
 
 > svk log --output mndrix -l2
 -----------------------------[ Revision :   4353 ]-----------------------------
 Author: mndrix      Log:
 Day   : Thursday       Refactor log filters for a cleaner implementation
 Date  : 3 Aug 2006     allowing filters to be subclassed. The new approach
 Time  : 14:07:21       also avoids naming collisions by avoiding the stash
 Remote: 1881           as much as possible.

 -----------------------------[ Revision :   4351 ]-----------------------------
 Author: glasser     Log:
 Day   : Wednesday      In SVK::Root::Checkout, add a list of unimplemented
 Date  : 2 Aug 2006     svn_fs_root_t methods.
 Time  : 22:44:33
 Remote: 1880

DESCRIPTION

The Mndrix filter is an output log filter for SVK which displays log messages and revision properties in a way that I consider useful. Under normal usage, it displays author, day, date, time, remote revision number (if applicable) and the first paragraph of the log message. The layout has the log message in the right column and all other information in the left column.

Once installed, I make it my default output log filter by setting the environment variable SVKLOGOUTPUT to 'mndrix'. For specific invocations of the log command, you can still get the default behavior by specifying "--output std"

quiet

Display a one-line summary of each revision including: revision number, author, date and log message

verbose

Display the entire log message instead of just the first paragraph. Eventually, this should show the files that were modified, but it doesn't do this now.

STASH/PROPERTY MODIFICATIONS

Stats leaves all properties intact and does not modify the stash.

DEPENDENCIES

  • SVK 1.99 or newer

  • Perl6::Form

  • Text::Autoformat

  • Term::ReadKey

  • Time::Local

  • POSIX

INCOMPATIBILITIES

Incompatible with any other output log filter.

BUGS AND LIMITATIONS

Please report any bugs or feature requests to bug-svk-log-filter-mndrix at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=SVK-Log-Filter-Mndrix. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc SVK::Log::Filter::Mndrix

You can also look for information at:

ACKNOWLEDGEMENTS

AUTHOR

Michael Hendricks <michael@ndrix.org>

LICENSE AND COPYRIGHT

The MIT License

Copyright (c) 2006 Michael Hendricks (<michael@ndrix.org>).

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.