Skip to content

Commit

Permalink
tweak previous; misc spelling, grammar, wording and formatting fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
botovq committed Jun 1, 2017
1 parent a4a807d commit b123615
Showing 1 changed file with 5 additions and 14 deletions.
19 changes: 5 additions & 14 deletions faq/ports/specialtopics.html
Original file line number Diff line number Diff line change
Expand Up @@ -1274,11 +1274,8 @@ <h3>Non-English manual pages</h3>
<ol>
<li>If upstream provides non-English manual pages, install them if
that is possible without jumping through hoops, and unless there
are specific reasons not too. "They are outdated" is not a good
reason to not install them, as long as upstream still includes them
in the official distribution. We don't try to judge the quality
of third-party English documentation either, and besides, knowing
<em>something</em> is available may motivate users to improve it.
are specific reasons not to.
"They are outdated" is not a good reason to exclude them.

<li>Never install any encoding except UTF-8.
If upstream provides UTF-8, great.
Expand All @@ -1289,25 +1286,19 @@ <h3>Non-English manual pages</h3>
way as with English manuals, simply install the UTF-8 source
code to <tt>man/language/manN/*.N</tt> and do not <tt>USE_GROFF</tt>.

<li>If mandoc does not cope - which should be very rare by now,
we have less than 130 ports left in the whole tree that still
<tt>USE_GROFF</tt>, even for English manuals - the proper order of
<li>If mandoc does not cope, the proper order of
operations is iconv(1) -t UTF-8, then preconv(1), then nroff(1),
never some other way round.

<li>If possible, install to <tt>man/language/manN</tt>,
without any "_" or "@": KISS.
without any "_" or "@" characters.
Never include the encoding in the path name, and make sure
the <tt>/language/</tt> part never contains "." (a dot).

<li>As an exception, use <tt>zh_CN</tt> and <tt>zh_TW</tt> rather
than just <tt>zh</tt>.
Also, keep <tt>pt</tt> and <tt>pt_BR</tt> as they are upstream,
and install both if available. The Brazilian version is often
better maintained, and it's not our job to try and merge the two
into a common directory.
Delete ridiculous stuff like <tt>en_*</tt> and <tt>fr_CA</tt> rather
than installing it.
and install both if available.
</ol>

<p>If the above is followed, people can do the following with no
Expand Down

0 comments on commit b123615

Please sign in to comment.