From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-wr1-f43.google.com (mail-wr1-f43.google.com [209.85.221.43]) by mx.groups.io with SMTP id smtpd.web09.6766.1632314785329317499 for ; Wed, 22 Sep 2021 05:46:25 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@nuviainc-com.20210112.gappssmtp.com header.s=20210112 header.b=ZWPteGVi; spf=pass (domain: nuviainc.com, ip: 209.85.221.43, mailfrom: leif@nuviainc.com) Received: by mail-wr1-f43.google.com with SMTP id d21so6292462wra.12 for ; Wed, 22 Sep 2021 05:46:25 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nuviainc-com.20210112.gappssmtp.com; s=20210112; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to; bh=q0htx1Wne13CphHjzUub+AZfH3qTDuANIMw9RR02a24=; b=ZWPteGViXLVqeyqVZK7VwdoArYtwr7bxP/aSjgVJjGPp2ufmtuEj341MBX/ecEJyJd WrP2AY4NVZNw3JRtlgRZPnOoVmUpSIG1NyZ4dS1GrZzcVUTvuv08YYjukhp6g0QCVsLY f4/UjDXUCTi5T+++kS/q/NI303jtT93n0/EjtgdE5WejX/myBeF2Sz1pZWbn4hpecKZx UC+2dYbRute7dkbSStMGMTEQ1flUxNOQwytiymmyLlnk2ASH8iVN+SSNWGKTHxwtYc4+ IgM5dHkC6FjOwDtlODrM/jL6WSLHQySpr52kVrj7acfd9cpsEiVegwt9rfRcz60ln0tV obdg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to; bh=q0htx1Wne13CphHjzUub+AZfH3qTDuANIMw9RR02a24=; b=MsOBXf+GEvbNj/zcV6l3yygGorwN9nFqxPc1Rm0VqQnnNQ2QpD5fA0EkbfnnJP40DM rvcnZxtsP4WirrQ11aiIs8hmN6xw95MDJxFCDzICLUFobDoGuYKE5HDUn37pj4e3cBzZ vq7QwhC3YxLlcgPVn1vw90YlkUxkoTHm56I1Ea7Ib1Khz5/wNBuvNZn5iHJ+ZYaLsziq xtFYmY2pNvlckP9F2BbuRQiZinHDI+p70ava7rF7rBT2+zbXwbytNB8YBMPL3pfjG6CF KRxq2bIdRNZJaHCLV2tsjjVaPcsrlVZ/Hs0DpeGvRZSez46NMD7BjCAj2WBaY3WvEMBx /feg== X-Gm-Message-State: AOAM533vOYcJXRd1JV2E0RguAFNucFzjjboCMlcEaWJ2K8UhLLmNNIKB cfN2F+X7qgpRVuP367qNB958jg== X-Google-Smtp-Source: ABdhPJw+QGbVeL79dzqK+pIBw0h2cTbECEEQXkYuUU+FbyIOLEWYyQCmmnkcOmGQy6tT6k/qmtSNVA== X-Received: by 2002:a05:600c:22d4:: with SMTP id 20mr10131252wmg.177.1632314783752; Wed, 22 Sep 2021 05:46:23 -0700 (PDT) Return-Path: Received: from leviathan (cpc92314-cmbg19-2-0-cust559.5-4.cable.virginm.net. [82.11.186.48]) by smtp.gmail.com with ESMTPSA id u29sm2199872wru.34.2021.09.22.05.46.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 22 Sep 2021 05:46:23 -0700 (PDT) Date: Wed, 22 Sep 2021 13:46:21 +0100 From: "Leif Lindholm" To: Marcin Wojtas Cc: edk2-devel-groups-io , Ard Biesheuvel , Grzegorz Jaszczyk , Grzegorz Bernacki , Samer El-Haj-Mahmoud , alon.rotman@solid-run.com Subject: Re: [edk2-platforms PATCH 0/4] Marvell readmes Message-ID: <20210922124621.orqr5wj26zqfzac5@leviathan> References: <20210921110056.659697-1-mw@semihalf.com> <20210922121451.f7iyi76uca77wimp@leviathan> MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=us-ascii Content-Disposition: inline On Wed, Sep 22, 2021 at 14:20:31 +0200, Ard Biesheuvel wrote: > On Wed, 22 Sept 2021 at 14:14, Leif Lindholm wrote: > > > > On Wed, Sep 22, 2021 at 13:24:07 +0200, Ard Biesheuvel wrote: > > > On Tue, 21 Sept 2021 at 13:02, Marcin Wojtas 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? Some suggestions/requests: The top-level Readme.md should contain all relevant build system and cross compilation information, so please refer to that instead of duplicating information. If it is missing some generically useful information, please add it. (That file, for example, points out the appropriate location to get arm cross-toolchains from if your distro doesn't provide them, and Linaro stopped working on GCC years ago.) Please *do* document the repositories required to build (and hence need to specify in PACKAGES_PATH). The example build command line for CN913x CEx7 requires edk2-non-osi. Please don't document the inclusion of the Shell TFTP command by default. Mention it as an option if you must. Document the builds in chronological order, don't interleave TF-A and EDK2 instructions. Ideally, cut TF-A instructions down to a bare minimum (e.g. "pass the generated EDK2 image to the TF-A build with `$ export BL33=...`) and link to aforementioned wiki page for the full recipe. Best Regards, Leif