Date: Wed, 1 Mar 2017 08:17:56 -0800 (PST) From: "Rodney W. Grimes" <freebsd-rwg@pdx.rh.CN85.dnsmgr.net> To: Ed Maste <emaste@freebsd.org> Cc: Warner Losh <imp@bsdimp.com>, 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: <201703011617.v21GHuiI057100@pdx.rh.CN85.dnsmgr.net> In-Reply-To: <CAPyFy2BabmR9Y_aXc3Tdu9vLuCZ86457i4_Gs7RQaN9u_rJdnQ@mail.gmail.com>
next in thread | previous in thread | raw e-mail | index | archive | help
[ Charset UTF-8 unsupported, converting... ] > On 1 March 2017 at 09:58, Warner Losh <imp@bsdimp.com> 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
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201703011617.v21GHuiI057100>