From: "Aneesh Kumar K.V" <aneesh.kumar@linux.ibm.com>
To: Stephen Rothwell <sfr@canb.auug.org.au>,
Michael Ellerman <mpe@ellerman.id.au>,
PowerPC <linuxppc-dev@lists.ozlabs.org>
Cc: Linux Next Mailing List <linux-next@vger.kernel.org>,
Daniel Henrique Barboza <danielhb413@gmail.com>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>
Subject: Re: linux-next: build warning after merge of the powerpc tree
Date: Tue, 24 Aug 2021 10:48:47 +0530 [thread overview]
Message-ID: <87v93ve7yg.fsf@linux.ibm.com> (raw)
In-Reply-To: <20210823204803.7cb76778@canb.auug.org.au>
Stephen Rothwell <sfr@canb.auug.org.au> writes:
> Hi all,
>
> [cc'ing Jon in case he can fix the sphix hang - or knows anything about it]
>
> On Mon, 23 Aug 2021 19:55:40 +1000 Stephen Rothwell <sfr@canb.auug.org.au> wrote:
>>
>> After merging the powerpc tree, today's linux-next build (htmldocs)
>> produced this warning:
>>
>
> I missed a line:
>
> Sphinx parallel build error:
>
>> docutils.utils.SystemMessage: Documentation/powerpc/associativity.rst:1: (SEVERE/4) Title overline & underline mismatch.
>>
>> ============================
>> NUMA resource associativity
>> =============================
>>
>> Introduced by commit
>>
>> 1c6b5a7e7405 ("powerpc/pseries: Add support for FORM2 associativity")
>>
>> There are other obvious problems with this document (but sphinx seems
>> to have hung before it reported them).
>>
>> Like
>>
>> Form 0
>> -----
>>
>> and
>>
>> Form 1
>> -----
>>
>> and
>>
>> Form 2
>> -------
>
> I also get the following warning:
>
> Documentation/powerpc/associativity.rst: WARNING: document isn't included in any toctree
>
> And applying the following patch is enough to allow sphinx to finish
> (rather than livelocking):
>
> diff --git a/Documentation/powerpc/associativity.rst b/Documentation/powerpc/associativity.rst
> index 07e7dd3d6c87..b77c6ccbd6cb 100644
> --- a/Documentation/powerpc/associativity.rst
> +++ b/Documentation/powerpc/associativity.rst
> @@ -1,6 +1,6 @@
> -============================
> +===========================
> NUMA resource associativity
> -=============================
> +===========================
>
> Associativity represents the groupings of the various platform resources into
> domains of substantially similar mean performance relative to resources outside
> @@ -20,11 +20,11 @@ A value of 1 indicates the usage of Form 1 associativity. For Form 2 associativi
> bit 2 of byte 5 in the "ibm,architecture-vec-5" property is used.
>
> Form 0
> ------
> +------
> Form 0 associativity supports only two NUMA distances (LOCAL and REMOTE).
>
> Form 1
> ------
> +------
> With Form 1 a combination of ibm,associativity-reference-points, and ibm,associativity
> device tree properties are used to determine the NUMA distance between resource groups/domains.
>
> @@ -45,7 +45,7 @@ level of the resource group, the kernel doubles the NUMA distance between the
> comparing domains.
>
> Form 2
> --------
> +------
> Form 2 associativity format adds separate device tree properties representing NUMA node distance
> thereby making the node distance computation flexible. Form 2 also allows flexible primary
> domain numbering. With numa distance computation now detached from the index value in
Thanks for looking into this. I guess we also need to format the below table?
| 0 8 40
--|------------
|
0 | 10 20 80
|
8 | 20 10 160
|
40| 80 160 10
I don't know how to represent that in the documentation file. A table is
probably not the right one?
-aneesh
next prev parent reply other threads:[~2021-08-24 5:19 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-23 9:55 linux-next: build warning after merge of the powerpc tree Stephen Rothwell
2021-08-23 10:48 ` Stephen Rothwell
2021-08-23 14:19 ` Jonathan Corbet
2021-08-23 23:21 ` Stephen Rothwell
2021-08-24 5:18 ` Aneesh Kumar K.V [this message]
2021-08-24 13:46 ` Jonathan Corbet
-- strict thread matches above, loose matches on Subject: below --
2023-02-16 3:40 Stephen Rothwell
2023-02-16 18:06 ` Josh Poimboeuf
2023-02-17 1:35 ` Michael Ellerman
2023-02-17 7:05 ` Josh Poimboeuf
2021-04-15 8:52 Stephen Rothwell
2021-04-16 10:54 ` Michael Ellerman
2021-04-14 23:36 Stephen Rothwell
2019-11-13 22:34 Stephen Rothwell
2017-09-04 8:53 Stephen Rothwell
2017-09-04 8:59 ` Cédric Le Goater
2015-10-20 5:21 Stephen Rothwell
2015-10-20 10:06 ` Michael Ellerman
2015-10-20 20:45 ` Stephen Rothwell
2011-05-19 3:19 Stephen Rothwell
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87v93ve7yg.fsf@linux.ibm.com \
--to=aneesh.kumar@linux.ibm.com \
--cc=corbet@lwn.net \
--cc=danielhb413@gmail.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-next@vger.kernel.org \
--cc=linuxppc-dev@lists.ozlabs.org \
--cc=mpe@ellerman.id.au \
--cc=sfr@canb.auug.org.au \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).