public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Marcin Wojtas" <mw@semihalf.com>
To: Ard Biesheuvel <ardb@kernel.org>
Cc: Leif Lindholm <leif@nuviainc.com>,
	edk2-devel-groups-io <devel@edk2.groups.io>,
	 Ard Biesheuvel <ardb+tianocore@kernel.org>,
	Grzegorz Jaszczyk <jaz@semihalf.com>,
	 Grzegorz Bernacki <gjb@semihalf.com>,
	Samer El-Haj-Mahmoud <Samer.El-Haj-Mahmoud@arm.com>,
	 Alon Rotman <alon.rotman@solid-run.com>
Subject: Re: [edk2-platforms PATCH 0/4] Marvell readmes
Date: Wed, 22 Sep 2021 14:46:10 +0200	[thread overview]
Message-ID: <CAPv3WKdCwNxq8=yFUhejuncDMQYfcJR8ii2bXsuKBBX5M1=8rg@mail.gmail.com> (raw)
In-Reply-To: <CAMj1kXF6VO31SzzX5ov1ncuTA7ciU7jNcFN8ggW6Ccc1ZS5YjQ@mail.gmail.com>

Hi Ard, Leif,

śr., 22 wrz 2021 o 14:20 Ard Biesheuvel <ardb@kernel.org> napisał(a):
>
> On Wed, 22 Sept 2021 at 14:14, Leif Lindholm <leif@nuviainc.com> wrote:
> >
> > On Wed, Sep 22, 2021 at 13:24:07 +0200, Ard Biesheuvel wrote:
> > > On Tue, 21 Sept 2021 at 13:02, Marcin Wojtas <mw@semihalf.com> wrote:
> > > >
> > > > Hi,
> > > >
> > > > This short patchset adds README files for the platforms
> > > > based on Marvell SoC's, which have already been
> > > > SystemReady ES certified. It also bumps the firmware
> > > > revision after the PCI / IcuLib rework and addition of
> > > > the CN913x CEx7 Evaluation Board support.
> > > >
> > > > The patches are available on a public branch:
> > > > https://github.com/semihalf-wojtas-marcin/edk2-platforms/commits/marvell-howtos-upstream-r20210921
> > > >
> > >
> > > Thanks
> > >
> > > Pushed as 64394fd2b48f..d1d4dd2c39e7
> >
> > Ugh, wish I'd taken the time to respond yesterday.
> >
> > This is more proliferation of "include all very specific build
> > steps for a very specific target and build environment" documentation.
> >
> > I don't see this as an improvement.
> >
> > Platform docs should document what one needs to know specific to the
> > platform. If a vendor wishes to provide full recipes, they should host
> > that on a wiki somewhere.
> >
>
> Fair point.
>
> Marcin, when you find the time, could you please do a pass over these
> files with Leif's critique in mind?


For all 3 platforms, how about the following update:
- extend the "Summary" section with supported features or interfaces
(or add an extra heading for that).
- "Build" section -> add link to external wiki/.md file
- "ARM System Ready certification." - leave intact

Please let me know if that will work for you.

Best regards1,
Marcin

  reply	other threads:[~2021-09-22 12:46 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-21 11:00 [edk2-platforms PATCH 0/4] Marvell readmes Marcin Wojtas
2021-09-21 11:00 ` [edk2-platforms PATCH 1/4] SolidRun/Cn913xCEx7Eval: Add Readme.md Marcin Wojtas
2021-09-21 11:00 ` [edk2-platforms PATCH 2/4] SolidRun/Armada80x0McBin: " Marcin Wojtas
2021-09-21 11:00 ` [edk2-platforms PATCH 3/4] Marvell/Cn913xDbA: " Marcin Wojtas
2021-09-21 11:00 ` [edk2-platforms PATCH 4/4] Marvell: Armada7k8k/OcteonTx: Bump firmware to "EDK2 SH 1.1" revision Marcin Wojtas
2021-09-22 11:24 ` [edk2-platforms PATCH 0/4] Marvell readmes Ard Biesheuvel
2021-09-22 12:14   ` Leif Lindholm
2021-09-22 12:20     ` Ard Biesheuvel
2021-09-22 12:46       ` Marcin Wojtas [this message]
2021-09-23 10:26         ` Leif Lindholm
2021-09-22 12:46       ` Leif Lindholm

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CAPv3WKdCwNxq8=yFUhejuncDMQYfcJR8ii2bXsuKBBX5M1=8rg@mail.gmail.com' \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox