NetBSD Problem Report #29244

From wiz@dmath5.geometrie.tuwien.ac.at  Sat Feb  5 12:33:14 2005
Return-Path: <wiz@dmath5.geometrie.tuwien.ac.at>
Received: from dmath5.geometrie.tuwien.ac.at (dmath5.geometrie.tuwien.ac.at [128.130.42.105])
	by narn.netbsd.org (Postfix) with ESMTP id 0435363B400
	for <gnats-bugs@gnats.NetBSD.org>; Sat,  5 Feb 2005 12:33:14 +0000 (UTC)
Message-Id: <20050205123223.7CFAD2950A@dmath5.geometrie.tuwien.ac.at>
Date: Sat,  5 Feb 2005 13:32:23 +0100 (CET)
From: Thomas Klausner <wiz@NetBSD.org>
Reply-To: Thomas Klausner <wiz@NetBSD.org>
To: gnats-bugs@netbsd.org
Subject: share/mk/bsd.README should be merged into BUILDING
X-Send-Pr-Version: 3.95

>Number:         29244
>Category:       misc
>Synopsis:       share/mk/bsd.README should be merged into BUILDING
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    misc-bug-people
>State:          closed
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Sat Feb 05 12:34:00 +0000 2005
>Closed-Date:    Mon May 18 07:01:07 +0000 2009
>Last-Modified:  Mon May 18 07:01:07 +0000 2009
>Originator:     Thomas Klausner
>Release:        NetBSD 2.0
>Organization:
>Environment:


System: NetBSD dmath5.geometrie.tuwien.ac.at 2.0 NetBSD 2.0 (RAFFAELO) #0: Wed Dec 15 16:47:17 CET 2004 wiz@dmath5.geometrie.tuwien.ac.at:/home/2.0-src/sys/arch/i386/compile/RAFFAELO i386
Architecture: i386
Machine: i386
>Description:
share/mk/bsd.README documents some flags that are not documented
in BUILDING, but should be.

There is no point in having two places to document the same stuff, so
bsd.README should probably be merged into BUILDING.
>How-To-Repeat:
Read both, and note that e.g. MKHTML is in the former but not the latter.
>Fix:
Not provided.

>Release-Note:

>Audit-Trail:
From: James Chacon <jmc@NetBSD.org>
To: gnats-bugs@NetBSD.org
Cc: misc-bug-people@NetBSD.org, gnats-admin@NetBSD.org,
	netbsd-bugs@NetBSD.org
Subject: Re: misc/29244: share/mk/bsd.README should be merged into BUILDING
Date: Sun, 6 Feb 2005 02:37:44 -0600

 On Sat, Feb 05, 2005 at 12:34:00PM +0000, Thomas Klausner wrote:
 > >Number:         29244
 > >Category:       misc
 > >Synopsis:       share/mk/bsd.README should be merged into BUILDING
 > >Confidential:   no
 > >Severity:       non-critical
 > >Priority:       low
 > >Responsible:    misc-bug-people
 > >State:          open
 > >Class:          doc-bug
 > >Submitter-Id:   net
 > >Arrival-Date:   Sat Feb 05 12:34:00 +0000 2005
 > >Originator:     Thomas Klausner
 > >Release:        NetBSD 2.0
 > >Organization:
 > >Environment:
 > 	
 > 	
 > System: NetBSD dmath5.geometrie.tuwien.ac.at 2.0 NetBSD 2.0 (RAFFAELO) #0: Wed Dec 15 16:47:17 CET 2004 wiz@dmath5.geometrie.tuwien.ac.at:/home/2.0-src/sys/arch/i386/compile/RAFFAELO i386
 > Architecture: i386
 > Machine: i386
 > >Description:
 > share/mk/bsd.README documents some flags that are not documented
 > in BUILDING, but should be.
 > 
 > There is no point in having two places to document the same stuff, so
 > bsd.README should probably be merged into BUILDING.
 > >How-To-Repeat:
 > Read both, and note that e.g. MKHTML is in the former but not the latter.

 I disagree they should be merged into BUILDING. bsd.README includes more
 than just the build flags for the system. It's also describing in good
 detail how all the various .mk files interact/work for the targets they
 expose. This isn't needed in BUILDING and will just clutter it up.

 James

From: Thomas Klausner <wiz@NetBSD.org>
To: gnats-bugs@NetBSD.org
Cc: jmc@NetBSD.org
Subject: Re: misc/29244: share/mk/bsd.README should be merged into BUILDING
Date: Mon, 7 Feb 2005 15:32:07 +0100

 On Sun, Feb 06, 2005 at 02:37:44AM -0600, James Chacon wrote:
 > On Sat, Feb 05, 2005 at 12:34:00PM +0000, Thomas Klausner wrote:
 > > share/mk/bsd.README documents some flags that are not documented
 > > in BUILDING, but should be.
 > > 
 > > There is no point in having two places to document the same stuff, so
 > > bsd.README should probably be merged into BUILDING.
 > > >How-To-Repeat:
 > > Read both, and note that e.g. MKHTML is in the former but not the latter.
 > 
 > I disagree they should be merged into BUILDING. bsd.README includes more
 > than just the build flags for the system. It's also describing in good
 > detail how all the various .mk files interact/work for the targets they
 > expose. This isn't needed in BUILDING and will just clutter it up.

 Hm, that part really shouldn't be there. In any case, the flags
 should be documented in BUILDING. I'm not sure if they should be
 removed from bsd.README afterwards (it can just point to BUILDING).
  Thomas

From: matthew green <mrg@eterna.com.au>
To: gnats-bugs@netbsd.org
Cc: misc-bug-people@netbsd.org, gnats-admin@netbsd.org,
	netbsd-bugs@netbsd.org
Subject: re: misc/29244: share/mk/bsd.README should be merged into BUILDING 
Date: Tue, 08 Feb 2005 04:43:19 +1100


     Hm, that part really shouldn't be there. In any case, the flags
     should be documented in BUILDING. I'm not sure if they should be
     removed from bsd.README afterwards (it can just point to BUILDING).


 bsd.README is part of the make/mk documentation.  it should be
 self-complete.  BUILDING is about building netbsd.  they are
 quite separate things IMO ...

State-Changed-From-To: open->feedback
State-Changed-By: snj@NetBSD.org
State-Changed-When: Sun, 17 May 2009 22:32:41 +0000
State-Changed-Why:
I'm also of the mind that these two documents should not be merged.  Do
you feel strongly about this, wiz?


From: Thomas Klausner <wiz@NetBSD.org>
To: gnats-bugs@NetBSD.org
Cc: 
Subject: Re: misc/29244 (share/mk/bsd.README should be merged into BUILDING)
Date: Mon, 18 May 2009 07:59:22 +0200

 On Sun, May 17, 2009 at 10:32:42PM +0000, snj@NetBSD.org wrote:
 > I'm also of the mind that these two documents should not be merged.  Do
 > you feel strongly about this, wiz?

 No, it's ok.
 However, at least the building-relevant ones then should be also
 documented in BUILDING. I see that MKHTML is now documented, I haven't
 checked if there are others. Probably it's fine nowadays, so I'm ok
 with closing it.
  Thomas

State-Changed-From-To: feedback->closed
State-Changed-By: dholland@NetBSD.org
State-Changed-When: Mon, 18 May 2009 07:01:07 +0000
State-Changed-Why:
ok, let's close it.
IMO, bsd.README should be turned into real docs that BUILDING can refer to...


>Unformatted:

NetBSD Home
NetBSD PR Database Search

(Contact us) $NetBSD: query-full-pr,v 1.51 2026/08/10 02:28:17 riastradh Exp $
$NetBSD: gnats_config.sh,v 1.10 2026/05/13 22:00:09 riastradh Exp $
Copyright © 1994-2026 The NetBSD Foundation, Inc. ALL RIGHTS RESERVED.