From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by mx.groups.io with SMTP id smtpd.web12.13886.1587288957882144420 for ; Sun, 19 Apr 2020 02:35:58 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: arm.com, ip: 217.140.110.172, mailfrom: ard.biesheuvel@arm.com) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 51ACC1FB; Sun, 19 Apr 2020 02:35:57 -0700 (PDT) Received: from [192.168.1.81] (unknown [172.31.20.19]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id A0ED53F6C4; Sun, 19 Apr 2020 02:35:56 -0700 (PDT) Subject: Re: [edk2-devel] [PATCH v1 2/6] ArmVirtPkg: Add Platform CI and configuration for Core CI To: devel@edk2.groups.io, sean.brogan@microsoft.com, Laszlo Ersek Cc: "Kinney, Michael D" References: From: "Ard Biesheuvel" Message-ID: Date: Sun, 19 Apr 2020 11:35:55 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.7.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit On 4/19/20 10:29 AM, Sean via groups.io wrote: > Laszlo, > > Regarding your comments about disliking the verbosity of the markdown table/html table for build status both in Core Ci and now these Platform CI readme files. > > As a learning experience I updated the OvmfPkg readme to use reStructuredText instead of markdown. Not sure if I like RST but it does allow the links to not be in html and supports directives so you can push all that text to end of the file. > > Do you like this enough that I should rework all three readmes and we should discuss if RST should be used instead of MD for the edk2 project? > > RST version: https://github.com/spbrogan/edk2/blob/PlatformAndCoreCIForOvmfArmVirtEmulatorPackages_v8/OvmfPkg/README.rst > MD version: https://github.com/spbrogan/edk2/blob/PlatformAndCoreCIForOvmfArmVirtEmulatorPackages_v7/OvmfPkg/README-pytools.md > I think the rendered RST looks really good, and is perfectly usable as plaintext too. AFAICT, we are not losing out on anything the v7 version provided, right? If not, I am in favor of going with RST in this case, which I suppose implies that I am in favor of permitting it in EDK2 for purposes such as this one. That does not necessarily imply that all markdown should be replaced with RST. I'm perfectly happy letting them co-exist, and I don't have an opinion on whether one should be recommended over the other, or which that should have to be. > This is really the last remaining issue for the PlatformCI patchset. > Agreed. This is converging really nicely. -- Ard.