From patchwork Thu Jul 26 17:32:38 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Rapoport X-Patchwork-Id: 10546279 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 28B72174A for ; Thu, 26 Jul 2018 17:33:10 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 19AE92AB8B for ; Thu, 26 Jul 2018 17:33:10 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 0D4A42B073; Thu, 26 Jul 2018 17:33:10 +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 7B92D2AB8B for ; Thu, 26 Jul 2018 17:33:09 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 85AA26B0270; Thu, 26 Jul 2018 13:33:07 -0400 (EDT) Delivered-To: linux-mm-outgoing@kvack.org Received: by kanga.kvack.org (Postfix, from userid 40) id 80B146B0272; Thu, 26 Jul 2018 13:33:07 -0400 (EDT) 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 6AD2C6B0273; Thu, 26 Jul 2018 13:33:07 -0400 (EDT) X-Original-To: linux-mm@kvack.org X-Delivered-To: linux-mm@kvack.org Received: from mail-ed1-f70.google.com (mail-ed1-f70.google.com [209.85.208.70]) by kanga.kvack.org (Postfix) with ESMTP id 0DDA66B0270 for ; Thu, 26 Jul 2018 13:33:07 -0400 (EDT) Received: by mail-ed1-f70.google.com with SMTP id b9-v6so1081106edn.18 for ; Thu, 26 Jul 2018 10:33:07 -0700 (PDT) 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:in-reply-to:references:message-id; bh=zacj2v+gL+xEawH15lH4idOPm19Lrm+JaASwix2hvhU=; b=BaSHzcAKKk2if7YTJwMUIrOnRr1mvonv5fXFxR1mdoRTzHOaI4qjgY3Q6GSNFGZtYv IXFxLRX3IrnEQZkrj5zVHQjFW9lHXZnf27QjQg0BdiFQs9VaUV54vPHlATccA7JkAEsp Izz1Kh7M94Dp4k4IAEqA/qhd9C0FX3UutguK0P98MtstDW+B/htdT0Ut/EJP+9SUwotX KpbvkFdw+/AfXyCMyIL83YiB5zEzQmQKZ77SAEQGN7wkwKbcZlorqMMK1Q70q0IVC24G 9j/WZg6JF4f8I9sv/qTE6e3TlR1vOtluZCyrPd8OQgyw8Iz76UZsnPBHCUZV6sYmjtzW nmrw== X-Original-Authentication-Results: mx.google.com; spf=neutral (google.com: 148.163.158.5 is neither permitted nor denied by best guess record for domain of rppt@linux.vnet.ibm.com) smtp.mailfrom=rppt@linux.vnet.ibm.com; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=ibm.com X-Gm-Message-State: AOUpUlEeMnQctYT62iuwErwbYNcoGJhbyf7LpmZ+oqsZ/N9A/RlReHEn 1GVeq+VpGLa8IoYSgEHEAVK4vpdCvWONfnFh+ZE5BbY9ZzTsMFShK3TScmmHofkzGDJwsbTJ12i 9UJ3r2jd22Nt0+OlHoImlRW7sf3r+wWHwmQzHcrOvdbtOZ+5b1ZbBwJPOYWPTAl0= X-Received: by 2002:a50:b807:: with SMTP id j7-v6mr3635504ede.206.1532626386607; Thu, 26 Jul 2018 10:33:06 -0700 (PDT) X-Google-Smtp-Source: AAOMgpelu0YlmQx/xr7mKcXRN/1zrKvOmCT5Kgmy+RfMOJ4zsA5A19d9ThgwKo6+GchNyslMmieG X-Received: by 2002:a50:b807:: with SMTP id j7-v6mr3635466ede.206.1532626385888; Thu, 26 Jul 2018 10:33:05 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1532626385; cv=none; d=google.com; s=arc-20160816; b=L281fR05VCaSDLgfKq5cm3qg0Me0kOBurmohQzaMxEj+C/dZsTK18H9S6Em25eU2md ifbVMnz5CNy+q7hoWZYBxv0Ux9zFOgR575rsHPcwUyYcvyIqWBaaIG7wewSeg9AjXIFU TTBicesT34m2sP6zOVfcIPjs1IwjxJL/BbzQLuKdk1pQHhq9ViastgbAdnoobz8nhnaf opshzABqR1iqtmzJDBtjxMiFwmurYndebp59x0Uvn+TAcMv41xOGuVcX6xoNjbdDmc0O Mvyh4RiHiKgkYI5AC+RPa2n42OPspss3Rb2RpwI8/0crjU2tl0v9cHRWPiml9HkHqet9 NtuA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=message-id:references:in-reply-to:date:subject:cc:to:from :arc-authentication-results; bh=zacj2v+gL+xEawH15lH4idOPm19Lrm+JaASwix2hvhU=; b=LepLCrYtSLxmSwMNC8C25GjNGg15ZZVvkJ6KLl55Vj0FnjJsmNr28BXz0/uzKMeFqy sh+K407q8U46vg2vaK69vpG8YJAZurAIXlJnHwzjY7Kjtpkl8rers9Go3roCXfREgwTE oknlq+vS2HPs1BKQNV/WNsHz8zmhR6O/c1YUKDV9+Wqc5kV+yv7pt88iNvcvotzb0eN8 XRoOn5pBqMn34g63p55mJEMdmckvuTIvZ+lRTsDeJ2oHU/oWOAFOrC8qb/gYq1W+o5PC 26q1zXt1mMs5tzsUYOfRoBBrQl7mXbUQ75+tH28snORhuSwaoL8BkQRdL7NLDXLJDXYG xHrg== ARC-Authentication-Results: i=1; mx.google.com; spf=neutral (google.com: 148.163.158.5 is neither permitted nor denied by best guess record for domain of rppt@linux.vnet.ibm.com) smtp.mailfrom=rppt@linux.vnet.ibm.com; dmarc=fail (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 l22-v6si1579170eda.370.2018.07.26.10.33.05 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 26 Jul 2018 10:33:05 -0700 (PDT) Received-SPF: neutral (google.com: 148.163.158.5 is neither permitted nor denied by best guess record for domain of rppt@linux.vnet.ibm.com) client-ip=148.163.158.5; Authentication-Results: mx.google.com; spf=neutral (google.com: 148.163.158.5 is neither permitted nor denied by best guess record for domain of rppt@linux.vnet.ibm.com) smtp.mailfrom=rppt@linux.vnet.ibm.com; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=ibm.com Received: from pps.filterd (m0098420.ppops.net [127.0.0.1]) by mx0b-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id w6QHTde6130100 for ; Thu, 26 Jul 2018 13:33:04 -0400 Received: from e06smtp04.uk.ibm.com (e06smtp04.uk.ibm.com [195.75.94.100]) by mx0b-001b2d01.pphosted.com with ESMTP id 2kfjrb83jf-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Thu, 26 Jul 2018 13:33:03 -0400 Received: from localhost by e06smtp04.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Thu, 26 Jul 2018 18:33:02 +0100 Received: from b06cxnps4074.portsmouth.uk.ibm.com (9.149.109.196) by e06smtp04.uk.ibm.com (192.168.101.134) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; (version=TLSv1/SSLv3 cipher=AES256-GCM-SHA384 bits=256/256) Thu, 26 Jul 2018 18:32:58 +0100 Received: from d06av21.portsmouth.uk.ibm.com (d06av21.portsmouth.uk.ibm.com [9.149.105.232]) by b06cxnps4074.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id w6QHWvrp36372724 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL); Thu, 26 Jul 2018 17:32:57 GMT Received: from d06av21.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 1EAF65204E; Thu, 26 Jul 2018 20:33:11 +0100 (BST) Received: from rapoport-lnx (unknown [9.148.204.214]) by d06av21.portsmouth.uk.ibm.com (Postfix) with ESMTPS id 4B9105204F; Thu, 26 Jul 2018 20:33:09 +0100 (BST) Received: by rapoport-lnx (sSMTP sendmail emulation); Thu, 26 Jul 2018 20:32:54 +0300 From: Mike Rapoport To: Jonathan Corbet , Andrew Morton Cc: Matthew Wilcox , Michal Hocko , linux-doc@vger.kernel.org, linux-mm@kvack.org, linux-kernel@vger.kernel.org, Mike Rapoport Subject: [PATCH v3 5/7] docs/core-api: split memory management API to a separate file Date: Thu, 26 Jul 2018 20:32:38 +0300 X-Mailer: git-send-email 2.7.4 In-Reply-To: <1532626360-16650-1-git-send-email-rppt@linux.vnet.ibm.com> References: <1532626360-16650-1-git-send-email-rppt@linux.vnet.ibm.com> X-TM-AS-GCONF: 00 x-cbid: 18072617-0016-0000-0000-000001EC6DA9 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 18072617-0017-0000-0000-00003241745A Message-Id: <1532626360-16650-6-git-send-email-rppt@linux.vnet.ibm.com> X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:,, definitions=2018-07-26_04:,, 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-1806210000 definitions=main-1807260180 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 This is basically copy-paste of the memory management section from kernel-api.rst with some minor adjustments: * The "User Space Memory Access" is moved to the beginning * The get_user_pages_fast reference is now a part of "User Space Memory Access" * And, of course, headings are adjusted with section being promoted to chapters Signed-off-by: Mike Rapoport --- Documentation/core-api/index.rst | 1 + Documentation/core-api/kernel-api.rst | 54 --------------------------------- Documentation/core-api/mm-api.rst | 57 +++++++++++++++++++++++++++++++++++ 3 files changed, 58 insertions(+), 54 deletions(-) create mode 100644 Documentation/core-api/mm-api.rst diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst index 989c97c..cdc2020 100644 --- a/Documentation/core-api/index.rst +++ b/Documentation/core-api/index.rst @@ -27,6 +27,7 @@ Core utilities errseq printk-formats circular-buffers + mm-api gfp_mask-from-fs-io timekeeping diff --git a/Documentation/core-api/kernel-api.rst b/Documentation/core-api/kernel-api.rst index 39f1460..3431337 100644 --- a/Documentation/core-api/kernel-api.rst +++ b/Documentation/core-api/kernel-api.rst @@ -159,60 +159,6 @@ UUID/GUID .. kernel-doc:: lib/uuid.c :export: -Memory Management in Linux -========================== - -The Slab Cache --------------- - -.. kernel-doc:: include/linux/slab.h - :internal: - -.. kernel-doc:: mm/slab.c - :export: - -.. kernel-doc:: mm/util.c - :functions: kfree_const kvmalloc_node kvfree get_user_pages_fast - -User Space Memory Access ------------------------- - -.. kernel-doc:: arch/x86/include/asm/uaccess.h - :internal: - -.. kernel-doc:: arch/x86/lib/usercopy_32.c - :export: - -More Memory Management Functions --------------------------------- - -.. kernel-doc:: mm/readahead.c - :export: - -.. kernel-doc:: mm/filemap.c - :export: - -.. kernel-doc:: mm/memory.c - :export: - -.. kernel-doc:: mm/vmalloc.c - :export: - -.. kernel-doc:: mm/page_alloc.c - :internal: - -.. kernel-doc:: mm/mempool.c - :export: - -.. kernel-doc:: mm/dmapool.c - :export: - -.. kernel-doc:: mm/page-writeback.c - :export: - -.. kernel-doc:: mm/truncate.c - :export: - Kernel IPC facilities ===================== diff --git a/Documentation/core-api/mm-api.rst b/Documentation/core-api/mm-api.rst new file mode 100644 index 0000000..b5913aa --- /dev/null +++ b/Documentation/core-api/mm-api.rst @@ -0,0 +1,57 @@ +====================== +Memory Management APIs +====================== + +User Space Memory Access +======================== + +.. kernel-doc:: arch/x86/include/asm/uaccess.h + :internal: + +.. kernel-doc:: arch/x86/lib/usercopy_32.c + :export: + +.. kernel-doc:: mm/util.c + :functions: get_user_pages_fast + +The Slab Cache +============== + +.. kernel-doc:: include/linux/slab.h + :internal: + +.. kernel-doc:: mm/slab.c + :export: + +.. kernel-doc:: mm/util.c + :functions: kfree_const kvmalloc_node kvfree + +More Memory Management Functions +================================ + +.. kernel-doc:: mm/readahead.c + :export: + +.. kernel-doc:: mm/filemap.c + :export: + +.. kernel-doc:: mm/memory.c + :export: + +.. kernel-doc:: mm/vmalloc.c + :export: + +.. kernel-doc:: mm/page_alloc.c + :internal: + +.. kernel-doc:: mm/mempool.c + :export: + +.. kernel-doc:: mm/dmapool.c + :export: + +.. kernel-doc:: mm/page-writeback.c + :export: + +.. kernel-doc:: mm/truncate.c + :export: