Date: Sun, 17 Jun 2018 12:44:48 -0700 From: Eitan Adler <eadler@freebsd.org> To: John Baldwin <jhb@freebsd.org> Cc: src-committers <src-committers@freebsd.org>, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: Re: svn commit: r334073 - head Message-ID: <CAF6rxgkUnj0dCqqTdHho5dEQUfY7b9QEK9UKkQ1zHa2Ldrbuwg@mail.gmail.com> In-Reply-To: <7080153.TjCS0o8iqD@ralph.baldwin.cx> References: <201805230409.w4N491iB057004@repo.freebsd.org> <3609973.viVQJQYxmB@ralph.baldwin.cx> <CAF6rxgmhYT6sd=SJacR5Gc62-BZAXX2sbhcg22n=5LaMfRHRMA@mail.gmail.com> <7080153.TjCS0o8iqD@ralph.baldwin.cx>
next in thread | previous in thread | raw e-mail | index | archive | help
On 23 May 2018 at 15:48, John Baldwin <jhb@freebsd.org> wrote: > On Wednesday, May 23, 2018 12:09:59 PM Eitan Adler wrote: >> On 23 May 2018 at 09:27, John Baldwin <jhb@freebsd.org> 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/<arch>/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/<arch>/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
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CAF6rxgkUnj0dCqqTdHho5dEQUfY7b9QEK9UKkQ1zHa2Ldrbuwg>