[PATCH] Link the memory allocation guide from the MM docs

[PATCH] Link the memory allocation guide from the MM docs

[Matthew Wilcox]

I just went looking for the memory allocation guide in the MM docs instead
of in the core API.  For the benefit of the next person who makes that
mistake, link to it from the MM docs.

Signed-off-by: Matthew Wilcox <willy@infradead.org>

diff --git a/Documentation/core-api/memory-allocation.rst b/Documentation/core-api/memory-allocation.rst
index f8bb9aa120c4..8954a88ff5b7 100644
--- a/Documentation/core-api/memory-allocation.rst
+++ b/Documentation/core-api/memory-allocation.rst
@@ -1,3 +1,5 @@
+.. _memory-allocation:
+
 =======================
 Memory Allocation Guide
 =======================
diff --git a/Documentation/vm/index.rst b/Documentation/vm/index.rst
index c4ded22197ca..2b3ab3a1ccf3 100644
--- a/Documentation/vm/index.rst
+++ b/Documentation/vm/index.rst
@@ -2,7 +2,9 @@
 Linux Memory Management Documentation
 =====================================
 
-This is a collection of documents about Linux memory management (mm) subsystem.
+This is a collection of documents about the Linux memory management (mm)
+subsystem.  If you are looking for advice on simply allocating memory,
+see the :ref:`memory-allocation`.
 
 User guides for MM features
 ===========================

Re: [PATCH] Link the memory allocation guide from the MM docs

[Mike Rapoport]

On Mon, Nov 19, 2018 at 08:00:49AM -0800, Matthew Wilcox wrote:
> I just went looking for the memory allocation guide in the MM docs instead
> of in the core API.  For the benefit of the next person who makes that
> mistake, link to it from the MM docs.
> 
> Signed-off-by: Matthew Wilcox <willy@infradead.org>

Acked-by: Mike Rapoport <rppt@linux.ibm.com>

> 
> diff --git a/Documentation/core-api/memory-allocation.rst b/Documentation/core-api/memory-allocation.rst
> index f8bb9aa120c4..8954a88ff5b7 100644
> --- a/Documentation/core-api/memory-allocation.rst
> +++ b/Documentation/core-api/memory-allocation.rst
> @@ -1,3 +1,5 @@
> +.. _memory-allocation:
> +
>  =======================
>  Memory Allocation Guide
>  =======================
> diff --git a/Documentation/vm/index.rst b/Documentation/vm/index.rst
> index c4ded22197ca..2b3ab3a1ccf3 100644
> --- a/Documentation/vm/index.rst
> +++ b/Documentation/vm/index.rst
> @@ -2,7 +2,9 @@
>  Linux Memory Management Documentation
>  =====================================
>  
> -This is a collection of documents about Linux memory management (mm) subsystem.
> +This is a collection of documents about the Linux memory management (mm)
> +subsystem.  If you are looking for advice on simply allocating memory,
> +see the :ref:`memory-allocation`.
>  
>  User guides for MM features
>  ===========================
> 

-- 
Sincerely yours,
Mike.

Re: [PATCH] Link the memory allocation guide from the MM docs

[Jonathan Corbet]

On Mon, 19 Nov 2018 08:00:49 -0800
Matthew Wilcox <willy@infradead.org> wrote:

> I just went looking for the memory allocation guide in the MM docs instead
> of in the core API.  For the benefit of the next person who makes that
> mistake, link to it from the MM docs.
> 
> Signed-off-by: Matthew Wilcox <willy@infradead.org>

Applied, thanks.

jon