From owner-svn-src-head@freebsd.org Wed Mar 1 16:17:59 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 B1203CE4AF9; Wed, 1 Mar 2017 16:17:59 +0000 (UTC) (envelope-from freebsd-rwg@pdx.rh.CN85.dnsmgr.net) Received: from pdx.rh.CN85.dnsmgr.net (br1.CN84in.dnsmgr.net [69.59.192.140]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 6C827786; Wed, 1 Mar 2017 16:17:59 +0000 (UTC) (envelope-from freebsd-rwg@pdx.rh.CN85.dnsmgr.net) Received: from pdx.rh.CN85.dnsmgr.net (localhost [127.0.0.1]) by pdx.rh.CN85.dnsmgr.net (8.13.3/8.13.3) with ESMTP id v21GHuTH057101; Wed, 1 Mar 2017 08:17:56 -0800 (PST) (envelope-from freebsd-rwg@pdx.rh.CN85.dnsmgr.net) Received: (from freebsd-rwg@localhost) by pdx.rh.CN85.dnsmgr.net (8.13.3/8.13.3/Submit) id v21GHuiI057100; Wed, 1 Mar 2017 08:17:56 -0800 (PST) (envelope-from freebsd-rwg) From: "Rodney W. Grimes" Message-Id: <201703011617.v21GHuiI057100@pdx.rh.CN85.dnsmgr.net> Subject: Re: svn commit: r314473 - head In-Reply-To: To: Ed Maste Date: Wed, 1 Mar 2017 08:17:56 -0800 (PST) CC: Warner Losh , Warner Losh , src-committers , "svn-src-all@freebsd.org" , "svn-src-head@freebsd.org" X-Mailer: ELM [version 2.4ME+ PL121h (25)] MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Type: text/plain; charset=US-ASCII 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:17:59 -0000 [ Charset UTF-8 unsupported, converting... ] > On 1 March 2017 at 09:58, Warner Losh wrote: > > > > 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. > > I think the whitespace is a mistake, since the markdown version is > rendered in variable width with proportional font, so hard 80-col > wrapping is undesirable. I've removed the whitespace in r314495. Thank you Ed, this makes much more sense for me too. > > 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'm happy for us to have a README.md although we now have the issue of > keeping them in sync (if we want to). I have no objection what so ever to the README.md file. > There are some minor things that we don't want to make completely > identical -- for example, the rendered version claims "This file was > last revised on: $FreeBSD$" because the svn-git exporter does not > expand $FreeBSD$. I think we ought to just remove that sentence from > the markdown version. What about a From: line using the $FreeBSD$ of README? At least that might give some a notion that they should change README if they find something wrong in README.md? > Perhaps this suggests we don't try to keep them in sync, which is > likely fine as they'll generally be seen by different groups of people > (markdown for those browsing the project on GitHub, plain README for > those with an installed source tree). I would think 2 files with the same basename of README being used by 2 different groups for the same purpose, a map of the src, should be syncronized some how. -- Rod Grimes rgrimes@freebsd.org