The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Perl-Critic-Pulp-99
River stage two • 5 direct dependents • 18 total dependents
4 ++
/ Perl::Critic::Policy::Documentation::RequireFilenameMarkup

NAME

Perl::Critic::Policy::Documentation::RequireFilenameMarkup - markup /foo filenames

DESCRIPTION

This policy is part of the Perl::Critic::Pulp add-on. It asks you to use F<> or other markup on filenames.

    /usr/bin       # bad

    F</usr/bin>    # ok
    C</bin/sh>     # ok

F<> lets the formatters show filenames in a usual way, such as italics in man pages. This can help human readability but is a minor matter and on that basis this policy is lowest severity and under the "cosmetic" theme (see "POLICY THEMES" in Perl::Critic).

Filenames in text are identified by likely forms. Currently words starting as follows are considered filenames. /usr and /etc are the most common.

    /bin
    /dev      
    /etc
    /opt         # some proprietary Unix
    /proc
    /tmp
    /usr
    /var
    C:\          # MS-DOS

Any markup on a filename satisfies this policy. F<> is usual, but C<> might suit for instance C</bin/sh> to show it's a command with path rather than a file as such.

=begin :foo blocks with <:> POD type are checked since they can have markup. "Verbatim" paragraphs are ignored since of course they cannot have markup.

Disabling

If you don't care about filename markup you can disable RequireFilenameMarkup from your .perlcriticrc in the usual way (see "CONFIGURATION" in Perl::Critic),

    [-Documentation::RequireFilenameMarkup]

SEE ALSO

Perl::Critic::Pulp, Perl::Critic

HOME PAGE

http://user42.tuxfamily.org/perl-critic-pulp/index.html

COPYRIGHT

Copyright 2013, 2014, 2015, 2016, 2017, 2019, 2021 Kevin Ryde

Perl-Critic-Pulp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version.

Perl-Critic-Pulp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Perl-Critic-Pulp. If not, see <http://www.gnu.org/licenses/>.