[edk2-platforms] [PATCH] Platform/Intel: Update Readme.md to point to edk2-non-osi master branch

[edk2-platforms] [PATCH] Platform/Intel: Update Readme.md to point to edk2-non-osi master branch

[Nate DeSimone]

Updated Platform/Intel/Readme.md to point to master branch on
edk2-non-osi instead of devel-MinPlatform

Updated edk2-platforms/Readme.md to point to Platform/Intel/Readme.md
for build instructions on Intel based Minimum Platforms

Added a link to the EDK II Minimum Platform Draft Specification
to Platform/Intel/Readme.md

Cc: Andrew Fish <afish@apple.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Leif Lindholm <leif.lindholm@linaro.org>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Michael Kubacki <michael.a.kubacki@intel.com>
Cc: Ankit Sinha <ankit.sinha@intel.com>
Cc: Chasel Chiu <chasel.chiu@intel.com>
Signed-off-by: Nate DeSimone <nathaniel.l.desimone@intel.com>
---
 Platform/Intel/Readme.md | 6 ++++--
 Readme.md                | 8 +++++++-
 2 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/Platform/Intel/Readme.md b/Platform/Intel/Readme.md
index 0a0e8a8c80..00f42985a2 100644
--- a/Platform/Intel/Readme.md
+++ b/Platform/Intel/Readme.md
@@ -1,7 +1,9 @@
 # **EDK II Minimum Platform Firmware for Intel(R) Platforms**
 
 The Minimum Platform is a software architecture that guides uniform delivery of Intel platforms enabling firmware
-solutions for basic boot functionality with extensibility built-in.
+solutions for basic boot functionality with extensibility built-in. Please see the
+[EDK II Minimum Platform Draft Specification](https://edk2-docs.gitbooks.io/edk-ii-minimum-platform-specification/)
+for more details.
 
 Package maintainers for the Minimum Platform projects are listed in Maintainers.txt.
 
@@ -98,7 +100,7 @@ return back to the minimum platform caller.
   * ``git clone https://github.com/tianocore/edk2-platforms.git``
 
 * edk2-non-osi repository
-  * ``git clone https://github.com/tianocore/edk2-non-osi.git -b devel-MinPlatform``
+  * ``git clone https://github.com/tianocore/edk2-non-osi.git``
 
 * FSP repository
   * ``git clone https://github.com/IntelFsp/FSP.git``
diff --git a/Readme.md b/Readme.md
index 63e59f60b4..28badd6b4b 100644
--- a/Readme.md
+++ b/Readme.md
@@ -34,6 +34,9 @@ edk2-devel mailing list with a subject prefix of `[platforms]`. See
 on how to do this successfully.
 
 # How to build (Linux Environment)
+Note: Build instructions for Intel based Minimum Platforms differ from these
+instructions and are available at
+[`edk2-platforms/Platform/Intel/README.md`](https://github.com/tianocore/edk2-platforms/blob/master/Platform/Intel/Readme.md)
 
 ## Prerequisites
 The build tools themselves depend on Python (2) and libuuid. Most Linux systems
@@ -195,8 +198,11 @@ $ ./uefi-tools/edk2-build.sh -b DEBUG -b RELEASE
 ```
 
 # How To Build (Windows Environment)
+Note: Build instructions for Intel based Minimum Platforms differ from these
+instructions and are available at
+[`edk2-platforms/Platform/Intel/README.md`](https://github.com/tianocore/edk2-platforms/blob/master/Platform/Intel/Readme.md)
 
-(I genuinely have no idea. Please help!)
+(For other platforms, I genuinely have no idea. Please help!)
 
 
 # Supported Platforms
-- 
2.17.1.windows.2

Re: [edk2-devel] [edk2-platforms] [PATCH] Platform/Intel: Update Readme.md to point to edk2-non-osi master branch

[Kubacki, Michael A]

Reviewed-by: Michael Kubacki <michael.a.kubacki@intel.com>

> -----Original Message-----
> From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
> Nate DeSimone
> Sent: Thursday, August 8, 2019 2:31 PM
> To: devel@edk2.groups.io
> Cc: Andrew Fish <afish@apple.com>; Laszlo Ersek <lersek@redhat.com>;
> Leif Lindholm <leif.lindholm@linaro.org>; Kinney, Michael D
> <michael.d.kinney@intel.com>; Kubacki, Michael A
> <michael.a.kubacki@intel.com>; Sinha, Ankit <ankit.sinha@intel.com>; Chiu,
> Chasel <chasel.chiu@intel.com>
> Subject: [edk2-devel] [edk2-platforms] [PATCH] Platform/Intel: Update
> Readme.md to point to edk2-non-osi master branch
> 
> Updated Platform/Intel/Readme.md to point to master branch on edk2-non-
> osi instead of devel-MinPlatform
> 
> Updated edk2-platforms/Readme.md to point to Platform/Intel/Readme.md
> for build instructions on Intel based Minimum Platforms
> 
> Added a link to the EDK II Minimum Platform Draft Specification to
> Platform/Intel/Readme.md
> 
> Cc: Andrew Fish <afish@apple.com>
> Cc: Laszlo Ersek <lersek@redhat.com>
> Cc: Leif Lindholm <leif.lindholm@linaro.org>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Michael Kubacki <michael.a.kubacki@intel.com>
> Cc: Ankit Sinha <ankit.sinha@intel.com>
> Cc: Chasel Chiu <chasel.chiu@intel.com>
> Signed-off-by: Nate DeSimone <nathaniel.l.desimone@intel.com>
> ---
>  Platform/Intel/Readme.md | 6 ++++--
>  Readme.md                | 8 +++++++-
>  2 files changed, 11 insertions(+), 3 deletions(-)
> 
> diff --git a/Platform/Intel/Readme.md b/Platform/Intel/Readme.md index
> 0a0e8a8c80..00f42985a2 100644
> --- a/Platform/Intel/Readme.md
> +++ b/Platform/Intel/Readme.md
> @@ -1,7 +1,9 @@
>  # **EDK II Minimum Platform Firmware for Intel(R) Platforms**
> 
>  The Minimum Platform is a software architecture that guides uniform
> delivery of Intel platforms enabling firmware -solutions for basic boot
> functionality with extensibility built-in.
> +solutions for basic boot functionality with extensibility built-in.
> +Please see the [EDK II Minimum Platform Draft
> +Specification](https://edk2-docs.gitbooks.io/edk-ii-minimum-platform-sp
> +ecification/)
> +for more details.
> 
>  Package maintainers for the Minimum Platform projects are listed in
> Maintainers.txt.
> 
> @@ -98,7 +100,7 @@ return back to the minimum platform caller.
>    * ``git clone https://github.com/tianocore/edk2-platforms.git``
> 
>  * edk2-non-osi repository
> -  * ``git clone https://github.com/tianocore/edk2-non-osi.git -b devel-
> MinPlatform``
> +  * ``git clone https://github.com/tianocore/edk2-non-osi.git``
> 
>  * FSP repository
>    * ``git clone https://github.com/IntelFsp/FSP.git``
> diff --git a/Readme.md b/Readme.md
> index 63e59f60b4..28badd6b4b 100644
> --- a/Readme.md
> +++ b/Readme.md
> @@ -34,6 +34,9 @@ edk2-devel mailing list with a subject prefix of
> `[platforms]`. See  on how to do this successfully.
> 
>  # How to build (Linux Environment)
> +Note: Build instructions for Intel based Minimum Platforms differ from
> +these instructions and are available at
> +[`edk2-
> platforms/Platform/Intel/README.md`](https://github.com/tianocor
> +e/edk2-platforms/blob/master/Platform/Intel/Readme.md)
> 
>  ## Prerequisites
>  The build tools themselves depend on Python (2) and libuuid. Most Linux
> systems @@ -195,8 +198,11 @@ $ ./uefi-tools/edk2-build.sh -b DEBUG -b
> RELEASE  ```
> 
>  # How To Build (Windows Environment)
> +Note: Build instructions for Intel based Minimum Platforms differ from
> +these instructions and are available at
> +[`edk2-
> platforms/Platform/Intel/README.md`](https://github.com/tianocor
> +e/edk2-platforms/blob/master/Platform/Intel/Readme.md)
> 
> -(I genuinely have no idea. Please help!)
> +(For other platforms, I genuinely have no idea. Please help!)
> 
> 
>  # Supported Platforms
> --
> 2.17.1.windows.2
> 
> 
> 

Re: [edk2-platforms] [PATCH] Platform/Intel: Update Readme.md to point to edk2-non-osi master branch

[Leif Lindholm]

On Thu, Aug 08, 2019 at 02:30:48PM -0700, Nate DeSimone wrote:
> Updated Platform/Intel/Readme.md to point to master branch on
> edk2-non-osi instead of devel-MinPlatform
> 
> Updated edk2-platforms/Readme.md to point to Platform/Intel/Readme.md
> for build instructions on Intel based Minimum Platforms
> 
> Added a link to the EDK II Minimum Platform Draft Specification
> to Platform/Intel/Readme.md
> 
> Cc: Andrew Fish <afish@apple.com>
> Cc: Laszlo Ersek <lersek@redhat.com>
> Cc: Leif Lindholm <leif.lindholm@linaro.org>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Michael Kubacki <michael.a.kubacki@intel.com>
> Cc: Ankit Sinha <ankit.sinha@intel.com>
> Cc: Chasel Chiu <chasel.chiu@intel.com>
> Signed-off-by: Nate DeSimone <nathaniel.l.desimone@intel.com>
> ---
>  Platform/Intel/Readme.md | 6 ++++--
>  Readme.md                | 8 +++++++-
>  2 files changed, 11 insertions(+), 3 deletions(-)
> 
> diff --git a/Platform/Intel/Readme.md b/Platform/Intel/Readme.md
> index 0a0e8a8c80..00f42985a2 100644
> --- a/Platform/Intel/Readme.md
> +++ b/Platform/Intel/Readme.md
> @@ -1,7 +1,9 @@
>  # **EDK II Minimum Platform Firmware for Intel(R) Platforms**
>  
>  The Minimum Platform is a software architecture that guides uniform delivery of Intel platforms enabling firmware
> -solutions for basic boot functionality with extensibility built-in.
> +solutions for basic boot functionality with extensibility built-in. Please see the
> +[EDK II Minimum Platform Draft Specification](https://edk2-docs.gitbooks.io/edk-ii-minimum-platform-specification/)
> +for more details.
>  
>  Package maintainers for the Minimum Platform projects are listed in Maintainers.txt.
>  
> @@ -98,7 +100,7 @@ return back to the minimum platform caller.
>    * ``git clone https://github.com/tianocore/edk2-platforms.git``
>  
>  * edk2-non-osi repository
> -  * ``git clone https://github.com/tianocore/edk2-non-osi.git -b devel-MinPlatform``
> +  * ``git clone https://github.com/tianocore/edk2-non-osi.git``

Really happy to see this change.

>  * FSP repository
>    * ``git clone https://github.com/IntelFsp/FSP.git``
> diff --git a/Readme.md b/Readme.md
> index 63e59f60b4..28badd6b4b 100644
> --- a/Readme.md
> +++ b/Readme.md
> @@ -34,6 +34,9 @@ edk2-devel mailing list with a subject prefix of `[platforms]`. See
>  on how to do this successfully.
>  
>  # How to build (Linux Environment)
> +Note: Build instructions for Intel based Minimum Platforms differ from these
> +instructions and are available at
> +[`edk2-platforms/Platform/Intel/README.md`](https://github.com/tianocore/edk2-platforms/blob/master/Platform/Intel/Readme.md)

Less happy to see this.

I am well aware that there are platform-specific steps required to
achieve the final firmware image for some systems. But we need to work
to address that. There have been discussions about implementing support
for hooking pre/post-build python scripts into the .dsc format - has
there been any progress on that?

For this patch, I would prefer if instead of adding these notes we
changed the
## [Intel](Platform/Intel/Readme.md)
### Minimum Platforms
* [Clevo](Platform/Intel/ClevoOpenBoardPkg)
* [Kaby Lake](Platform/Intel/KabylakeOpenBoardPkg)
* [Purley](Platform/Intel/PurleyOpenBoardPkg)
links to all point to (Platform/Intel) instead.

I realise that my intent with these platform links was unclear - for
all of the ARM platforms, these point to directories that have their
own Readme.md (meaning on github you see the documentation *and* the
files when you click the link).

Arguably, it would make sense to move all of the MinPlatform
... platforms ... and the Readme.md to a separate subdirectory and
link to that directory. Not everything under Platform/Intel is a
MinPlatform platform - soon there'll even be an ARM one.

Best Regards,

Leif

Re: [edk2-platforms] [PATCH] Platform/Intel: Update Readme.md to point to edk2-non-osi master branch

[Nate DeSimone]

Hi Leif,

> I am well aware that there are platform-specific steps required to achieve the final firmware image for some
> systems. But we need to work to address that. There have been discussions about implementing support for
> hooking pre/post-build python scripts into the .dsc format - has there been any progress on that?

I'm not sure. Liming would know more on that than I. For now, our MinPlatform... platforms are using the
build_bios.py script written by Prince as a substitute.

> For this patch, I would prefer if instead of adding these notes we changed the ## [Intel](Platform/Intel/Readme.md)
> ### Minimum Platforms

Done. Please see patch V2.

> Arguably, it would make sense to move all of the MinPlatform ... platforms ... and the Readme.md to a separate
> subdirectory and link to that directory. Not everything under Platform/Intel is a MinPlatform platform - soon
> there'll even be an ARM one.

I totally agree with you that would make more sense. Could you perhaps send an RFC and then we can start
the reorganization process?

Thanks,
Nate

Re: [edk2-platforms] [PATCH] Platform/Intel: Update Readme.md to point to edk2-non-osi master branch

[Kubacki, Michael A]

I also support moving the MinPlatform platforms to a dedicated directory.

Leif, please let me know if I can be of any help to prepare the RFC.

Thanks,
Michael

> -----Original Message-----
> From: Desimone, Nathaniel L
> Sent: Sunday, August 11, 2019 4:53 PM
> To: Leif Lindholm <leif.lindholm@linaro.org>
> Cc: devel@edk2.groups.io; Andrew Fish <afish@apple.com>; Laszlo Ersek
> <lersek@redhat.com>; Kinney, Michael D <michael.d.kinney@intel.com>;
> Kubacki, Michael A <michael.a.kubacki@intel.com>; Sinha, Ankit
> <ankit.sinha@intel.com>; Chiu, Chasel <chasel.chiu@intel.com>
> Subject: RE: [edk2-platforms] [PATCH] Platform/Intel: Update Readme.md to
> point to edk2-non-osi master branch
> 
> Hi Leif,
> 
> > I am well aware that there are platform-specific steps required to
> > achieve the final firmware image for some systems. But we need to work
> > to address that. There have been discussions about implementing support for
> hooking pre/post-build python scripts into the .dsc format - has there been any
> progress on that?
> 
> I'm not sure. Liming would know more on that than I. For now, our
> MinPlatform... platforms are using the build_bios.py script written by Prince as
> a substitute.
> 
> > For this patch, I would prefer if instead of adding these notes we
> > changed the ## [Intel](Platform/Intel/Readme.md) ### Minimum Platforms
> 
> Done. Please see patch V2.
> 
> > Arguably, it would make sense to move all of the MinPlatform ...
> > platforms ... and the Readme.md to a separate subdirectory and link to
> > that directory. Not everything under Platform/Intel is a MinPlatform platform
> - soon there'll even be an ARM one.
> 
> I totally agree with you that would make more sense. Could you perhaps send
> an RFC and then we can start the reorganization process?
> 
> Thanks,
> Nate