From owner-svn-src-all@FreeBSD.ORG Sun Apr 19 17:14:45 2015 Return-Path: Delivered-To: svn-src-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id 71141401 for ; Sun, 19 Apr 2015 17:14:45 +0000 (UTC) Received: from mail-wg0-f47.google.com (mail-wg0-f47.google.com [74.125.82.47]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (Client CN "smtp.gmail.com", Issuer "Google Internet Authority G2" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 097B7329 for ; Sun, 19 Apr 2015 17:14:44 +0000 (UTC) Received: by wgsk9 with SMTP id k9so156888295wgs.3 for ; Sun, 19 Apr 2015 10:14:36 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:message-id:date:user-agent:mime-version:to :cc:subject:references:in-reply-to:content-type :content-transfer-encoding; bh=WotAkS5bHeZqIwUbfamZeFYSUW0J3eFyWKEmiLIH69c=; b=IOhivorlHA4oaF+e3ZKsfZfoZhJrffURG1ziQHeqXOoGsUxHt1hjC3046fnwC7hbyQ Ja9pSKSR+pVG/9iiHs+xxun5hi7mUlAsIeX2Q0l8NW5AysbSyiMCQ05aqGNeZpTW7U6m YbOEpKSscJHZFQ1IlSWhaiZy67FyKVcWWoqR2q5BolztZxa0bmmMpK1SVvF/PY+LTNSn JlnqUEX/A8DbvdQ7G3QARcdLxTzXIosOl7tjtSVltIV1ETrHI9iJvW/nwk12DqJKVszq PWrSF2w8W7pyrz8WyHvw92Thk7PHbvZW2l4ca0mRedC58g0cHsqlGP+2kWSVviemlmCS HGiw== X-Gm-Message-State: ALoCoQmkXtop4t+eOvxZfPGTggf4FDBssGMk4aIcmUQk0kpSsD3TeA2TNGRHkLjhJBWEptP/RS0p X-Received: by 10.194.157.39 with SMTP id wj7mr23932158wjb.57.1429463261196; Sun, 19 Apr 2015 10:07:41 -0700 (PDT) Received: from [10.10.1.68] (82-69-141-170.dsl.in-addr.zen.co.uk. [82.69.141.170]) by mx.google.com with ESMTPSA id eh5sm11692553wic.20.2015.04.19.10.07.39 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sun, 19 Apr 2015 10:07:40 -0700 (PDT) From: Steven Hartland X-Google-Original-From: Steven Hartland Message-ID: <5533E0E1.7030801@freebsd.org> Date: Sun, 19 Apr 2015 18:07:45 +0100 User-Agent: Mozilla/5.0 (Windows NT 5.1; rv:31.0) Gecko/20100101 Thunderbird/31.6.0 MIME-Version: 1.0 To: Eitan Adler , Alexey Dokuchaev CC: "src-committers@freebsd.org" , "svn-src-all@freebsd.org" , "svn-src-head@freebsd.org" Subject: Re: svn commit: r281727 - head References: <201504190716.t3J7GjmW072744@svn.freebsd.org> <20150419083451.GA79519@FreeBSD.org> <20150419153927.GA30772@FreeBSD.org> In-Reply-To: Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit X-BeenThere: svn-src-all@freebsd.org X-Mailman-Version: 2.1.20 Precedence: list List-Id: "SVN commit messages for the entire src tree \(except for " user" and " projects" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 19 Apr 2015 17:14:45 -0000 On 19/04/2015 17:17, Eitan Adler wrote: > On 19 April 2015 at 08:39, 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 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. Making the simple changes in the commit achieves its goal and it doesn't effect its readability in plan text so why wast time adapting tools when its not needed. Lets not be afraid to adapt for the greater good :) Regards Steve