From owner-svn-doc-head@FreeBSD.ORG Sun Apr 26 16:08:52 2015 Return-Path: Delivered-To: svn-doc-head@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id BFF9C8A6; Sun, 26 Apr 2015 16:08:52 +0000 (UTC) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 94FF915F2; Sun, 26 Apr 2015 16:08:52 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.9/8.14.9) with ESMTP id t3QG8qse011870; Sun, 26 Apr 2015 16:08:52 GMT (envelope-from eadler@FreeBSD.org) Received: (from eadler@localhost) by svn.freebsd.org (8.14.9/8.14.9/Submit) id t3QG8qrd011869; Sun, 26 Apr 2015 16:08:52 GMT (envelope-from eadler@FreeBSD.org) Message-Id: <201504261608.t3QG8qrd011869@svn.freebsd.org> X-Authentication-Warning: svn.freebsd.org: eadler set sender to eadler@FreeBSD.org using -f From: Eitan Adler Date: Sun, 26 Apr 2015 16:08:52 +0000 (UTC) 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 X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.20 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 26 Apr 2015 16:08:52 -0000 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 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 Other Suggestions 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 - make lint. - - For all on-line manual pages, run manck - (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 + make lint and + textproc/igor. + + For manual pages, run sysutils/manck + and textproc/igor + 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 MLINKs installed. @@ -3595,8 +3597,8 @@ Relnotes: yes 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 doc/ or - www/. The extra clutter in the diffs + content changes in commits to doc/ . + 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.