From patchwork Thu Jul 26 12:22:00 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Rapoport X-Patchwork-Id: 10545701 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 81E0B112E for ; Thu, 26 Jul 2018 12:22:32 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 709BD2AE5C for ; Thu, 26 Jul 2018 12:22:32 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 64CC02B11C; Thu, 26 Jul 2018 12:22:32 +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 D2EC72AE5C for ; Thu, 26 Jul 2018 12:22:31 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 9BE9A6B0010; Thu, 26 Jul 2018 08:22:25 -0400 (EDT) Delivered-To: linux-mm-outgoing@kvack.org Received: by kanga.kvack.org (Postfix, from userid 40) id 901C56B0266; Thu, 26 Jul 2018 08:22:25 -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 6838A6B026A; Thu, 26 Jul 2018 08:22:25 -0400 (EDT) X-Original-To: linux-mm@kvack.org X-Delivered-To: linux-mm@kvack.org Received: from mail-oi0-f70.google.com (mail-oi0-f70.google.com [209.85.218.70]) by kanga.kvack.org (Postfix) with ESMTP id 372C16B0266 for ; Thu, 26 Jul 2018 08:22:25 -0400 (EDT) Received: by mail-oi0-f70.google.com with SMTP id s200-v6so1224595oie.6 for ; Thu, 26 Jul 2018 05:22:25 -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=sst+/MEkKSVLs/vOUaRfo+L6yKA9FeOhhj3vEeCs3h+Hyuw4o7AGo8j3Bmnb0JV4KC N6bCMy1FIdLOiFP99t8aIBctXcDPx9+u1q0LMT5bw4g+q5gBAqSIHhmcPFlrJehesYMc /usxLAV/tt4KvV1UXx2VN4qGpaHDJh5WXX1h8gDMtzXW9Ic6A4/Lvod4W6qOMBHyXuvO onndhHUiyDZ+TLuXiKxdn3WHyVPpRxtV70hTC6GQD/NMM0QhGE8bJAnyihOqk3/V8/RP gOb/5an5v0rZCCvjkCjMl26Lvpq+2lgr12Q/4IKUhnUxXpHPDJalrUO6gP0vTtvzY09Q 6lig== 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: AOUpUlHHvWu6K5UHnkair6DwHsJ9vovzgmvfe5Id6djwEe0XzWJM7MCf Hyirrmv0VGQCQZ+KbyVuxPg1iwcKbjbljr1ihvJ05GtxQTLNAUKKBezgqSAngqxglsAc/C3VpdF bAgUZStpA9xJr3YDkKIJsERqnh+5Uqg9ed/bptTpGkUJCPjt96W4fmB7noLmvvdI= X-Received: by 2002:aca:c5d8:: with SMTP id v207-v6mr1773270oif.264.1532607744995; Thu, 26 Jul 2018 05:22:24 -0700 (PDT) X-Google-Smtp-Source: AAOMgpd75qNb07P94b3qcbD5IuJD0ReMF/XNNT8eR7Stpn0EWDwmPPlsj17BLspv/7g1XQ/VVSUp X-Received: by 2002:aca:c5d8:: with SMTP id v207-v6mr1773222oif.264.1532607744124; Thu, 26 Jul 2018 05:22:24 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1532607744; cv=none; d=google.com; s=arc-20160816; b=DxM0vq9tAU+3G5YLMpKSid3xB7HQOKtH9AtfJOSYLm0RbGlOkM4+SLi2aNpumCBKxE IqDU8XTuOh/GUoWwV8nYn8sSgjvIVlDPpG7/pcou3AO0KwTlyYaxjEjLf1HDs3x1iaE5 Do5BBNRdDFRpBnj2hYMYgSAPFuuiOxunGhuIs2jIINxW2uuIYby8XaktxIqZJ77yHlRX yv0NNsjpW7fG4gSC5HGfrZk1HPS2NST6+tSlF/zIICCXqhlFbUaxOSTmTsDJK6dY35hT k/6V4miHZVrZhNbZwAaXNKL//airm6IlMazEgxiNuKA1XtAniRV2gtZ8Gkr1Ng0J+VWL Y4kQ== 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=kGhUov0pbLood53oJIaLZo0PkRYcjAeto7TQz2V3GAlE6uAR4yb7Kss+67B8UpoL5t onPyXb5fdZABXgrB/84zMn97TxI+wcmsvEyhVinmGzYEt7y4VHOEm+VZQKze7WZqmGCJ oYcVErjhcrirkRGjJ3EFZMOx7CZdgGLifVe3bqKkjdAZ4OAr1fciAivqwFtt+v2BJC25 TmSdM7Q0uI1gb57IUIeKFmIn1VuEeVANxuHJKqO7ZMjvsTkffavZ1F0QXOPiCIUKCXv/ +KO2GOeYfUNkZwOUHfHuOMwrtQCXKNQS+DmWU+ZOIuxFF/c38r6LRYSGCkEoriDOCZ0r unZA== 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 199-v6si806465oic.364.2018.07.26.05.22.23 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 26 Jul 2018 05:22:24 -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 (m0098413.ppops.net [127.0.0.1]) by mx0b-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id w6QCJ4Ru046685 for ; Thu, 26 Jul 2018 08:22:23 -0400 Received: from e06smtp07.uk.ibm.com (e06smtp07.uk.ibm.com [195.75.94.103]) by mx0b-001b2d01.pphosted.com with ESMTP id 2kfe0p8q5n-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Thu, 26 Jul 2018 08:22:23 -0400 Received: from localhost by e06smtp07.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Thu, 26 Jul 2018 13:22:21 +0100 Received: from b06cxnps4075.portsmouth.uk.ibm.com (9.149.109.197) by e06smtp07.uk.ibm.com (192.168.101.137) 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 13:22:17 +0100 Received: from d06av23.portsmouth.uk.ibm.com (d06av23.portsmouth.uk.ibm.com [9.149.105.59]) by b06cxnps4075.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id w6QCMG9838600854 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL); Thu, 26 Jul 2018 12:22:16 GMT Received: from d06av23.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 36346A405E; Thu, 26 Jul 2018 15:22:30 +0100 (BST) Received: from d06av23.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id B0707A4040; Thu, 26 Jul 2018 15:22:28 +0100 (BST) Received: from rapoport-lnx (unknown [9.148.8.177]) by d06av23.portsmouth.uk.ibm.com (Postfix) with ESMTPS; Thu, 26 Jul 2018 15:22:28 +0100 (BST) Received: by rapoport-lnx (sSMTP sendmail emulation); Thu, 26 Jul 2018 15:22:14 +0300 From: Mike Rapoport To: Jonathan Corbet , Andrew Morton Cc: Matthew Wilcox , linux-doc@vger.kernel.org, linux-mm@kvack.org, linux-kernel@vger.kernel.org, Mike Rapoport Subject: [PATCH v2 5/7] docs/core-api: split memory management API to a separate file Date: Thu, 26 Jul 2018 15:22:00 +0300 X-Mailer: git-send-email 2.7.4 In-Reply-To: <1532607722-17079-1-git-send-email-rppt@linux.vnet.ibm.com> References: <1532607722-17079-1-git-send-email-rppt@linux.vnet.ibm.com> X-TM-AS-GCONF: 00 x-cbid: 18072612-0028-0000-0000-000002E08D41 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 18072612-0029-0000-0000-000023987EAD Message-Id: <1532607722-17079-6-git-send-email-rppt@linux.vnet.ibm.com> X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:,, definitions=2018-07-26_03:,, 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-1807260129 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: