From owner-svn-doc-all@FreeBSD.ORG Thu Feb 6 17:43:17 2014 Return-Path: Delivered-To: svn-doc-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id BA462759; Thu, 6 Feb 2014 17:43:17 +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)) (No client certificate requested) by mx1.freebsd.org (Postfix) with ESMTPS id A18CE1155; Thu, 6 Feb 2014 17:43:17 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.8/8.14.8) with ESMTP id s16HhH5O046991; Thu, 6 Feb 2014 17:43:17 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.8/8.14.8/Submit) id s16HhHEb046990; Thu, 6 Feb 2014 17:43:17 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201402061743.s16HhHEb046990@svn.freebsd.org> From: Warren Block Date: Thu, 6 Feb 2014 17:43:17 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r43808 - head/en_US.ISO8859-1/books/porters-handbook X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.17 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 06 Feb 2014 17:43:17 -0000 Author: wblock Date: Thu Feb 6 17:43:17 2014 New Revision: 43808 URL: http://svnweb.freebsd.org/changeset/doc/43808 Log: Improve this section grammatically and systematically. Reviewed by: bapt, mat (in slightly earlier forms) Modified: head/en_US.ISO8859-1/books/porters-handbook/book.xml Modified: head/en_US.ISO8859-1/books/porters-handbook/book.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/book.xml Thu Feb 6 17:42:21 2014 (r43807) +++ head/en_US.ISO8859-1/books/porters-handbook/book.xml Thu Feb 6 17:43:17 2014 (r43808) @@ -804,10 +804,10 @@ PLIST_DIRS= lib/X11/onekopatch-src-freeglut__joystick.c. Please only use characters - [-+._a-zA-Z0-9] for naming your patches. + [-+._a-zA-Z0-9] for naming patches. Do not use any other characters besides them. Do not name - your patches like patch-aa or - patch-ab etc, always mention the path and + patches like patch-aa or + patch-ab, always mention the path and file name in patch names. There is an alternate, easier method for creating patches to existing files. @@ -845,8 +845,8 @@ PLIST_DIRS= lib/X11/onekoTry to minimize the amount of non-functional whitespace changes in patches. It is common in the Open Source world for projects to share large amounts of a code - base, but obey different style and indenting rules. If you - take a working piece of functionality from one project to fix + base, but obey different style and indenting rules. When + taking a working piece of functionality from one project to fix similar areas in another, please be careful: the resulting line patch may be full of non-functional changes. It not only increases the size of the @@ -854,35 +854,39 @@ PLIST_DIRS= lib/X11/oneko - If you had to delete a file, then you can do it in the + If a file must be deleted, do it in the post-extract target rather than as part of the patch. Simple replacements can be performed directly from the port Makefile using the in-place mode of - &man.sed.1;. This is very useful when you need to patch in a - variable value. Example: + &man.sed.1;. This is useful when changes use the value of a variable: post-patch: @${REINPLACE_CMD} -e 's|for Linux|for FreeBSD|g' ${WRKSRC}/README Quite often, software being ported uses the CR/LF - convention for its source files. This may cause problems with - further patching, compiler warnings, scripts execution (e.g., - /bin/sh^M not found.) To quickly convert - all files from CR/LF to just LF, add - USES=dos2unix to the port - Makefile. A list of files to convert can - be specified: - - DOS2UNIX_FILES= util.c util.h - - If you want to convert a group of files across - subdirectories, DOS2UNIX_REGEX can be used. - Its argument is a find compatible regular + convention in source files. This may cause problems with + further patching, compiler warnings, or script execution (like + /bin/sh^M not found.) To quickly convert + all files from CR/LF to just LF, add this entry + to the port + Makefile: + + USES= dos2unix + + A list of specific files to convert can + be given: + + USES= dos2unix +DOS2UNIX_FILES= util.c util.h + + Use DOS2UNIX_REGEX to convert a group + of files across subdirectories. + Its argument is a &man.find.1;-compatible regular expression. More on the format is in &man.re.format.7;. This option is useful for converting all files of a given - extension, for example all source code files leaving binary + extension. For example, convert all source code files, leaving binary files intact: USES= dos2unix