diff mbox series

Improve Window's build documentation

Message ID CACHZXAQDF2hHEBnJmX-dvFnLxidhFqnFLpb-mWjvxHt2SUNE_Q@mail.gmail.com
State Superseded
Delegated to: Heinrich Schuchardt
Headers show
Series Improve Window's build documentation | expand

Commit Message

Martin Bonner July 20, 2022, 6:50 a.m. UTC
I have recently build the u-boot tools on Windows and ran into
difficulties.  This patch to the documentation would have avoided
those difficulties.  Contentious points:

* While I have run the document through a rst previewer, I haven't run
the full test suite.  I know, I know, everyone thinks _they_ don't
need to run the tests because reasons, but I think it's true this
time.
* I have removed the version numbers from the list of packages.  I
don't think they are helpful, and are just maintenance overhead.  (I
don't think I got those versions for example).

I'd be grateful if @Bin Meng could review this, because `git blame`
says the file I am changing is all his.

Are there any other formalities I need to complete before this can be
accepted into u-boot?

-----------------------------------------------------------------------

 There are 3 MSYS subsystems installed: MSYS2, MinGW32 and MinGW64. Each


Martin Bonner

Comments

Bin Meng July 20, 2022, 12:33 p.m. UTC | #1
On Wed, Jul 20, 2022 at 2:50 PM Martin Bonner <martingreybeard@gmail.com> wrote:
>
> I have recently build the u-boot tools on Windows and ran into
> difficulties.  This patch to the documentation would have avoided
> those difficulties.  Contentious points:
>
> * While I have run the document through a rst previewer, I haven't run
> the full test suite.  I know, I know, everyone thinks _they_ don't
> need to run the tests because reasons, but I think it's true this
> time.
> * I have removed the version numbers from the list of packages.  I
> don't think they are helpful, and are just maintenance overhead.  (I
> don't think I got those versions for example).
>
> I'd be grateful if @Bin Meng could review this, because `git blame`
> says the file I am changing is all his.
>
> Are there any other formalities I need to complete before this can be
> accepted into u-boot?

Thanks for the patch!

Please refer to the Linux kernel documentation on how to document your
changes in the commit message:
https://www.kernel.org/doc/html/latest/process/submitting-patches.html

>
> -----------------------------------------------------------------------
> diff --git a/doc/build/tools.rst b/doc/build/tools.rst
> index c06f915274..95f1246617 100644
> --- a/doc/build/tools.rst
> +++ b/doc/build/tools.rst
> @@ -24,14 +24,20 @@ you can use MSYS2, a software distro and building
> platform for Windows.
>  Download the MSYS2 installer from https://www.msys2.org. Make sure you have
>  installed all required packages below in order to build these host tools::
>
> -   * gcc (9.1.0)
> -   * make (4.2.1)
> -   * bison (3.4.2)
> -   * diffutils (3.7)
> -   * openssl-devel (1.1.1.d)
> -
> -Note the version numbers in these parentheses above are the package versions
> -at the time being when writing this document. The MSYS2 installer tested is
> +   * gcc
> +   * make
> +   * bison
> +   * diffutils
> +   * openssl-devel
> +   * flex
> +   * libgnutls-devel
> +   * libuuid-devel
> +
> +You probably want ``git`` as well.  You can install all these with::
> +
> +    $ pacman -S gcc make bison diffutils openssl=devel flex

s/=/-

> libgnutls-devel libuuid-devel git
> +
> +The MSYS2 installer tested is
>  http://repo.msys2.org/distrib/x86_64/msys2-x86_64-20190524.exe.
>
>  There are 3 MSYS subsystems installed: MSYS2, MinGW32 and MinGW64. Each
>

Regards,
Bin
diff mbox series

Patch

diff --git a/doc/build/tools.rst b/doc/build/tools.rst
index c06f915274..95f1246617 100644
--- a/doc/build/tools.rst
+++ b/doc/build/tools.rst
@@ -24,14 +24,20 @@  you can use MSYS2, a software distro and building
platform for Windows.
 Download the MSYS2 installer from https://www.msys2.org. Make sure you have
 installed all required packages below in order to build these host tools::

-   * gcc (9.1.0)
-   * make (4.2.1)
-   * bison (3.4.2)
-   * diffutils (3.7)
-   * openssl-devel (1.1.1.d)
-
-Note the version numbers in these parentheses above are the package versions
-at the time being when writing this document. The MSYS2 installer tested is
+   * gcc
+   * make
+   * bison
+   * diffutils
+   * openssl-devel
+   * flex
+   * libgnutls-devel
+   * libuuid-devel
+
+You probably want ``git`` as well.  You can install all these with::
+
+    $ pacman -S gcc make bison diffutils openssl=devel flex
libgnutls-devel libuuid-devel git
+
+The MSYS2 installer tested is
 http://repo.msys2.org/distrib/x86_64/msys2-x86_64-20190524.exe.