Re: [PATCH v2 0/6] Edk2 Platform and Core CI for ArmVirtPkg, EmulatorPkg, and OvmfPkg

["Laszlo Ersek" <lersek@redhat.com>]

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 <lersek@redhat.com>

Thanks!
Laszlo