[v4,0/3] docs/core-api: add memory allocation guide

Message

Mike Rapoport Sept. 14, 2018, 9:27 a.m. UTC

Hi,

As Vlastimil mentioned at [1], it would be nice to have some guide about
memory allocation. This set adds such guide that summarizes the "best
practices". 

The changes from the RFC include additions and corrections from Michal and
Randy. I've also added markup to cross-reference the kernel-doc
documentation.

I've split the patch into three to separate labels addition to the exiting
files from the new contents.

v3 -> v4:
  * make GFP_*USER* description less confusing

v2 -> v3:
  * s/HW/hardware

[1] https://www.spinics.net/lists/netfilter-devel/msg55542.html

Mike Rapoport (3):
  docs: core-api/gfp_mask-from-fs-io: add a label for cross-referencing
  docs: core-api/mm-api: add a lable for GFP flags section
  docs: core-api: add memory allocation guide

 Documentation/core-api/gfp_mask-from-fs-io.rst |   2 +
 Documentation/core-api/index.rst               |   1 +
 Documentation/core-api/memory-allocation.rst   | 122 +++++++++++++++++++++++++
 Documentation/core-api/mm-api.rst              |   2 +
 4 files changed, 127 insertions(+)
 create mode 100644 Documentation/core-api/memory-allocation.rst

Comments

Mike Rapoport Sept. 20, 2018, 4:29 a.m. UTC | #1

Ping?

On Fri, Sep 14, 2018 at 12:27:55PM +0300, Mike Rapoport wrote:
> Hi,
> 
> As Vlastimil mentioned at [1], it would be nice to have some guide about
> memory allocation. This set adds such guide that summarizes the "best
> practices". 
> 
> The changes from the RFC include additions and corrections from Michal and
> Randy. I've also added markup to cross-reference the kernel-doc
> documentation.
> 
> I've split the patch into three to separate labels addition to the exiting
> files from the new contents.
> 
> v3 -> v4:
>   * make GFP_*USER* description less confusing
> 
> v2 -> v3:
>   * s/HW/hardware
> 
> [1] https://www.spinics.net/lists/netfilter-devel/msg55542.html
> 
> Mike Rapoport (3):
>   docs: core-api/gfp_mask-from-fs-io: add a label for cross-referencing
>   docs: core-api/mm-api: add a lable for GFP flags section
>   docs: core-api: add memory allocation guide
> 
>  Documentation/core-api/gfp_mask-from-fs-io.rst |   2 +
>  Documentation/core-api/index.rst               |   1 +
>  Documentation/core-api/memory-allocation.rst   | 122 +++++++++++++++++++++++++
>  Documentation/core-api/mm-api.rst              |   2 +
>  4 files changed, 127 insertions(+)
>  create mode 100644 Documentation/core-api/memory-allocation.rst
> 
> -- 
> 2.7.4
>

Jonathan Corbet Sept. 20, 2018, 5:04 p.m. UTC | #2

On Thu, 20 Sep 2018 07:29:30 +0300
Mike Rapoport <[e-mail]> wrote:

> Ping?
> 
> On Fri, Sep 14, 2018 at 12:27:55PM +0300, Mike Rapoport wrote:
> > Hi,
> > 
> > As Vlastimil mentioned at [1], it would be nice to have some guide about
> > memory allocation. This set adds such guide that summarizes the "best
> > practices". 
> > 
> > The changes from the RFC include additions and corrections from Michal and
> > Randy. I've also added markup to cross-reference the kernel-doc
> > documentation.
> > 
> > I've split the patch into three to separate labels addition to the exiting
> > files from the new contents.
> > 
> > v3 -> v4:
> >   * make GFP_*USER* description less confusing

Sorry...but it's been less than a week.  And this week has been ...
busy ...

Anyway, I've applied the set now, thanks.

jon