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 9135AC433EF for ; Sat, 9 Jul 2022 12:36:44 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 7C6CE8407A; Sat, 9 Jul 2022 14:36:42 +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="l53A+8Fg"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id E5E6E83C28; Sat, 9 Jul 2022 14:36:40 +0200 (CEST) Received: from mail-qk1-x72e.google.com (mail-qk1-x72e.google.com [IPv6:2607:f8b0:4864:20::72e]) (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 4848C83C28 for ; Sat, 9 Jul 2022 14:36:38 +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-x72e.google.com with SMTP id g1so783827qkl.9 for ; Sat, 09 Jul 2022 05:36:38 -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=iquUTmBzhiwNbmUkdecK4uEiaeFneE3RQUmNETcoH/c=; b=l53A+8FgQec3DNt63OprQlrYfPuYlxhZE8o0VemZO7eyUGqrDVGs3nKZvwyUQMN6hP YDQW8VdvBemMx7KDo55+bFDptJ4G5qpzGCniRUV8fkF36crNw+eeyZt3fNUuiWWY9OR6 FLhyZGov+W1ATZVPoWq+xfuKtmlwAbg7QCzoE= 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=iquUTmBzhiwNbmUkdecK4uEiaeFneE3RQUmNETcoH/c=; b=rudSmg3n6iZGTSYsDg0Ypjz1BukWSdfb7d+uFqsecwuTS+Gw6IDKgLTrdtSxVUiwm5 7CeEV8frocXvHJXmSDP4iM6Aagg/r7W/PuOLwcIT0smxGP0WxSm6RaBRV8s7ELWFsxer 8jGgx9oVX2fWV6ONjcLaYT5o0wD0OtL6lvTF2JlNHOwKxevlqXExqZCRfTtPXwIeaIMe laOrRJ0JSCltG7vAdaczK0zDuIfvGenprrP+G/n4lb/w4qXmHGNHVTM+d5gFLxuonMRH k11wiHA5tnCn58H/mO3sBp751KHfTWPA3Ex2Ohi/41o/J36GsSWnP9jNxCIgdx6U0AdD +P/g== X-Gm-Message-State: AJIora/ZbMSOkVpe23oVaU3QRE9baBtHEj1O1GCSxH1k9g9Z3ILhw95C uXNviZti7GPKiGei/KYHrQFOVA== X-Google-Smtp-Source: AGRyM1uR6Np/9nEsZqgrVDLJ1czNi+o5222ZuTsKxLHZ5cQec1UqQuwWqu0rnmHaQ0tEX2kLLYMAmw== X-Received: by 2002:a05:620a:4542:b0:6b3:7c51:6177 with SMTP id u2-20020a05620a454200b006b37c516177mr5576362qkp.306.1657370196824; Sat, 09 Jul 2022 05:36:36 -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 r18-20020ac85c92000000b0031eaabd2117sm1410699qta.12.2022.07.09.05.36.35 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 09 Jul 2022 05:36:36 -0700 (PDT) Date: Sat, 9 Jul 2022 08:36:34 -0400 From: Tom Rini To: Heinrich Schuchardt Cc: Simon Glass , u-boot@lists.denx.de Subject: Re: [PATCH 1/4] doc: Migrate CodingStyle wiki page to sphinx Message-ID: <20220709123634.GE1146598@bill-the-cat> References: <20220627171722.1153337-1-trini@konsulko.com> <20220627171722.1153337-2-trini@konsulko.com> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha512; protocol="application/pgp-signature"; boundary="n2pbiVy0uByhFF2B" 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 --n2pbiVy0uByhFF2B Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Sat, Jul 09, 2022 at 08:12:27AM +0200, Heinrich Schuchardt wrote: > On 6/27/22 19:17, Tom Rini wrote: > > Move the current CodingStyle wiki page to doc/develop/codingstyle.rst. > > The changes here are for formatting or slight rewording so that it reads > > well when linking to other sphinx documents. [snip] > > +U-Boot adopted the kernel-doc annotation style, this is the only excep= tion from > > +multi-line comment rule of Coding Style. While not mandatory, adding > > +documentation is strongly advised. The Linux kernel `kernel-doc `_ documentatio= n applies with no changes. >=20 > Developers tend to read the rst files with text editors. Please, keep > lines short (80 characters). `kernel-doc can go onto the next line. Linux doesn't have a hard 80 character limit anymore and neither do we, keep in mind. > > +applies with no changes. > > + > > +Use structures for I/O access > > +----------------------------- > > + > > +U-Boot typically uses a C structure to map out the registers in an I/O= region, rather than offsets. The reasons for this are: > > + > > +* It dissociates the register location (offset) from the register type= , which > > + means the developer has to make sure the type is right for each acce= ss, > > + whereas with the struct method, this is checked by the compiler; >=20 > Please, add blank lines between bullets. Different than markdown, OK. [snip] > > +Tests > > +----- > > + > > + > > +Please add tests when you add code. Please change or expand tests when= you change code. > > + > > +Run the tests with:: > > + >=20 > %s/::/:/ >=20 > .. code-block:: bash >=20 > > + make check > > + make qcheck (skips some tests) > > + > > +Python tests are in test/py/tests - see the docs in test/py for info. >=20 > Please, add a reference to doc/develop/tests_writing.rst >=20 > > + > > +Try to write your tests in C if you can. For example, tests to check a= command > > +will be much faster (10-100x or more) if they can directly call run_co= mmand() >=20 > %s/10-100x/10 - 100x/ > Please, avoid duplicating information from tests_writing.rst. >=20 > > +and ut_check_console_line() instead of using Python to send commands o= ver a > > +pipe to U-Boot. > > + > > +Tests run all supported CI systems (gitlab, travis, azure) using scrip= ts in the >=20 > %s/gitlab/Gitlab/ > %s/azure/Azure/ >=20 > We don't use Travis CI anymore. This is more substantive than wiki->rST so I'll handle this in another patch. --=20 Tom --n2pbiVy0uByhFF2B Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQGzBAABCgAdFiEEGjx/cOCPqxcHgJu/FHw5/5Y0tywFAmLJdlIACgkQFHw5/5Y0 tywzAAwAsHX3HVkc2ao79i2Lc+SsLz7X70ERpUVQtx5MUnuRYShOQH1MRRphd1Ya tMuQWLwqK4mqLTBMuqxmUPA2DQNVy37Uf+t4B54255MObznz+/C7JTtJ5pisWAnL wQPcJ9OQL/pyhU9tH1m2ZvwyKMbS+3D71uMoB+dNlYHwz+vbXwW1xcg5I83boqyj lqbzjw5FEJkQBw8eSj8W1a8PmWj1V9SJCaWWTLithwKAv3HhgLkBYGopJ8RhrTK4 BD72vTgdjWyuKqCfjKEENolNkGclTBXct9WiKro1ar2P+IE3iIwDZ4b7LqwimUlj o5MW2xQMTXl2wxzaP4Z6TEteKomF9IoNuW/HPnh3w+ITVWB82Z99ZMulqc7epL25 4PjJ41j0SoQtnAuMWmpu5G5SdTiDc0a6uUSVpzOp7OrfOlK1wHzc1momFAFvJRPh YN0rJ+MY6RyWQg26g2HgfhTRKu8pw5pFWesiA4U3LSPz8eseq5h4wu6GipqO1CsB 0kFjVsPt =I1bG -----END PGP SIGNATURE----- --n2pbiVy0uByhFF2B--