docs/core-api: add memory allocation guide
From: | Mike Rapoport <rppt-AT-linux.vnet.ibm.com> | |
To: | Jonathan Corbet <corbet-AT-lwn.net> | |
Subject: | [PATCH v2 0/3] docs/core-api: add memory allocation guide | |
Date: | Thu, 16 Aug 2018 16:03:35 +0300 | |
Message-ID: | <1534424618-24713-1-git-send-email-rppt@linux.vnet.ibm.com> | |
Cc: | Michal Hocko <mhocko-AT-suse.com>, Randy Dunlap <rdunlap-AT-infradead.org>, Matthew Wilcox <willy-AT-infradead.org>, Vlastimil Babka <vbabka-AT-suse.cz>, linux-mm-AT-kvack.org, linux-doc-AT-vger.kernel.org, linux-kernel-AT-vger.kernel.org, Mike Rapoport <rppt-AT-linux.vnet.ibm.com> | |
Archive-link: | Article |
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. Note that the second patch depends on the mm docs update [2] that Andrew took to the -mm tree. [1] https://www.spinics.net/lists/netfilter-devel/msg55542.html [2] https://lkml.org/lkml/2018/7/26/684 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 | 124 +++++++++++++++++++++++++ Documentation/core-api/mm-api.rst | 2 + 4 files changed, 129 insertions(+) create mode 100644 Documentation/core-api/memory-allocation.rst -- 2.7.4