Date: Wed, 1 Mar 2017 07:58:25 -0700 From: Warner Losh <imp@bsdimp.com> To: "Rodney W. Grimes" <freebsd-rwg@pdx.rh.cn85.dnsmgr.net> Cc: Warner Losh <imp@freebsd.org>, src-committers <src-committers@freebsd.org>, "svn-src-all@freebsd.org" <svn-src-all@freebsd.org>, "svn-src-head@freebsd.org" <svn-src-head@freebsd.org> Subject: Re: svn commit: r314473 - head Message-ID: <CANCZdfrxUwv4_8JJ7QjeBNzYGvG5mxyaR2K4TW-0yny8kak25A@mail.gmail.com> In-Reply-To: <201703010545.v215jPSG054051@pdx.rh.CN85.dnsmgr.net> References: <201703010505.v21556lZ034584@repo.freebsd.org> <201703010545.v215jPSG054051@pdx.rh.CN85.dnsmgr.net>
next in thread | previous in thread | raw e-mail | index | archive | help
On Tue, Feb 28, 2017 at 10:45 PM, Rodney W. Grimes <freebsd-rwg@pdx.rh.cn85.dnsmgr.net> wrote: >> Author: imp >> Date: Wed Mar 1 05:05:05 2017 >> New Revision: 314473 >> URL: https://svnweb.freebsd.org/changeset/base/314473 >> >> Log: >> Create README.md file for viewing on github. >> >> This is a lightly edited README using github's MARKDOWN. >> >> Submitted by: Johan <johan2422@gmail.com> >> Pull Request: https://github.com/freebsd/freebsd/pull/56 >> >> Added: >> head/README.md (contents, props changed) >> >> Added: head/README.md >> ============================================================================== >> --- /dev/null 00:00:00 1970 (empty, because file is newly added) >> +++ head/README.md Wed Mar 1 05:05:05 2017 (r314473) >> @@ -0,0 +1,86 @@ >> +FreeBSD Source: >> +--------------- >> +This is the top level of the FreeBSD source directory. This file >> +was last revised on: >> +$FreeBSD$ >> + >> +For copyright information, please see the file COPYRIGHT in this >> +directory (additional copyright information also exists for some >> +sources in this tree - please see the specific source directories for >> +more information). >> + >> +The Makefile in this directory supports a number of targets for >> +building components (or all) of the FreeBSD source tree. See build(7) >> +and http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html >> +for more information, including setting make(1) variables. >> + >> +The `buildkernel` and `installkernel` targets build and install >> +the kernel and the modules (see below). Please see the top of >> +the Makefile in this directory for more information on the >> +standard build targets and compile-time flags. >> + >> +Building a kernel is a somewhat more involved process. See build(7), config(8), >> +and http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html >> +for more information. >> + >> +Note: If you want to build and install the kernel with the >> +`buildkernel` and `installkernel` targets, you might need to build >> +world before. More information is available in the handbook. >> + >> +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. >> + >> + >> +Source Roadmap: >> +--------------- > > Is there someway this can be a pointer to the usr/src part of > hier(7) and have hier(7) updated to reflect current reality? > > Also lots and lots of trailing white space... > > This should be a pointer to hier(7) It's a verbatim copy of README converted to markdown. Maybe README should be fixed and this regenerated. The trailing whitespace is part of the conversion and not a mistake. If you want to update README and hier(7) and have README.md generated from that automatically, be my guest. None of that was in the submission, and the submission was useful as it was. Warner
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CANCZdfrxUwv4_8JJ7QjeBNzYGvG5mxyaR2K4TW-0yny8kak25A>