Bug 86342

Summary: bikeshed entry of Handbook is wrong
Product: Documentation Reporter: Mikhail T. <freebsd-2024>
Component: Books & ArticlesAssignee: Doug Barton <dougb>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Mikhail T. 2005-09-19 19:00:38 UTC
	The doc on the "bikeshed" term, such as:

	http://www.freebsd.org/doc/en_US.ISO8859-1/articles/mailing-list-faq/bikeshed.html
	is wrong. It wrongly describes the "bikeshed" argument as
	anything, where there is no consensus -- "sh vs. csh" would
	qualify.

	The correct explanation in FAQ is linked to, and is quite
	different from that of the Handbook.

Fix: 

How about:

	"... However, in FreeBSD parlance, the word is a derogatory
	term that refers to any argument about a non-essential part
	of a proposed change, fix, or idea. Sometimes such arguments
	overshadow the discussion of the essential parts much to the
	detriment of progress. (The genesis of the ..."

	The second paragraph -- beginning with "More generally..." --
	should be removed altogether.
Comment 1 Nate Eldredge 2005-10-13 23:56:53 UTC
Okay, but I think "derogatory" should be changed to "disparaging" and 
"essential parts" should be changed to "basic features".

;-)

-- 
Nate Eldredge
nge@cs.hmc.edu
Comment 2 Eitan Adler freebsd_committer freebsd_triage 2011-02-25 18:50:23 UTC
Since no one else opted to do this I decided to actually make the patch


Index: article.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/articles/mailing-list-faq/article.sgml,v
retrieving revision 1.8
diff -u -r1.8 article.sgml
--- article.sgml	14 Nov 2009 22:20:12 -0000	1.8
+++ article.sgml	25 Feb 2011 18:29:45 -0000
@@ -492,12 +492,10 @@
     <title>What Is A "Bikeshed"?</title>
       <para>Literally, a <literal>bikeshed</literal> is a small outdoor
 	shelter into which one may store one's two-wheeled form of
-	transportation.  However, in &os; parlance, the word is a
-	derogatory term that refers to any oft-recurring discussion
-	about a particular subject; in particular, it is most often used
-	to refer to a topic which has never reached a consensus within
-	the &os; community, and instead remains controversial.  (The
-	genesis of this term is explained in more detail <ulink
+	transportation.  However, in &os; parlance, the word is
+	a metaphor indicating that you need not argue about every
+	little feature just because you know enough to do so.
+	(The genesis of this term is explained in more detail <ulink
 	url="&url.books.faq;/misc.html#BIKESHED-PAINTING">
 	in this document</ulink>).  You simply must have a working
 	knowledge of this concept before posting to any &os; mailing


-- 
Eitan Adler
Comment 3 Mikhail T. 2011-02-25 19:09:24 UTC
On 25.02.2011 13:50, Eitan Adler wrote:
> +	transportation.  However, in&os; parlance, the word is
Actually, if no other operating system's community has this particular 
concept defined, perhaps, we should explicitly use "FreeBSD" here, 
rather than the variable &os;? Yours,

    -mi
Comment 4 Eitan Adler freebsd_committer freebsd_triage 2011-02-26 02:09:10 UTC
State Changed
From-To: open->suspended

*sigh* - this generates more bikeshed then its worth.
Comment 5 dfilter service freebsd_committer freebsd_triage 2011-02-27 03:54:27 UTC
dougb       2011-02-27 03:54:21 UTC

  FreeBSD doc repository

  Modified files:
    en_US.ISO8859-1/articles/mailing-list-faq article.sgml 
  Log:
  Address the concern in the PR with a simpler explanation and
  emphasis on the Handbook article which has a good description.
  
  PR:             docs/86342
  Submitted by:   Mikhail Teterin <mi@aldan.algebra.com>
  
  Revision  Changes    Path
  1.9       +5 -8      doc/en_US.ISO8859-1/articles/mailing-list-faq/article.sgml
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
Comment 6 Doug Barton freebsd_committer freebsd_triage 2011-02-27 03:54:37 UTC
State Changed
From-To: suspended->closed


Put on my doc committer hat for a second and address the concern 
in this PR albeit with a different solution. 


Comment 7 Doug Barton freebsd_committer freebsd_triage 2011-02-27 03:54:37 UTC
Responsible Changed
From-To: freebsd-doc->dougb


I'm wearing the asbestos undies atm.