svn commit: r281727 - head

[Alexey Dokuchaev]

On Sun, Apr 19, 2015 at 01:42:08AM -0700, Eitan Adler wrote:
> On 19 April 2015 at 01:34, Alexey Dokuchaev <danfe at 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