From nobody@FreeBSD.org  Sun Nov  2 18:05:01 2008
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id C4B271065677
	for <freebsd-gnats-submit@FreeBSD.org>; Sun,  2 Nov 2008 18:05:01 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (www.freebsd.org [IPv6:2001:4f8:fff6::21])
	by mx1.freebsd.org (Postfix) with ESMTP id B30418FC1C
	for <freebsd-gnats-submit@FreeBSD.org>; Sun,  2 Nov 2008 18:05:01 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (localhost [127.0.0.1])
	by www.freebsd.org (8.14.3/8.14.3) with ESMTP id mA2I51Lk087610
	for <freebsd-gnats-submit@FreeBSD.org>; Sun, 2 Nov 2008 18:05:01 GMT
	(envelope-from nobody@www.freebsd.org)
Received: (from nobody@localhost)
	by www.freebsd.org (8.14.3/8.14.3/Submit) id mA2I51de087609;
	Sun, 2 Nov 2008 18:05:01 GMT
	(envelope-from nobody)
Message-Id: <200811021805.mA2I51de087609@www.freebsd.org>
Date: Sun, 2 Nov 2008 18:05:01 GMT
From: Eitan Adler <EitanAdlerList@gmail.com>
To: freebsd-gnats-submit@FreeBSD.org
Subject: [patch] remove extra line in developers handbook (tools chapter)
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         128543
>Category:       docs
>Synopsis:       [patch] remove extra line in developers handbook (tools chapter)
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    pgj
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Nov 02 18:10:01 UTC 2008
>Closed-Date:    Mon Nov 10 01:28:08 UTC 2008
>Last-Modified:  Mon Nov 10 01:28:08 UTC 2008
>Originator:     Eitan Adler
>Release:        N/A
>Organization:
>Environment:
N/A
>Description:
<quote>This will produce a debug version of the program.</quote>
on http://www.freebsd.org/doc/en/books/developers-handbook/tools-compiling.html
is not needed
>How-To-Repeat:

>Fix:


Patch attached with submission follows:

--- oldchapter.sgml	2008-11-02 12:58:57.000000000 -0500
+++ chapter.sgml	2008-11-02 12:59:13.000000000 -0500
@@ -514,9 +514,6 @@
 	    </screen>
 	  </informalexample>
 
-	  <para>This will produce a debug version of the
-	    program.
-
 	    <footnote>
 	      <para>Note, we did not use the <option>-o</option> flag
 		to specify the executable name, so we will get an


>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->pgj 
Responsible-Changed-By: pgj 
Responsible-Changed-When: Mon Nov 3 06:14:08 UTC 2008 
Responsible-Changed-Why:  
Snatch 

http://www.freebsd.org/cgi/query-pr.cgi?pr=128543 
State-Changed-From-To: open->feedback 
State-Changed-By: pgj 
State-Changed-When: Sat Nov 8 06:04:03 UTC 2008 
State-Changed-Why:  
Requires further reasoning 

http://www.freebsd.org/cgi/query-pr.cgi?pr=128543 

From: Gabor PALI <pgj@FreeBSD.org>
To: bug-followup@FreeBSD.org, Eitan Adler <eitanadlerlist@gmail.com>
Cc:  
Subject: Re: docs/128543: [patch] remove extra line in developers handbook
 (tools chapter)
Date: Sat, 08 Nov 2008 07:03:12 +0100

 Hello Eitan,
 
 Could you explain why to remove this sentence?  By reading the text, I
 do not feel any problem with it.  Please, describe the reasons more in
 detail, otherwise I will simply close this PR.
 
 Thanks in advance.
 

From: Gabor PALI <pgj@FreeBSD.org>
To: Eitan Adler <eitanadlerlist@gmail.com>
Cc: bug-followup@FreeBSD.org
Subject: Re: docs/128543: [patch] remove extra line in developers handbook
 (tools chapter)
Date: Sun, 09 Nov 2008 18:50:53 +0100

 Eitan Adler wrote:
 > I feel that from the preceding sentences the statement is obvious.
 > "In order to cut the grass you must use a lawnmower"
 > <command>lawnmower</command>
 > This cuts the grass.
 > 
 > It seems obvious
 >
 
 I think it is primarily a didactic vehicle, a method for trying to
 explain commands clearly.  In your example, a specific command is given
 the reader to issue, and this command may be more complex in other
 situations.  It may seem obvious to you, but it may not for some readers:
 
 - What does indicate the lawnmower is started by command `lawnmower`?
 (In the first sentence, there is no such postulate, it is just a general
 statement.)
 
 - If I issue command `lawnmower` what should happen exactly?
 
 It is only a unfortunate coincidence that effect of command `lawnmower`
 is the same as in the general case.
 
 It is a very common style for presenting concepts, FreeBSD documentation
 is full of them, you might also kill all the other instances in the same
 section.
 
 Please, do not think that your efforts are not appreciated, but the
 proposed changes in question are highly disputable in my humble opinion.
  It is rather matter of taste, and "de gustibus non est disputandum" :)
 
 By the way...  Have you tested your changes?  For your information,
 applying your patch directly results a broken build (because it leaves a
 <para> tag unmatched.)
 
 Cheers,
 :g

From: Gabor PALI <pgj@FreeBSD.org>
To: Eitan Adler <eitanadlerlist@gmail.com>
Cc: bug-followup@FreeBSD.org
Subject: Re: docs/128543: [patch] remove extra line in developers handbook
 (tools chapter)
Date: Mon, 10 Nov 2008 02:18:18 +0100

 Eitan Adler wrote:
 > Gabor PALI wrote:
 >> [..]
 >> It is a very common style for presenting concepts, FreeBSD documentation
 >> is full of them, you might also kill all the other instances in the same
 >> section.
 > I'll accept that.  It just looked odd to me when I first saw it.
 > 
 >> Please, do not think that your efforts are not appreciated, but the
 >> proposed changes in question are highly disputable in my humble opinion
 > No problem ;)
 > .
 >>  It is rather matter of taste, and "de gustibus non est disputandum" :)
 > I could google that but, it means?
 
 "the tastes is not a thing to discuss" -- there is no reason to argue
 about certain topics, because there are several good solutions for a
 problem.  Changing them would result a continuous, but senseless
 alternation in the sources.  In this case, it is matter of choice what
 type of presentation style is chosen.  It is also very good candidate
 for bike shed painting :) [1]
 
 >> By the way...  Have you tested your changes?  For your information,
 >> applying your patch directly results a broken build (because it leaves a
 >> <para> tag unmatched.)
 > 1) I created patch 2) tested 3) fixed and recreated patch 4) submitted
 > old patch
 
 Ah, I see.
 
 > This was my first patch to the handbook anyways. ;)
 
 It is a start.  Next time you will know what to care about :)
 
 Well, I close this PR.  Thanks for the submission, though.
 
 
 [1] http://www.freebsd.org/doc/en/books/faq/misc.html#BIKESHED-PAINTING
State-Changed-From-To: feedback->closed 
State-Changed-By: pgj 
State-Changed-When: Mon Nov 10 01:24:27 UTC 2008 
State-Changed-Why:  
We have agreed on that there is no need to change anything. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=128543 
>Unformatted:
