From owner-svn-src-head@freebsd.org Wed May 23 19:10:31 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 5526FEAE0D9 for ; Wed, 23 May 2018 19:10:31 +0000 (UTC) (envelope-from eadler@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 02BD179A28 for ; Wed, 23 May 2018 19:10:31 +0000 (UTC) (envelope-from eadler@freebsd.org) Received: from mail-yw0-f180.google.com (mail-yw0-f180.google.com [209.85.161.180]) (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 BD5C8A2B2 for ; Wed, 23 May 2018 19:10:30 +0000 (UTC) (envelope-from eadler@freebsd.org) Received: by mail-yw0-f180.google.com with SMTP id h11-v6so6277465ywc.8 for ; Wed, 23 May 2018 12:10:30 -0700 (PDT) X-Gm-Message-State: ALKqPwf1HzGvmipD6k4BwxOfSbUwJKQArBlv8ZhGvPboNMc7Vqdeuzm5 iFCgI/uLiKI8JQXAf412e9TUlEsHJK/rqmiK1A3oZw== X-Google-Smtp-Source: AB8JxZq9FGq3b8HvFeDgZ4IRvvFQbC5jdGwhV8ydNpba0N12xcm5uJ0DsLIlqO4o+Y5yBUFSJDBf/sBcp9jMk80lUGg= X-Received: by 2002:a81:5fc4:: with SMTP id t187-v6mr2272800ywb.19.1527102630229; Wed, 23 May 2018 12:10:30 -0700 (PDT) MIME-Version: 1.0 Received: by 2002:a25:c709:0:0:0:0:0 with HTTP; Wed, 23 May 2018 12:09:59 -0700 (PDT) In-Reply-To: <3609973.viVQJQYxmB@ralph.baldwin.cx> References: <201805230409.w4N491iB057004@repo.freebsd.org> <3609973.viVQJQYxmB@ralph.baldwin.cx> From: Eitan Adler Date: Wed, 23 May 2018 12:09:59 -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: Wed, 23 May 2018 19:10:31 -0000 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. -- Eitan Adler Source, Ports, Doc committer Bugmeister, Ports Security teams