| Message ID | 20190522205034.25724-4-corbet@lwn.net |
|---|---|
| State | New |
| Headers | show |
| Series | docs: Fixes for recent versions of Sphinx | expand |
On Wed, May 22, 2019 at 02:50:29PM -0600, Jonathan Corbet wrote: > Commit 13bac55ef7ae ("doc/mm: New documentation for memory performance") > added numaperf.rst, but did not add it to the TOC tree. There was also an > incorrectly marked literal block leading to this warning sequence: > > numaperf.rst:24: WARNING: Unexpected indentation. > numaperf.rst:24: WARNING: Inline substitution_reference start-string without end-string. > numaperf.rst:25: WARNING: Block quote ends without a blank line; unexpected unindent. > > Fix the block and add the file to the document tree. > > Fixes: 13bac55ef7ae ("doc/mm: New documentation for memory performance") > Cc: Keith Busch <keith.busch@intel.com> > Cc: Mike Rapoport <rppt@linux.ibm.com> > Signed-off-by: Jonathan Corbet <corbet@lwn.net> Reviewed-by: Mike Rapoport <rppt@linux.ibm.com> > --- > Documentation/admin-guide/mm/index.rst | 1 + > Documentation/admin-guide/mm/numaperf.rst | 2 +- > 2 files changed, 2 insertions(+), 1 deletion(-) > > diff --git a/Documentation/admin-guide/mm/index.rst b/Documentation/admin-guide/mm/index.rst > index 8edb35f11317..ddf8d8d33377 100644 > --- a/Documentation/admin-guide/mm/index.rst > +++ b/Documentation/admin-guide/mm/index.rst > @@ -31,6 +31,7 @@ the Linux memory management. > ksm > memory-hotplug > numa_memory_policy > + numaperf > pagemap > soft-dirty > transhuge > diff --git a/Documentation/admin-guide/mm/numaperf.rst b/Documentation/admin-guide/mm/numaperf.rst > index b79f70c04397..c067ed145158 100644 > --- a/Documentation/admin-guide/mm/numaperf.rst > +++ b/Documentation/admin-guide/mm/numaperf.rst > @@ -15,7 +15,7 @@ characteristics. Some memory may share the same node as a CPU, and others > are provided as memory only nodes. While memory only nodes do not provide > CPUs, they may still be local to one or more compute nodes relative to > other nodes. The following diagram shows one such example of two compute > -nodes with local memory and a memory only node for each of compute node: > +nodes with local memory and a memory only node for each of compute node:: > > +------------------+ +------------------+ > | Compute Node 0 +-----+ Compute Node 1 | > -- > 2.21.0 > -- Sincerely yours, Mike.
diff --git a/Documentation/admin-guide/mm/index.rst b/Documentation/admin-guide/mm/index.rst index 8edb35f11317..ddf8d8d33377 100644 --- a/Documentation/admin-guide/mm/index.rst +++ b/Documentation/admin-guide/mm/index.rst @@ -31,6 +31,7 @@ the Linux memory management. ksm memory-hotplug numa_memory_policy + numaperf pagemap soft-dirty transhuge diff --git a/Documentation/admin-guide/mm/numaperf.rst b/Documentation/admin-guide/mm/numaperf.rst index b79f70c04397..c067ed145158 100644 --- a/Documentation/admin-guide/mm/numaperf.rst +++ b/Documentation/admin-guide/mm/numaperf.rst @@ -15,7 +15,7 @@ characteristics. Some memory may share the same node as a CPU, and others are provided as memory only nodes. While memory only nodes do not provide CPUs, they may still be local to one or more compute nodes relative to other nodes. The following diagram shows one such example of two compute -nodes with local memory and a memory only node for each of compute node: +nodes with local memory and a memory only node for each of compute node:: +------------------+ +------------------+ | Compute Node 0 +-----+ Compute Node 1 |
Commit 13bac55ef7ae ("doc/mm: New documentation for memory performance") added numaperf.rst, but did not add it to the TOC tree. There was also an incorrectly marked literal block leading to this warning sequence: numaperf.rst:24: WARNING: Unexpected indentation. numaperf.rst:24: WARNING: Inline substitution_reference start-string without end-string. numaperf.rst:25: WARNING: Block quote ends without a blank line; unexpected unindent. Fix the block and add the file to the document tree. Fixes: 13bac55ef7ae ("doc/mm: New documentation for memory performance") Cc: Keith Busch <keith.busch@intel.com> Cc: Mike Rapoport <rppt@linux.ibm.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> --- Documentation/admin-guide/mm/index.rst | 1 + Documentation/admin-guide/mm/numaperf.rst | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) -- 2.21.0