From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-1.mimecast.com (us-smtp-1.mimecast.com [207.211.31.120]) by mx.groups.io with SMTP id smtpd.web12.66.1587478700288084316 for ; Tue, 21 Apr 2020 07:18:21 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=YSVTah5f; spf=pass (domain: redhat.com, ip: 207.211.31.120, mailfrom: lersek@redhat.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1587478699; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Ey608TB6/2NwbSaWbM6n+2BIOIM6mofhPrrjiPxMILY=; b=YSVTah5fGC6ILoK0NLc1xDBpy3curiaptdKwO58XRhyxvAh4BbiEcQBOA7d9nszSo3NEkT Pj8d9piTI5wtcGRZciGDgxUjnkxue4hCb9cDgjSAA5eeTa7mWKuE0p187iSwBJWicBHdvz 6CzA4WR1ltUyHbv3CSkj9utIsS3Xids= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-235-Tfqr8K34Nb6zxJdIVJRaKQ-1; Tue, 21 Apr 2020 10:18:05 -0400 X-MC-Unique: Tfqr8K34Nb6zxJdIVJRaKQ-1 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id C5145DB61; Tue, 21 Apr 2020 14:18:03 +0000 (UTC) Received: from lacos-laptop-7.usersys.redhat.com (ovpn-115-52.ams2.redhat.com [10.36.115.52]) by smtp.corp.redhat.com (Postfix) with ESMTP id EF73D1001925; Tue, 21 Apr 2020 14:18:00 +0000 (UTC) Subject: Re: [PATCH v2 0/6] Edk2 Platform and Core CI for ArmVirtPkg, EmulatorPkg, and OvmfPkg To: michael.kubacki@outlook.com, devel@edk2.groups.io Cc: Andrew Fish , Ard Biesheuvel , Bret Barkelew , Jordan Justen , Leif Lindholm , Liming Gao , Michael D Kinney , Ray Ni , Sean Brogan References: From: "Laszlo Ersek" Message-ID: <5fcd80ac-03d1-a806-6a69-4602bc0d352c@redhat.com> Date: Tue, 21 Apr 2020 16:18:00 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.9.1 MIME-Version: 1.0 In-Reply-To: X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Language: en-US Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit On 04/20/20 21:12, michael.kubacki@outlook.com wrote: > ArmVirtPkg/ReadMe.rst | 139 ++++++++++ > EmulatorPkg/README.rst | 175 +++++++++++++ > OvmfPkg/README.rst | 211 +++++++++++++++ I made a mistake -- I apologize. * In my email here (two links to the same message): http://mid.mail-archive.com/061ab841-33fb-b46f-a9e7-1b5ce0d2e2f4@redhat.com https://edk2.groups.io/g/devel/message/57468 I gladly accepted the option offered by Sean that we put the CI-specific README files (for at least OvmfPkg and ArmVirtPkg) under the PlatformCI subdirectory. Quote: On 04/16/20 16:51, Laszlo Ersek wrote: > On 04/15/20 22:38, sean.brogan via [] wrote: >> If that isn't desirable i would at least suggest we change the title >> to just ReadMe.md so that GitHub shows it by default when the >> PaltformCI folder is viewed form the web or in editor like vscode. > > This sounds 100% viable and great to me. I didn't expect this could > work! (I'm generally unaware of the readme filename patterns, and > locations, that github.com recognizes; sorry about that.) Having an > "unadorned" ReadMe.md file under PlatformCI is just perfect. > > So if I understand correctly, we could choose: > > ArmVirtPkg/ArmVirtPkg.ci.yaml > ArmVirtPkg/PlatformCI/PlatformBuild.py > ArmVirtPkg/PlatformCI/ReadMe.md > ArmVirtPkg/PlatformCI/Ubuntu-GCC5.yml > ArmVirtPkg/PlatformCI/iasl_ext_dep.yaml > > Do I understand right? > > Because, I'd find this great! Back then, the format for the readme was assumed MD, but that wasn't the main topic -- the main topic was the directory layout. * Then, when the MD vs. RST format question came up, I checked the RST format (the *contents*), and I was happy with it. My email (two links again): http://mid.mail-archive.com/1be6a25d-06e2-4109-8acf-0fe82d150af4@redhat.com https://edk2.groups.io/g/devel/message/57611 *However*, unfortunately, when looking at the RST format improvements, I missed that Sean implemented the RST files directly in the package root directories; and *not* under the PlatformCI directory. I'm very sorry for missing that -- I assumed that the text files were under PlatformCI like I had requested / agreed earlier, and I didn't realize from the URLs that Sean pasted that this wasn't the case. So, I have two observations / requests: (1) The three RST file names are capitalized differently (two use ALL CAPS, one uses CamelCase), before the .rst suffix. Please stick with one style. (2) I'd really like these RST text files to be moved under the respective PlatformCI directories. (My understanding is, from Sean's message quoted above, that this is possible, and github can display it well when the user browses the PlatformCI directory in a web browser.) With those updates, for the OvmfPkg and ArmVirtPkg patches: Acked-by: Laszlo Ersek Thanks! Laszlo