From patchwork Wed Jul 25 11:26:08 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Rapoport X-Patchwork-Id: 10543861 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 8ADF71805 for ; Wed, 25 Jul 2018 11:26:40 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 79A7F29960 for ; Wed, 25 Jul 2018 11:26:40 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 6BB8C29A55; Wed, 25 Jul 2018 11:26:40 +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 DEF1E29960 for ; Wed, 25 Jul 2018 11:26:39 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 1A1426B028E; Wed, 25 Jul 2018 07:26:34 -0400 (EDT) Delivered-To: linux-mm-outgoing@kvack.org Received: by kanga.kvack.org (Postfix, from userid 40) id 0D5D46B0290; Wed, 25 Jul 2018 07:26:34 -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 F0D946B0291; Wed, 25 Jul 2018 07:26:33 -0400 (EDT) X-Original-To: linux-mm@kvack.org X-Delivered-To: linux-mm@kvack.org Received: from mail-oi0-f71.google.com (mail-oi0-f71.google.com [209.85.218.71]) by kanga.kvack.org (Postfix) with ESMTP id B1E316B028E for ; Wed, 25 Jul 2018 07:26:33 -0400 (EDT) Received: by mail-oi0-f71.google.com with SMTP id j5-v6so7232417oiw.13 for ; Wed, 25 Jul 2018 04:26:33 -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=zGe2azKGEp/muaSeVOvIMXRKyhuCTHnTymRklC/4mh8=; b=BH5E643D1KY2RajNA22h6qtQDze4bIttSvfMD158tmUJxm5yRGRIbpozOZ7eYoYWkw LqxbjmWyUP45ZGrpZUB7EzYxTGbOIuKFh/HFGaqR+KkpEIG2oKluO1HciviXnNU45q/Y l9A34lEqFTAWYSL77L3+hdn5bCj+LkXb1PH/NoPnw1lAJuS8J73PftNbjoXXUKN/Cupd Sc0pmzTGJn14jrJIs3p+B2vPCvKxCr+zag2w8YISZ8ltod7Cs+zSwbh1NXttnlsOODmU nFMlqxgWLtqC+SHvcf8CbRFy5Z5nH+6HZDtbQ14TNqN6uWRsgmNx3ZlhPL4Wi9CWyOJX Fi4w== X-Original-Authentication-Results: mx.google.com; spf=neutral (google.com: 148.163.156.1 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: AOUpUlEkJn1jzNe6F8FQ2qH5wE02lV0iBkwgX5t2ei1ZV6WZcHGKbiUz +Hjn74toIhrAQHZkPFTNcjqmJmp+VWw62iCVyTPSsXMm3+g5W+QaIuRkk+pCOWGFlMesyLw0RhI 4oZz5edxa56WpQEqEFe60GnKV9PO2U3qMCvfScl97tgYT0zkFZyaJEU913e8fXjc= X-Received: by 2002:aca:e184:: with SMTP id y126-v6mr3120433oig.313.1532517993506; Wed, 25 Jul 2018 04:26:33 -0700 (PDT) X-Google-Smtp-Source: AAOMgpf/+OLfu3saB8i0jTt1FCL+9nGP2fX0KUFfIV3y8fsh+8lfkuCWCatdF+MgKTHcQrHeViXF X-Received: by 2002:aca:e184:: with SMTP id y126-v6mr3120386oig.313.1532517992732; Wed, 25 Jul 2018 04:26:32 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1532517992; cv=none; d=google.com; s=arc-20160816; b=O7LY2KZRGJ/pQfizhKuTvlrMzgLxr6RpWexqERu1nqckB1KNzFzYWgPiyH9VbiW2HO bOGRikUy+ccBTIxy0+dPadBz6uOXDWPXbQQ7aP+cJ2M4ND9aqpoZ10cWPjmd03UE0MI1 rXcd1PbJhFeQkkMIr+5H47vd0QSrHISswDhHUBprNRbYPYphmDnnb7izN4VSCWVHgger HKTRSh5vImm/HKbsyI+u1ZA8CHwv320Df6xKW1Vt6FPG3lhDav09mfL/rhyWZjwIEDkN RSKclYNs6LoD6ybxWqTHaaG7DrHkUtdSRmvGsPLqNugjr0jmIqQ5ILwuj0QDzeFTbgGO zPTA== 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=zGe2azKGEp/muaSeVOvIMXRKyhuCTHnTymRklC/4mh8=; b=VRGYoRI76hXI1h5H4X7ZcS09SVG1LklUfNx8nJ+bkT95o0jIF9+TiucM9u/k41gcKc O6uPWn7e2upVEvS9fnNmg/AD/ExnRseh3hSsLFPU/bOWhoyoeDbDPUfhVqzfbyDsqcr9 DGHbD6CUg7Xjs7d4vMwQSksTv19ugd14h50KYn18/zw6EmqDraj2DMeTPL1PPJKaANdP 7QPJ1Gi/ycQnRkX+1glGkI5RwDrrBEkqwZwJTEpGwy35ULCB4NHqpLJexqbOyvCASXe7 LJSKU1bYcRuz+T+pkFyDmaHAAoYGfFB5Kuu2oGv/VINLnlaZkpJoTcgW4Yv4u20w4iTx zlBw== ARC-Authentication-Results: i=1; mx.google.com; spf=neutral (google.com: 148.163.156.1 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 (mx0a-001b2d01.pphosted.com. [148.163.156.1]) by mx.google.com with ESMTPS id r3-v6si9674326oig.150.2018.07.25.04.26.32 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 25 Jul 2018 04:26:32 -0700 (PDT) Received-SPF: neutral (google.com: 148.163.156.1 is neither permitted nor denied by best guess record for domain of rppt@linux.vnet.ibm.com) client-ip=148.163.156.1; Authentication-Results: mx.google.com; spf=neutral (google.com: 148.163.156.1 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 (m0098410.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id w6PBOGcl082846 for ; Wed, 25 Jul 2018 07:26:32 -0400 Received: from e06smtp03.uk.ibm.com (e06smtp03.uk.ibm.com [195.75.94.99]) by mx0a-001b2d01.pphosted.com with ESMTP id 2kep26pcpd-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Wed, 25 Jul 2018 07:26:31 -0400 Received: from localhost by e06smtp03.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Wed, 25 Jul 2018 12:26:29 +0100 Received: from b06cxnps4075.portsmouth.uk.ibm.com (9.149.109.197) by e06smtp03.uk.ibm.com (192.168.101.133) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; (version=TLSv1/SSLv3 cipher=AES256-GCM-SHA384 bits=256/256) Wed, 25 Jul 2018 12:26:25 +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 w6PBQOjo42139768 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL); Wed, 25 Jul 2018 11:26:24 GMT Received: from d06av23.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id AD27CA4053; Wed, 25 Jul 2018 14:26:38 +0100 (BST) Received: from d06av23.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 380C9A404D; Wed, 25 Jul 2018 14:26:37 +0100 (BST) Received: from rapoport-lnx (unknown [9.148.8.110]) by d06av23.portsmouth.uk.ibm.com (Postfix) with ESMTPS; Wed, 25 Jul 2018 14:26:37 +0100 (BST) Received: by rapoport-lnx (sSMTP sendmail emulation); Wed, 25 Jul 2018 14:26:22 +0300 From: Mike Rapoport To: Jonathan Corbet , Andrew Morton Cc: linux-doc@vger.kernel.org, linux-mm@kvack.org, linux-kernel@vger.kernel.org, Mike Rapoport Subject: [PATCH 5/7] docs/core-api: split memory management API to a separate file Date: Wed, 25 Jul 2018 14:26:08 +0300 X-Mailer: git-send-email 2.7.4 In-Reply-To: <1532517970-16409-1-git-send-email-rppt@linux.vnet.ibm.com> References: <1532517970-16409-1-git-send-email-rppt@linux.vnet.ibm.com> X-TM-AS-GCONF: 00 x-cbid: 18072511-0012-0000-0000-0000028E9491 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 18072511-0013-0000-0000-000020C07B8D Message-Id: <1532517970-16409-6-git-send-email-rppt@linux.vnet.ibm.com> X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:,, definitions=2018-07-25_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=863 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1806210000 definitions=main-1807250124 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 Signed-off-by: Mike Rapoport --- Documentation/core-api/index.rst | 1 + Documentation/core-api/kernel-api.rst | 54 ----------------------------------- Documentation/core-api/mm-api.rst | 54 +++++++++++++++++++++++++++++++++++ 3 files changed, 55 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 f5a66b7..b580204 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 Interfaces for kernel debugging 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..65a8ef09 --- /dev/null +++ b/Documentation/core-api/mm-api.rst @@ -0,0 +1,54 @@ +====================== +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: + +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 + +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: