From owner-svn-src-all@FreeBSD.ORG Sun Apr 19 16:18:00 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 9154145E for ; Sun, 19 Apr 2015 16:18:00 +0000 (UTC) Received: from mail-wi0-x22c.google.com (mail-wi0-x22c.google.com [IPv6:2a00:1450:400c:c05::22c]) (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 11C7ED32 for ; Sun, 19 Apr 2015 16:18:00 +0000 (UTC) Received: by widdi4 with SMTP id di4so72562541wid.0 for ; Sun, 19 Apr 2015 09:17:58 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=eitanadler.com; s=0xdeadbeef; h=mime-version:sender:in-reply-to:references:from:date:message-id :subject:to:cc:content-type; bh=OWheE/8NvSRGSQpoG12UQeAuRvFXvx/kf7heYkZE3do=; b=ZFTR2rCkgwCw7YoSUM13Za6MbVjLFQ6dHfc9n0VAdxfk8w/w74Xeip9SJSYlA8virj MoqblEVt7Mt8xVnfaVvOG9uhi7D31S8SBTQhmHWuMsPP5IfjOma6fALrjUdko8k4WgSK rjRRv02wp5TU0vnbu1ULqsdLjuLLm9+VmXqqY= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:sender:in-reply-to:references:from :date:message-id:subject:to:cc:content-type; bh=OWheE/8NvSRGSQpoG12UQeAuRvFXvx/kf7heYkZE3do=; b=X+WSg2op97+nipb08Tewir2y8Br9eEbrv9z00RgscRywlPj3NkUe2KjtHUzDk6TcaN pyDrsqbrc7FjxxcUSZYf2fm6MUdJJJPnFkVnqac4Lh7/huBPw8BkzLYJzCMlrbYkWlI5 yGyFTolgTySd4cLkSqzwTaLEoV7+dUvANGkf3dr/cOKq2q/AL77a+Pnyrq0z7YMZUAMx LxHtMg87M6crrmBeb8QzsBfQp5TO8U2oXnZw5bNppTdrKWHX+P2a6Jr1XpNm8LTR62tB GSq5CMqbvH02zOFpV7SR4H2+kweGKDAsV9gqPkYh7x+NGoQS1fEDixH6GEPEXh4yTeA6 Wxkw== X-Gm-Message-State: ALoCoQka2U7nZv/PJySo/m3LFi2jQnLrpymIwG+BOKvj+J4mEjoS8qc09lTLkazQYbCJPQm1gvdN X-Received: by 10.180.92.161 with SMTP id cn1mr17752429wib.91.1429460278540; Sun, 19 Apr 2015 09:17:58 -0700 (PDT) MIME-Version: 1.0 Sender: lists@eitanadler.com Received: by 10.28.211.135 with HTTP; Sun, 19 Apr 2015 09:17:28 -0700 (PDT) In-Reply-To: <20150419153927.GA30772@FreeBSD.org> References: <201504190716.t3J7GjmW072744@svn.freebsd.org> <20150419083451.GA79519@FreeBSD.org> <20150419153927.GA30772@FreeBSD.org> From: Eitan Adler Date: Sun, 19 Apr 2015 09:17:28 -0700 X-Google-Sender-Auth: q3csPyRtl2UU8nmpczbJoabm4qY Message-ID: Subject: Re: svn commit: r281727 - head To: Alexey Dokuchaev Cc: "src-committers@freebsd.org" , "svn-src-all@freebsd.org" , "svn-src-head@freebsd.org" Content-Type: text/plain; charset=UTF-8 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 16:18:00 -0000 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. -- Eitan Adler Source, Ports, Doc committer Bugmeister, Ports Security teams