- Next message: esr_at_[hidden]: "problems in mpiexec.1, mpirun.1"
- Previous message: Brian Barrett: "Re: problems in lamboot.1, lamexec.1, lammsg.1, lamrun.1, lamtask.1, lamshrink.1, lamd.1"
- In reply to: Brian Barrett: "Re: problems in lamboot.1, lamexec.1, lammsg.1, lamrun.1, lamtask.1, lamshrink.1, lamd.1"
Brian Barrett <brbarret_at_[hidden]>:
> I was playing with running your tool on our man pages. It seemed to
> not be too concerned with some of the issues you brought up,
> particularly the use of angle brackets in the synopsis section.
The reason I removed those was because one page had a "<#>" construct
in it that I was pretty sure would make my syntax parser lose its cookies.
Having removed that, I removed other angle brackets for consistency.
> Is there a way to have it complain about those issues?
Removing the <>s not around # was really a discretionary change, which
is why doclifter didn't flag it.
> I ask in part
> because I'd like to integrate the tool into our testing process for
> both LAM/MPI and Open MPI. While LAM's man pages are pretty static,
> Open MPI is under active development and our man pages change
> frequently. It would be nice to have a sanity check that we aren't
> generating bad manpages that troff lets "slip by".
That's an excellent idea. While doclifter was not designed to be a
troff-markup validator, it is (necessarily) a rather effective one.
As it is it will give you a pretty strong check. It ensures, among
other things, that all [ ] constructs are balanced.
I'll help you by shipping a doclifter point release this week. The
version I'm running has much more stringent checks for low-level
troff requests than the most recent public one. I'll mail you
a heads-up when it's ready.
--
Eric S. Raymond
- Next message: esr_at_[hidden]: "problems in mpiexec.1, mpirun.1"
- Previous message: Brian Barrett: "Re: problems in lamboot.1, lamexec.1, lammsg.1, lamrun.1, lamtask.1, lamshrink.1, lamd.1"
- In reply to: Brian Barrett: "Re: problems in lamboot.1, lamexec.1, lammsg.1, lamrun.1, lamtask.1, lamshrink.1, lamd.1"
|
