From owner-freebsd-doc@FreeBSD.ORG Wed Sep 19 10:10:02 2007 Return-Path: Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 7C8D916A41B for ; Wed, 19 Sep 2007 10:10:02 +0000 (UTC) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (freefall.freebsd.org [IPv6:2001:4f8:fff6::28]) by mx1.freebsd.org (Postfix) with ESMTP id 4E9FB13C458 for ; Wed, 19 Sep 2007 10:10:02 +0000 (UTC) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) by freefall.freebsd.org (8.14.1/8.14.1) with ESMTP id l8JAA2RJ028937 for ; Wed, 19 Sep 2007 10:10:02 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.14.1/8.14.1/Submit) id l8JAA2jb028936; Wed, 19 Sep 2007 10:10:02 GMT (envelope-from gnats) Resent-Date: Wed, 19 Sep 2007 10:10:02 GMT Resent-Message-Id: <200709191010.l8JAA2jb028936@freefall.freebsd.org> Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer) Resent-To: freebsd-doc@FreeBSD.org Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org, "Alexey Dokuchaev" Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 0F20216A417 for ; Wed, 19 Sep 2007 10:05:15 +0000 (UTC) (envelope-from danfe@FreeBSD.org) Received: from ru.asempra.com (ru.asempra.com [80.64.81.150]) by mx1.freebsd.org (Postfix) with ESMTP id 5714813C467 for ; Wed, 19 Sep 2007 10:05:13 +0000 (UTC) (envelope-from danfe@FreeBSD.org) Received: from stan.asempra.local (stan.asempra.local [192.168.33.20]) by ru.asempra.com (8.12.11.20060308/8.12.11) with ESMTP id l8J9oAUx015296 for ; Wed, 19 Sep 2007 16:50:16 +0700 Message-Id: <1190195323.18655@stan.asempra.local> Date: Wed, 19 Sep 2007 16:48:43 +0700 From: "Alexey Dokuchaev" To: "FreeBSD gnats submit" X-Send-Pr-Version: gtk-send-pr 0.4.8 Cc: Subject: docs/116459: [Porters' Handbook] Thing to watch out while adding patches with lots of useless whitespace changes X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 19 Sep 2007 10:10:02 -0000 >Number: 116459 >Category: docs >Synopsis: [Porters' Handbook] Thing to watch out while adding patches with lots of useless whitespace changes >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: change-request >Submitter-Id: current-users >Arrival-Date: Wed Sep 19 10:10:01 GMT 2007 >Closed-Date: >Last-Modified: >Originator: Alexey Dokuchaev >Release: FreeBSD 7.0-CURRENT i386 >Organization: >Environment: System: FreeBSD 7.0-CURRENT #1: Wed Jul 11 20:20:23 NOVST 2007 root@stan.asempra.local:/usr/obj/usr/src/sys/LITE >Description: I've seen on several occasions that people do not use their best judgement when fixing some problematic issue with their ports, by committing huge patches that consist mostly of non-functional whitespace. Those are, despite being huge, make people's lived significantly harder if they decide to find out the root of the problem, since they'd have to deal with tons of "noise" hunks while reading such patches. Attached is my quick'n'dirty attept to write appropriate warning paragraph in Porters' Book. It probably nees some polishing. It also contains indentation nit along the way. >How-To-Repeat: N/A >Fix: --- diff begins here --- Index: book.sgml =================================================================== RCS file: /home/dcvs/doc/en_US.ISO8859-1/books/porters-handbook/book.sgml,v retrieving revision 1.870 diff -u -r1.870 book.sgml --- book.sgml 9 Sep 2007 00:24:33 -0000 1.870 +++ book.sgml 19 Sep 2007 09:39:23 -0000 @@ -680,8 +680,18 @@ autoconf to regenerate configure, do not take the diffs of configure (it often grows to a few thousand - lines!); define USE_AUTOTOOLS=autoconf:253 and take the - diffs of configure.in. + lines!); define USE_AUTOTOOLS=autoconf:253 and + take the diffs of configure.in. + + Also, try to minimize the amount of non-functional whitespace + in your patches. It is common in Open Source world for projects + to share large amount of code base, but obey different style and + indent rules. If you take working piece of functionality from one + project to fix similar area in another, be careful: resulting + several-thousand line patch may be well worth of non-functional + changes. Besides increasing the size of CVS repository, it makes + other people's trying to find out exactly what had caused the + problem lives harder. If you had to delete a file, then you can do it in the post-extract target rather than as part of --- diff ends here --- >Release-Note: >Audit-Trail: >Unformatted: