From owner-svn-src-head@FreeBSD.ORG  Sun Apr 19 15:39:27 2015
Return-Path: <owner-svn-src-head@FreeBSD.ORG>
Delivered-To: svn-src-head@freebsd.org
Received: by hub.freebsd.org (Postfix, from userid 1033)
 id CA3E0B1B; Sun, 19 Apr 2015 15:39:27 +0000 (UTC)
Date: Sun, 19 Apr 2015 15:39:27 +0000
From: Alexey Dokuchaev <danfe@FreeBSD.org>
To: Eitan Adler <eadler@freebsd.org>
Cc: "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: <20150419153927.GA30772@FreeBSD.org>
References: <201504190716.t3J7GjmW072744@svn.freebsd.org>
 <20150419083451.GA79519@FreeBSD.org>
 <CAF6rxg=6kBDzsMqDk95aCBRqY7CYsYNu-GFDJ-7Ank4s6ybEiQ@mail.gmail.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <CAF6rxg=6kBDzsMqDk95aCBRqY7CYsYNu-GFDJ-7Ank4s6ybEiQ@mail.gmail.com>
User-Agent: Mutt/1.5.23 (2014-03-12)
X-BeenThere: svn-src-head@freebsd.org
X-Mailman-Version: 2.1.20
Precedence: list
List-Id: SVN commit messages for the src tree for head/-current
 <svn-src-head.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/options/svn-src-head>,
 <mailto:svn-src-head-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-src-head/>
List-Post: <mailto:svn-src-head@freebsd.org>
List-Help: <mailto:svn-src-head-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/svn-src-head>,
 <mailto:svn-src-head-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Sun, 19 Apr 2015 15:39:27 -0000

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