Perl::Critic::Policy::Documentation::RequireFilenameMarkup3pm

Overview

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.

    [-Documentation::RequireFilenameMarkup]

Home page

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