Date: Sun, 19 Apr 2015 09:13:50 -0700 From: Eitan Adler <eadler@freebsd.org> To: Ian Lepore <ian@freebsd.org> Cc: Alexey Dokuchaev <danfe@freebsd.org>, "src-committers@freebsd.org" <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: r281727 - head Message-ID: <CAF6rxg=6h3BT615erF=6gbrAQXX%2BTe0japGg%2BfgHe2sSMitZQg@mail.gmail.com> In-Reply-To: <1429458286.1182.89.camel@freebsd.org> References: <201504190716.t3J7GjmW072744@svn.freebsd.org> <20150419083451.GA79519@FreeBSD.org> <CAF6rxg=6kBDzsMqDk95aCBRqY7CYsYNu-GFDJ-7Ank4s6ybEiQ@mail.gmail.com> <20150419153927.GA30772@FreeBSD.org> <1429458286.1182.89.camel@freebsd.org>
next in thread | previous in thread | raw e-mail | index | archive | help
On 19 April 2015 at 08:44, Ian Lepore <ian@freebsd.org> wrote: > On Sun, 2015-04-19 at 15:39 +0000, Alexey Dokuchaev wrote: >> On Sun, Apr 19, 2015 at 01:42:08AM -0700, Eitan Adler wrote: >> > On 19 April 2015 at 01:34, Alexey Dokuchaev <danfe@freebsd.org> wrote: >> > > On Sun, Apr 19, 2015 at 07:16:45AM +0000, Eitan Adler wrote: >> > >> New Revision: 281727 >> > >> URL: https://svnweb.freebsd.org/changeset/base/281727 >> > >> >> > >> Log: >> > >> README: changes and fixups >> > >> Two orthogonal goals: >> > >> - try to make README look a little nicer on phabricator by using >> > >> Remarkup syntax for commands (using `` instead of using a >> > >> closing ') >> > >> - try to make README look a little nicer on github. >> > > >> > > FreeBSD had traditionally used both double (``...'') and single (`...') >> > > to express "literal" something; I am not convinced that changing it >> > > just to match GitHub's markdown warrants it. This `...` form is alien >> > > to FreeBSD, and can be also confused with backquoted form of shell's >> > > $(...) command substitution. >> > >> > Without this change, the syntax ends up being parsed very weirdly by >> > both phabricator and github. That said, if there is strong precedent >> > not to use the markdown syntax, and it would cause confusion, I will >> > revert those changes. >> >> I understand your reasons. I don't think we have any strong precedent >> for those things, but nor do I want to neglect the issue of markdowning >> our docs... Seeing /usr/ports/CONTRIBUTING.md already made me shiver. >> >> Since we control our own installation of Phabricator, maybe we should >> teach it to recognize ``...'' and `...' instead of converting them? >> (I don't know what to do about GitHub, but I don't like the idea that >> their markdown syntax inadvertently affects our files.) >> >> ./danfe >> > > Indeed, chasing the fad of the day seems like a Really Bad Idea. I know > people are religious about github and will bristle at labeling it a fad. > People had similar feelings about sourceforge a few years ago. We > wisely avoiding changing anything then, and we should do so some more. There is a difference between chasing the latest fad at the expense of the tools we already use, vs trying to allow users to do both. > Our readme and similar files are plain ascii text. If that confuses > github, then the fix needs to be applied at github. Note well: I avoided changing the files to be pure Markdown or Remarkup. I kept the files readable as plaintext. The goal of r281727 (this commit) was to - keep the plaintext readable - make it more readable on github - make it more readable on phabricator As an example, in the list of the 'source roadmap' only the entry usr.sbin has a single tab instead of double tab. This causes it to be non-tabular when parsed as GHB. I chose not to fix this, because it would break the plaintext alignment. Trying to get all three of these right is actually quite difficult :'( -- 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?CAF6rxg=6h3BT615erF=6gbrAQXX%2BTe0japGg%2BfgHe2sSMitZQg>