Perl::...Markup(3pm)

📦
version 100 · 7 versions
, in ubuntu resolute, ubuntu stonking

💖 Perl::Critic::Policy::Documentation::RequireFilenameMarkup 💖

okay bestie, so this is one of those User Contributed Perl Documentation pages, and the star of the show is Perl::...Markup(3pm) — a lil policy module that wants you to markup your /foo filenames. yes really. she's bossy but she's right. 🎀

✨ NAME ✨

Perl::Critic::Policy::Documentation::RequireFilenameMarkup — markup /foo filenames 🦋

🌸 DESCRIPTION 🌸

So this policy is part of the Perl::Critic::Pulp add-on (iykyk). What she does is ask you — politely but firmly — to use F<> or other markup on your filenames. periodt.

/usr/bin       # bad

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

The way that F<> works is it lets the formatters show filenames in a usual way, such as italics in man pages. Lowkey this helps human readability, but ngl it's a minor matter, and on that basis this policy is lowest severity and lives under the "cosmetic" theme (see "POLICY THEMES" in Perl::Critic). so like. don't stress, bestie 💅

Filenames in text are identified by likely forms. Currently, words starting as follows are considered filenames — with /usr and /etc being 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, fr fr. F<> is the usual one, but C<> might suit for instance C</bin/sh> to show it's a command with path rather than a file as such. iconic behavior honestly.

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

🎀 Disabling 🎀

If you genuinely don't care about filename markup (valid, live your truth), 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 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/>.

okay so that's the whole thing, you ate that 💖 and as a lil sign-off: this whole page is served up by perl v5.40.1, dated 2025-10-21, and the manpage title is Perl::...Markup(3pm). slay, bestie 🫶✨🌸

📦 where this page comes from