From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 978CBC04A68 for ; Wed, 27 Jul 2022 15:24:20 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 20FA383FFF; Wed, 27 Jul 2022 17:24:18 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=konsulko.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (1024-bit key; unprotected) header.d=konsulko.com header.i=@konsulko.com header.b="Z3FlH35Y"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 4E66C84007; Wed, 27 Jul 2022 17:24:16 +0200 (CEST) Received: from mail-qk1-x72d.google.com (mail-qk1-x72d.google.com [IPv6:2607:f8b0:4864:20::72d]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id 3078D83FA5 for ; Wed, 27 Jul 2022 17:24:13 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=konsulko.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=trini@konsulko.com Received: by mail-qk1-x72d.google.com with SMTP id c3so13516865qko.1 for ; Wed, 27 Jul 2022 08:24:13 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=konsulko.com; s=google; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to; bh=6oD5nPkzdxuzxsAsA4IBzsQ5u0yIj1RjtS+TYU2UJI0=; b=Z3FlH35Ygi62hk0uE+2K1LBL3CwNgaOBOXTwNXVePvjS8Zz7ti2Wf8ymxuAgFiP7RK 3rEGw7x+Oo9Zm4pYnNNRz14608pbJB4c3MOqj+VXBeVCPZWMe6LUjhSnMvqLn0cK0/dN 7IJxZ3W6P6OcF8d5S2cDaPNSPe5zfmPqwiVt0= 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=6oD5nPkzdxuzxsAsA4IBzsQ5u0yIj1RjtS+TYU2UJI0=; b=LE1YBX2dcJy/5wW3k2VJpGVGy9+MxPyhG6x1ai7EJPsEiDGRGJR2oPGeUh3Ys3mmAU 2Qc0CIm4FUrE8LR/s8UEC1xUkGewuIatCe9/KZPaXSF1Ek3g9+MoDrcIQHM32W6tC0DP ogGThhcfGtTAkEQFMZINRRTbsZJInqSUYNsAwLqj6aJKB0n8avd4Zdv4ZCa6TFmkLurp RsJfPbRx1zuPRLT/IGtIW6r45OmEp15PUpn1XRcjx4GPw/+KlqULF99vtmZrS92FeFei nbPh5TAgmSCWElA3Niwd/yyoBi1CwRv49mrzV2clEYFkCJGcyvof2d5f/J/yN5mOMz2x R8yQ== X-Gm-Message-State: AJIora99+9yKmmgORDtUSPVb/Tf6K7MR+eXaP3oH8zoJ+Zk0D24JyjfK BzajqUcC/G80aTNqdCTEQdgxGg== X-Google-Smtp-Source: AGRyM1uBWaoM7CtfAtYSMCcPQKob8iBKutsS01wUXtYyfdbwY0YpMHXHCGUpnOcYiPw/D+0FwqkD3A== X-Received: by 2002:a05:620a:1925:b0:6b5:d368:f2e0 with SMTP id bj37-20020a05620a192500b006b5d368f2e0mr17261841qkb.627.1658935451931; Wed, 27 Jul 2022 08:24:11 -0700 (PDT) Received: from bill-the-cat (cpe-65-184-195-139.ec.res.rr.com. [65.184.195.139]) by smtp.gmail.com with ESMTPSA id w24-20020a05620a095800b006a6d74f8fc9sm12624971qkw.127.2022.07.27.08.24.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 27 Jul 2022 08:24:10 -0700 (PDT) Date: Wed, 27 Jul 2022 11:24:09 -0400 From: Tom Rini To: Martin Bonner Cc: Heinrich Schuchardt , u-boot@lists.denx.de Subject: Re: [PATCH v4] Improve Windows build documentation Message-ID: <20220727152409.GY1146598@bill-the-cat> References: <18521899-b63c-6f91-971e-3efb6067fdb9@gmx.de> <809d36a7-12a8-669b-e9e5-07a398e0f746@gmx.de> <20220727141516.GX1146598@bill-the-cat> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha512; protocol="application/pgp-signature"; boundary="HBxSrJEh6aBgFqGg" Content-Disposition: inline In-Reply-To: X-Clacks-Overhead: GNU Terry Pratchett X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.6 at phobos.denx.de X-Virus-Status: Clean --HBxSrJEh6aBgFqGg Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Wed, Jul 27, 2022 at 04:15:52PM +0100, Martin Bonner wrote: > Martin >=20 >=20 > On Wed, 27 Jul 2022 at 15:15, Tom Rini wrote: >=20 > > On Wed, Jul 27, 2022 at 03:56:07PM +0200, Heinrich Schuchardt wrote: > > > On 7/27/22 15:51, Heinrich Schuchardt wrote: > > > > On 7/27/22 15:29, Heinrich Schuchardt wrote: > > > > > On 7/25/22 09:42, Martin Bonner wrote: > > > > > > * Add three more modules that are required. > > > > > > * Remove the version numbers (because they are hard to keep in = sync > > > > > > with the latest MSYS2 versions) > > > > > > * Add a pacman command line to install everything. > > > > > > > > > > > > Signed-off-by: Martin Bonner > > > > > > > > > > Your mail is not a valid patch: > > > > > > > > > > $ git am /tmp/0.patch > > > > > Applying: Improve Windows build documentation > > > > > error: corrupt patch at line 10 > > > > > Patch failed at 0001 Improve Windows build documentation > > > > > > > > > > Please, use 'git send-email' for sending patches. > > > > > > > > > > Best regards > > > > > > > > > > Heinrich > > > > > > > > > > > --- > > > > > > doc/build/tools.rst | 22 ++++++++++++++-------- > > > > > > 1 file changed, 14 insertions(+), 8 deletions(-) > > > > > > > > > > > > diff --git a/doc/build/tools.rst b/doc/build/tools.rst > > > > > > index c06f915274..5f8a04a31b 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 instal= ler > > > > > > tested is > > > > > > + * gcc > > > > > > + * make > > > > > > + * bison > > > > > > + * diffutils > > > > > > + * openssl-devel > > > > > > + * flex > > > > > > + * libgnutls-devel > > > > > > + * libuuid-devel > > > > > > > > This should not be pre-formatted text but simply a list. > > >=20 > I don't understand what you mean. That _is_ a (bulleted) list (or have I > misunderstood? - very possible) It's a matter, I think, of how you need to write the rST so that it renders nicely. Leading spaces lead to one way, no leading spaces (what Heinrich asks for) renders another way. This, I think, is spelled out in the Linux kernel docs about writing docs, which we now do link to. > > > > > > +You probably want ``git`` as well. You can install all these > > with:: > > > > > > > > Allow for syntax highlighting: > > > > > > > > .. code-block:: bash > > > There's no syntax to highlight! >=20 > > > > > > > > > > + > > > > > > + $ pacman -S gcc make bison diffutils openssl-devel flex > > > > > > libgnutls-devel libuuid-devel git > > > > > > > > The line should be limited to 80 characters. Use \. > > > The line length is about 94 characters. I don't think that is excessive. > I believe Tom has said u-boot has given up on a strict 80-character limit. >=20 > > > Please, remove the leading $. > > >=20 > I find it helpful to indicate the text is a command. These three comments at least I think go together. Have you done a "make htmldocs" and reviewed the output? In a code-block tagged as bash thing should look nice and then it's a general style guide to not start a command with '$' when there's no sample output to distinguish it from. And I could go back and forth on if I think that's right but we're consistent in our docs, and consistency matters more in this regard I believe. > > > > > > + > > > > > > +The MSYS2 installer tested is > > > > > > http://repo.msys2.org/distrib/x86_64/msys2-x86_64-20190524.ex= e. > > > > > > Do you really suggest to download a 3 year old version? > > > > It should be kept in-sync with what .azure-pipeline.yml does which is a > > newer version than that, yes. > > > I can't find a file of that name in the repo. Wouldn't it be better to > just do as Heinrich suggests, and drop the line entirely? That too, along with making sure we have appropriate overall wording to make sure it's clear MSYS2 is to be used, is a better still idea, yes. --=20 Tom --HBxSrJEh6aBgFqGg Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQGzBAABCgAdFiEEGjx/cOCPqxcHgJu/FHw5/5Y0tywFAmLhWJUACgkQFHw5/5Y0 tyzR/QwAq8qgWrVOj3gZs47t+LOUv1/jwWdNY+cmN3IsQYqsEdET1eKUM67/U7v+ 17MbrXgiPuR6LTZ/Iid7cgQWWie+w/oGyRZDM8AMAzODMks0gugeBlN0KA6drm6p oAUJPX40Phs6dg9S4asVaWjHsCKBG9MZNhlK0U2OJhW99sey6bamBmj4iHTnm6O/ RwwGfWHc5SyiUQTk4IFRjnXJBFXDQfikHjsNFxX13oKAgq69oGMixAc/UcazjmNt TNFm62/ebXGZAA4oGugcbkbLXM117QhE3+zE6SwH1mXvOZ8uLS4t8dOk3NYDSWrl fBCqEd55ZcbnTJHA/jXFr4/k01i/j4nSDUwHgm6R2XkB+tRcSAE9h7RjutqU+1vc APpjq8rECjNI1MZheB3ELoMX6UjpC6eBQT3rfY3D5AGWGZ1schWFrSIrc9WjJxAx YJid0ZPDUGsKUB+xtvF35PbjlwZzJeK3bAFaV6ZZpDo4ml0pIAESiZqEOQKZ8ANB 7Ykd7X8v =1Pdt -----END PGP SIGNATURE----- --HBxSrJEh6aBgFqGg--