From owner-svn-src-head@freebsd.org Wed Mar 1 16:11:11 2017 Return-Path: Delivered-To: svn-src-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 98A5CCE46C1 for ; Wed, 1 Mar 2017 16:11:11 +0000 (UTC) (envelope-from wlosh@bsdimp.com) Received: from mail-io0-x22a.google.com (mail-io0-x22a.google.com [IPv6:2607:f8b0:4001:c06::22a]) (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)) by mx1.freebsd.org (Postfix) with ESMTPS id 5FF0CFF8 for ; Wed, 1 Mar 2017 16:11:11 +0000 (UTC) (envelope-from wlosh@bsdimp.com) Received: by mail-io0-x22a.google.com with SMTP id l7so34163913ioe.3 for ; Wed, 01 Mar 2017 08:11:11 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bsdimp-com.20150623.gappssmtp.com; s=20150623; h=mime-version:sender:in-reply-to:references:from:date:message-id :subject:to:cc; bh=s0+dmz5TxKX2v58IZIHPTelo6tC8OO8kqiooLAIs1pE=; b=Ngj0xoH7qAlLLi0IyPbdK1Pr85eEI4K7DtaoyGLno/iYwvqRse7hKmBahYdnOdtv20 2kd7CNJqSmKyntwcxG+I4sQBoznXbOm3PbA0cFJTpEAdeIoIZ0sYJpAmbmCSpJjoOvpD 3rSzVQvIgmK9mo2eeNvlwkMG6Q7A1xI3WcYfF7jjctjA2OH9J2153jJeRpdw0zaVfrTZ 9uDVtBvOAfWvWUiVmDKr+U3uF9wSqYeAfsCZlIF5dAWoMnIWMHW1VdnBJR4Hv5jBvwSO 7etb0B6du9cPwVBnCgKrYP0++pZrXoLnGtlvNTj9ECBcwPnkfNaNWuNz2sEveMf3nmCV 0BMQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:sender:in-reply-to:references:from :date:message-id:subject:to:cc; bh=s0+dmz5TxKX2v58IZIHPTelo6tC8OO8kqiooLAIs1pE=; b=Zku7sMfgfQ44/MUbCccwJMz/FLMt6tAhaclK7lezYCgSCJ0DvddwvHJC4/yp3emGYB GuvCedRh7lAR7eIqXOPmbUOzhs0O+9YTyVJgIOeW8hldlfuNeFjlnFrw3c+6FAhdZjoR qPkcBvV2u3CH0BbW3ly8dgEf/3a7zQH5Kd6/QhRDzwZ30cpJw1YFeXz8Loeikip5da7o F2QbagdMn4vcePgBboIaUlhExHgyeDq38nqkWDqk2oKPIS6j3gQNe1X2lfEO54MmHQvE z8vOprl3Si6MZS0t0ZBm505hVxsTTjHUDoWxmC4TnE5hhZF/vbWbo1uMCdzYJYlEbGg0 4MSg== X-Gm-Message-State: AMke39lmHI1khpHPbL8XDySrcggBTkfc1nET7b6EGtQgEn2IyMUGBG0cLw9y6mNFcsswB+Gn835zAhCGddOfyw== X-Received: by 10.107.134.94 with SMTP id i91mr9131111iod.0.1488384670657; Wed, 01 Mar 2017 08:11:10 -0800 (PST) MIME-Version: 1.0 Sender: wlosh@bsdimp.com Received: by 10.79.134.129 with HTTP; Wed, 1 Mar 2017 08:11:10 -0800 (PST) X-Originating-IP: [50.253.99.174] In-Reply-To: <201703011604.v21G4dq6056985@pdx.rh.CN85.dnsmgr.net> References: <201703011604.v21G4dq6056985@pdx.rh.CN85.dnsmgr.net> From: Warner Losh Date: Wed, 1 Mar 2017 09:11:10 -0700 X-Google-Sender-Auth: a0X3_fnvH901XYPVNZIOwLCSgzc Message-ID: Subject: Re: svn commit: r314473 - head To: "Rodney W. Grimes" Cc: Warner Losh , 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.23 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, 01 Mar 2017 16:11:11 -0000 On Wed, Mar 1, 2017 at 9:04 AM, Rodney W. Grimes wrote: >> On Tue, Feb 28, 2017 at 10:45 PM, Rodney W. Grimes >> 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 >> >> 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//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. > > Yes, but then couldnt this be a pointer to readme? We have this > documented now in 3 places that are gona just get further out > of sync. Or at least add a note to README that says you need > to update README.md if you touch this file. README changes about once every other year. Not worth the churn. >> The trailing whitespace is part >> of the conversion and not a mistake. > > I have learned this now and responded else where. It appears > that there are ways to do this in markdown without using > trailing double spaces as a syntax item. > >> 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. > > I agree that the submission is useful, as the README.md file, > just would like to see some polish put on it so it doesnt > suffer the same bitrot that hier(7) has. I can't see what polish we could put here that would prevent that. If heir(7) is so horrible, fix it. Looking at it now shows just a tiny bit of rot in /usr/include and maybe /usr/share/doc. Warner