Date: Sun, 26 Apr 2015 16:08:52 +0000 (UTC) From: Eitan Adler <eadler@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r46602 - head/en_US.ISO8859-1/articles/committers-guide Message-ID: <201504261608.t3QG8qrd011869@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: eadler Date: Sun Apr 26 16:08:51 2015 New Revision: 46602 URL: https://svnweb.freebsd.org/changeset/doc/46602 Log: committer guide: remove www/ reference; mention igor - www/ is the old repo for doc/*/htdocs so don't mention it anymore - explicitly mention using igor for both docbook and man pages - use <package> rather than command for manck Modified: head/en_US.ISO8859-1/articles/committers-guide/article.xml Modified: head/en_US.ISO8859-1/articles/committers-guide/article.xml ============================================================================== --- head/en_US.ISO8859-1/articles/committers-guide/article.xml Sun Apr 26 15:57:37 2015 (r46601) +++ head/en_US.ISO8859-1/articles/committers-guide/article.xml Sun Apr 26 16:08:51 2015 (r46602) @@ -3580,12 +3580,14 @@ Relnotes: yes</programlisting> <title>Other Suggestions</title> <para>When committing documentation changes, use a spell checker - before committing. For all XML docs, you should also - verify that your formatting directives are correct by running - <command>make lint</command>.</para> - - <para>For all on-line manual pages, run <command>manck</command> - (from ports) over the manual page to verify all of the cross + before committing. For all XML docs, verify that the + formatting directives are correct by running + <command>make lint</command> and + <package>textproc/igor</package>.</para> + + <para>For manual pages, run <package>sysutils/manck</package> + and <package>textproc/igor</package> + over the manual page to verify all of the cross references and file references are correct and that the man page has all of the appropriate <varname>MLINK</varname>s installed.</para> @@ -3595,8 +3597,8 @@ Relnotes: yes</programlisting> the code. Mixing the changes obfuscates the functionality change when asking for differences between revisions, which can hide any new bugs. Do not include whitespace changes with - content changes in commits to <filename>doc/</filename> or - <filename>www/</filename>. The extra clutter in the diffs + content changes in commits to <filename>doc/</filename> . + The extra clutter in the diffs makes the translators' job much more difficult. Instead, make any style or whitespace changes in separate commits that are clearly labeled as such in the commit message.</para>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201504261608.t3QG8qrd011869>