From owner-svn-src-head@freebsd.org Wed May 23 23:11:15 2018 Return-Path: Delivered-To: svn-src-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 19A97EEBB92; Wed, 23 May 2018 23:11:15 +0000 (UTC) (envelope-from jhb@freebsd.org) Received: from smtp.freebsd.org (unknown [IPv6:2610:1c1:1:606c::24b:4]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "smtp.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id C279083CD5; Wed, 23 May 2018 23:11:14 +0000 (UTC) (envelope-from jhb@freebsd.org) Received: from ralph.baldwin.cx (ralph.baldwin.cx [66.234.199.215]) (using TLSv1 with cipher ECDHE-RSA-AES256-SHA (256/256 bits)) (Client did not present a certificate) (Authenticated sender: jhb) by smtp.freebsd.org (Postfix) with ESMTPSA id 8E766BBC0; Wed, 23 May 2018 23:11:14 +0000 (UTC) (envelope-from jhb@freebsd.org) From: John Baldwin To: Eitan Adler Cc: src-committers , svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: Re: svn commit: r334073 - head Date: Wed, 23 May 2018 15:48:25 -0700 Message-ID: <7080153.TjCS0o8iqD@ralph.baldwin.cx> User-Agent: KMail/4.14.10 (FreeBSD/11.1-STABLE; KDE/4.14.30; amd64; ; ) In-Reply-To: References: <201805230409.w4N491iB057004@repo.freebsd.org> <3609973.viVQJQYxmB@ralph.baldwin.cx> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" X-BeenThere: svn-src-head@freebsd.org X-Mailman-Version: 2.1.26 Precedence: list List-Id: SVN commit messages for the src tree for head/-current List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 23 May 2018 23:11:15 -0000 On Wednesday, May 23, 2018 12:09:59 PM Eitan Adler wrote: > On 23 May 2018 at 09:27, John Baldwin wrote: > > On Wednesday, May 23, 2018 04:09:01 AM Eitan Adler wrote: > >> Author: eadler > >> Date: Wed May 23 04:09:01 2018 > >> New Revision: 334073 > >> URL: https://svnweb.freebsd.org/changeset/base/334073 > >> > >> Log: > >> README: Reduce the textdump; describe the project > >> > >> Rework the README to make it a little easier for new users. This is the > >> first file many will see when persuing the FreeBSD source code so > >> > >> - remove some of the text describes how to build. This is better covered > >> in the linked documentation. > >> - add a small blurb for what FreeBSD is. Some users might find this > >> document through features such as github search so they may not even > >> know what the project is > >> > >> generally, gear this file for the new, accidental, or casual user rather > >> than towards someone seeking fuller documentation. > >> > >> Modified: > >> head/README > >> head/README.md > >> > >> Modified: head/README > >> ============================================================================== > >> --- head/README Wed May 23 03:41:22 2018 (r334072) > >> +++ head/README Wed May 23 04:09:01 2018 (r334073) > >> @@ -2,35 +2,25 @@ This is the top level of the FreeBSD source directory. > >> - > >> -The kernel configuration files reside in the sys//conf > >> -sub-directory. GENERIC is the default configuration used in release builds. > >> -NOTES contains entries and documentation for all possible > >> -devices, not just those commonly used. > > > > I do think this paragraph is still useful as part of the Source Roadmap and > > not really part of the build instructions. > > I added a reference to sys//conf to the bottom of the > README.Adding something about NOTES might be helpful, but IMHO closer > to the build. Yes, but the directory doesn't tell you which file is the default kernel. I'm thinking in terms of a random person browsing the tree via github's web interface who doesn't know which files are which in which case I think this note was kind of useful. -- John Baldwin