Date: Sun, 19 Apr 2015 09:17:28 -0700 From: Eitan Adler <eadler@freebsd.org> To: Alexey Dokuchaev <danfe@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: <CAF6rxgmiHD_3jd7oWcLSVEd_0fnbn6PR1e7J5ykHGiqnPEvhhA@mail.gmail.com> In-Reply-To: <20150419153927.GA30772@FreeBSD.org> References: <201504190716.t3J7GjmW072744@svn.freebsd.org> <20150419083451.GA79519@FreeBSD.org> <CAF6rxg=6kBDzsMqDk95aCBRqY7CYsYNu-GFDJ-7Ank4s6ybEiQ@mail.gmail.com> <20150419153927.GA30772@FreeBSD.org>
next in thread | previous in thread | raw e-mail | index | archive | help
On 19 April 2015 at 08:39, Alexey Dokuchaev <danfe@freebsd.org> 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.) I will have a conversation with the phabricator folks. If there is an option to provide a custom parser for such things I don't see the harm in trying it. -- 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?CAF6rxgmiHD_3jd7oWcLSVEd_0fnbn6PR1e7J5ykHGiqnPEvhhA>