From owner-svn-src-head@freebsd.org Sun Jun 17 19:45:20 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 3969E1007865 for ; Sun, 17 Jun 2018 19:45:20 +0000 (UTC) (envelope-from eadler@freebsd.org) Received: from smtp.freebsd.org (smtp.freebsd.org [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 DF37A7BDAE for ; Sun, 17 Jun 2018 19:45:19 +0000 (UTC) (envelope-from eadler@freebsd.org) Received: from mail-yb0-f179.google.com (mail-yb0-f179.google.com [209.85.213.179]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (Client CN "smtp.gmail.com", Issuer "Google Internet Authority G2" (verified OK)) (Authenticated sender: eadler) by smtp.freebsd.org (Postfix) with ESMTPSA id A8D1BCBB5 for ; Sun, 17 Jun 2018 19:45:19 +0000 (UTC) (envelope-from eadler@freebsd.org) Received: by mail-yb0-f179.google.com with SMTP id a16-v6so2411074ybm.2 for ; Sun, 17 Jun 2018 12:45:19 -0700 (PDT) X-Gm-Message-State: APt69E3gvYKSiTM20wKiRtWPP/XcQ+lhR+ykqQ5S4XF4HJ3743GpBDTy tUyWSf6S5AxFyzpjW5ksuknygWT11QsjCdNH5pHmCA== X-Google-Smtp-Source: ADUXVKKYNeXhzQIuv5gDBq69iDFtJoSIcVWRYu11CC1TQzQpJXAsWOQ1oOQLbrLlfHUVLBCa90fRYmV84eSKVjXj01g= X-Received: by 2002:a25:2605:: with SMTP id m5-v6mr5202768ybm.89.1529264719235; Sun, 17 Jun 2018 12:45:19 -0700 (PDT) MIME-Version: 1.0 Received: by 2002:a25:ef50:0:0:0:0:0 with HTTP; Sun, 17 Jun 2018 12:44:48 -0700 (PDT) In-Reply-To: <7080153.TjCS0o8iqD@ralph.baldwin.cx> References: <201805230409.w4N491iB057004@repo.freebsd.org> <3609973.viVQJQYxmB@ralph.baldwin.cx> <7080153.TjCS0o8iqD@ralph.baldwin.cx> From: Eitan Adler Date: Sun, 17 Jun 2018 12:44:48 -0700 X-Gmail-Original-Message-ID: Message-ID: Subject: Re: svn commit: r334073 - head To: John Baldwin Cc: src-committers , svn-src-all@freebsd.org, svn-src-head@freebsd.org Content-Type: text/plain; charset="UTF-8" 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: Sun, 17 Jun 2018 19:45:20 -0000 On 23 May 2018 at 15:48, John Baldwin wrote: > 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. Sending README Sending README.md Transmitting file data ..done Committing transaction... Committed revision 335299. -- Eitan Adler Source, Ports, Doc committer Bugmeister, Ports Security teams