Page MenuHomeFreeBSD

[fdp-primer][manpages] Add Testing section
ClosedPublic

Authored by fernape on Nov 26 2020, 6:17 PM.

Details

Summary

I think we can add a Testing section for manpages. I moved the information from
the "Tip" about testing pages to a new section along with information about
mandoc(1)'s linter, igor, etc. I think the information there covers quite a few
cases and common mistakes.

Test Plan
  • igor seems happy
  • spell checking looks good
  • the html page is rendered properly

Diff Detail

Repository
rD FreeBSD doc repository - subversion
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

fernape created this revision.

Would it make sense to mention hunspell/aspell too? While igor does do some spellchecking, it does so on a rather limited set of words defined in the init_spellingerrors function.

Would it make sense to mention hunspell/aspell too? While igor does do some spellchecking, it does so on a rather limited set of words defined in the init_spellingerrors function.

Sure!

I will come up with something soon. Thanks for the hint!

How about something like:

<para>Spell-checking with fully-featured dictionaries is encouraged, and can
  be accomplished by using <package>textproc/hunspell</package> or
  <package>textproc/aspell</package> combined with
  <package>textproc/en-hunspell</package> or
  <package>textproc/en-aspell</package>, respectively.</para>

Include reference to spell checkers.

Suggested by debdrup@

ygy added a subscriber: ygy.

Looks good to me!

This revision is now accepted and ready to land.Nov 27 2020, 12:22 PM

Looks good to me, too. :)

This revision was automatically updated to reflect the committed changes.