svn commit: r281727 - head

[Eitan Adler]

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.


-- 
Eitan Adler
Source, Ports, Doc committer
Bugmeister, Ports Security teams