From patchwork Wed Nov 28 14:45:44 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Rapoport X-Patchwork-Id: 10702797 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 9C35613BB for ; Wed, 28 Nov 2018 14:45:58 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 8B9B32D526 for ; Wed, 28 Nov 2018 14:45:58 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 7E4392D59C; Wed, 28 Nov 2018 14:45:58 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-2.9 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_NONE autolearn=ham version=3.3.1 Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 0D5C12D581 for ; Wed, 28 Nov 2018 14:45:57 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 0CA826B4D70; Wed, 28 Nov 2018 09:45:57 -0500 (EST) Delivered-To: linux-mm-outgoing@kvack.org Received: by kanga.kvack.org (Postfix, from userid 40) id 07AFD6B4D82; Wed, 28 Nov 2018 09:45:57 -0500 (EST) X-Original-To: int-list-linux-mm@kvack.org X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id E5FDD6B4D83; Wed, 28 Nov 2018 09:45:56 -0500 (EST) X-Original-To: linux-mm@kvack.org X-Delivered-To: linux-mm@kvack.org Received: from mail-ed1-f71.google.com (mail-ed1-f71.google.com [209.85.208.71]) by kanga.kvack.org (Postfix) with ESMTP id 8C5456B4D70 for ; Wed, 28 Nov 2018 09:45:56 -0500 (EST) Received: by mail-ed1-f71.google.com with SMTP id t2so12480646edb.22 for ; Wed, 28 Nov 2018 06:45:56 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-original-authentication-results:x-gm-message-state:from:to:cc :subject:date:message-id; bh=PO2WboKrROA6EUFRrf9HfTREtA2SavmTBF5m2Mz40Hk=; b=Ov4Bob6UfUujyvPKmIcDE/MHUB6fAy16sPa8Fxws2rfYkR9RKidoT6Te5qLQwAqAVW ONLl8VSIBcu1Li0eX3SV/aHZbY2Z6ABmcG8ijbgQRTI6zsOxdM1n5PNpAfGSG8uNUB5I xDwoEJN5hMgjpYm+f4rqMkQGWzAdTyVPjKdSLopmMGHHVe8/1S0TYVba1YZ1qpllVzrL eYVCeu6y6J/gWV7RVRCL5d019/stlNKdiulSCHO1eS04GCHiiqUdb2CXuioON7Os9d5I IwQRitERoT288phWvSSNsYL4ADZWTdediehw+hFRq9wDxKtCZwi9zm0KKhLkTjWg4Uih +xOw== X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of rppt@linux.ibm.com designates 148.163.158.5 as permitted sender) smtp.mailfrom=rppt@linux.ibm.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=ibm.com X-Gm-Message-State: AGRZ1gKHdwftw4/xf5ZqHZPVKOzMwKqjE4GOObOcXz0BRAlBWemcBZNL phKQGLh7acm1FIcfUaMRyiZ3wYedM/Q7pGWJAAfNdT5t26NE08Or9aC233CjhyYJgdTHH0cIAIZ uFlab/nCvZe0ziMsA99cWdiyeFuA+1D4qUDOSTfwPWCY1cN3pcCtrKmd2nnJoS/QEBg== X-Received: by 2002:a17:906:d289:: with SMTP id ay9-v6mr26604451ejb.155.1543416356064; Wed, 28 Nov 2018 06:45:56 -0800 (PST) X-Google-Smtp-Source: AJdET5dUvFTaeIW5GN+5tRF1qArU0Wgd0bveyPI1Lb2HFdpoo7fd/lwQ6FF2bU9SjY9QDawbz7GE X-Received: by 2002:a17:906:d289:: with SMTP id ay9-v6mr26604383ejb.155.1543416354566; Wed, 28 Nov 2018 06:45:54 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1543416354; cv=none; d=google.com; s=arc-20160816; b=DW1qO9dCSb92h7+rQYe4Ysbf3XUv4cVE6GcyhRA2HKYGQ0+vV+QjS+aOyWODqsYuNQ aQcXHOGsG1rhSlU77mP8K1JpuXWbiV/AMj4dc9zplwRYF/Gu65LmLNjDetLkEmKzB6uo qSui/W2TkB6zbOZb8gQZt4LXuVeCHKWue/NsRscPoTvBGGoU4XX/kab8jG4rSF6LnSDX CMEfx0ZVjxkdu1LqwDSk5leMFOfB0+sePKpiXQOtEMVjfg4HWyqstw0bGEE6hf6wyRA8 LK04OETnfF4An6h7Zqy8M4pOCd5TcpZOoOOorMJPm7x58reWgLWoSLuxKWiPEDopBxdf tn3g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=message-id:date:subject:cc:to:from; bh=PO2WboKrROA6EUFRrf9HfTREtA2SavmTBF5m2Mz40Hk=; b=THDToxFsSZgQzZu15E7JTPbhwlgvu/o8WfZ1aPJ8sin/mkHhhDQq0kp0CVz89+kxzQ S/w5wbqAUjhLX/MVc21GZa/Fsx/9W4WHdPt9Qg0YbH8N4sB6DaVUPul4mUfy3HonS4Rb N0SJ/0W3FNLcEAY5C7zUH3DSUNO4fl24zgAQfRZMdM5K84HGZGMYlqbqzbQ8RK6zGxWe EpVkl9egtI2oa61Pu5GSdYDIe5lwmVJoQl7uZGC7YeVb1rLZi5FwgDvsf8Ggg5YCh21z /Sct0bJrToTAmtk5J0Aep+VCUmLXJMIGmGRGSUpEYrNVE9H2NJW5LudWKC1gBc14J8Td HBqg== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of rppt@linux.ibm.com designates 148.163.158.5 as permitted sender) smtp.mailfrom=rppt@linux.ibm.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=ibm.com Received: from mx0a-001b2d01.pphosted.com (mx0b-001b2d01.pphosted.com. [148.163.158.5]) by mx.google.com with ESMTPS id bp5-v6si2577727ejb.40.2018.11.28.06.45.53 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 28 Nov 2018 06:45:54 -0800 (PST) Received-SPF: pass (google.com: domain of rppt@linux.ibm.com designates 148.163.158.5 as permitted sender) client-ip=148.163.158.5; Authentication-Results: mx.google.com; spf=pass (google.com: domain of rppt@linux.ibm.com designates 148.163.158.5 as permitted sender) smtp.mailfrom=rppt@linux.ibm.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=ibm.com Received: from pps.filterd (m0098421.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id wASEcmJw084749 for ; Wed, 28 Nov 2018 09:45:53 -0500 Received: from e06smtp01.uk.ibm.com (e06smtp01.uk.ibm.com [195.75.94.97]) by mx0a-001b2d01.pphosted.com with ESMTP id 2p1ucr5apy-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Wed, 28 Nov 2018 09:45:52 -0500 Received: from localhost by e06smtp01.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Wed, 28 Nov 2018 14:45:50 -0000 Received: from b06cxnps4074.portsmouth.uk.ibm.com (9.149.109.196) by e06smtp01.uk.ibm.com (192.168.101.131) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; (version=TLSv1/SSLv3 cipher=AES256-GCM-SHA384 bits=256/256) Wed, 28 Nov 2018 14:45:48 -0000 Received: from b06wcsmtp001.portsmouth.uk.ibm.com (b06wcsmtp001.portsmouth.uk.ibm.com [9.149.105.160]) by b06cxnps4074.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id wASEjlER8323376 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL); Wed, 28 Nov 2018 14:45:48 GMT Received: from b06wcsmtp001.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id D98D9A4069; Wed, 28 Nov 2018 14:45:47 +0000 (GMT) Received: from b06wcsmtp001.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 8497EA405F; Wed, 28 Nov 2018 14:45:46 +0000 (GMT) Received: from rapoport-lnx (unknown [9.148.8.124]) by b06wcsmtp001.portsmouth.uk.ibm.com (Postfix) with ESMTPS; Wed, 28 Nov 2018 14:45:46 +0000 (GMT) Received: by rapoport-lnx (sSMTP sendmail emulation); Wed, 28 Nov 2018 16:45:45 +0200 From: Mike Rapoport To: Jonathan Corbet Cc: linux-doc@vger.kernel.org, linux-mm@kvack.org, Mike Rapoport Subject: [PATCH] docs/core-api: make mm-api.rst more structured Date: Wed, 28 Nov 2018 16:45:44 +0200 X-Mailer: git-send-email 2.7.4 X-TM-AS-GCONF: 00 x-cbid: 18112814-4275-0000-0000-000002E80C53 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 18112814-4276-0000-0000-000037F54D13 Message-Id: <1543416344-25543-1-git-send-email-rppt@linux.ibm.com> X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:,, definitions=2018-11-28_07:,, signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1811280130 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: X-Virus-Scanned: ClamAV using ClamSMTP The mm-api.rst covers variety of memory management APIs under "More Memory Management Functions" section. The descriptions included there are in a random order there are quite a few of them which makes the section too long. Regrouping the documentation by subject and splitting the long "More Memory Management Functions" section into several smaller sections makes the generated html more usable. Signed-off-by: Mike Rapoport --- Documentation/core-api/mm-api.rst | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/Documentation/core-api/mm-api.rst b/Documentation/core-api/mm-api.rst index 5ce1ec1..c81e754 100644 --- a/Documentation/core-api/mm-api.rst +++ b/Documentation/core-api/mm-api.rst @@ -49,8 +49,14 @@ The Slab Cache .. kernel-doc:: mm/util.c :functions: kfree_const kvmalloc_node kvfree -More Memory Management Functions -================================ +Virtually Contiguous Mappings +============================= + +.. kernel-doc:: mm/vmalloc.c + :export: + +File Mapping and Page Cache +=========================== .. kernel-doc:: mm/readahead.c :export: @@ -58,23 +64,28 @@ More Memory Management Functions .. kernel-doc:: mm/filemap.c :export: -.. kernel-doc:: mm/memory.c +.. kernel-doc:: mm/page-writeback.c :export: -.. kernel-doc:: mm/vmalloc.c +.. kernel-doc:: mm/truncate.c :export: -.. kernel-doc:: mm/page_alloc.c - :internal: +Memory pools +============ .. kernel-doc:: mm/mempool.c :export: +DMA pools +========= + .. kernel-doc:: mm/dmapool.c :export: -.. kernel-doc:: mm/page-writeback.c - :export: +More Memory Management Functions +================================ -.. kernel-doc:: mm/truncate.c +.. kernel-doc:: mm/memory.c :export: + +.. kernel-doc:: mm/page_alloc.c