[rt.cpan.org #39007] pod2man and POD ERRORS

[Russ Allbery <rra@stanford.edu>]

I've received a request to make pod2man report POD errors to stderr by
default instead of adding a POD ERRORS section.  I think it makes sense
for the default for the modules be to document errors in the POD output,
since libraries complaining to stderr is something that's often very
annoying, but pod2man and pod2text as command-line tools don't have that
problem.

The primary argument for doing this is that POD errors are primarily of
interest to the author of the POD, not to thte end-user, but the POD
ERRORS section in an installed man page tells the user about things they
can't do anything about.

However, if pod2man complains to stderr, that's not particularly useful
for perldoc.  (It *does* match the standard behavior of the man program,
but still.)  I'm not sure what makes the most sense for perldoc to do.

Does anyone have any opinions about this?  I'll definitely add an option
that controls where warnings go for pod2man, but I'm not sure if I should
change the default to stderr instead of POD ERRORS.

-- 
Russ Allbery (rra@stanford.edu)             <http://www.eyrie.org/~eagle/>

---

Follow-Ups from:

"Alan D. Salewski" <asalewski@comcast.net>

---

[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index][Thread Index][Top&Search][Original]

---