From patchwork Sat Jun 30 14:54:57 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Rapoport X-Patchwork-Id: 10498233 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 3833B60284 for ; Sat, 30 Jun 2018 14:55:33 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 29C4D28F7E for ; Sat, 30 Jun 2018 14:55:33 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 1E15D2906A; Sat, 30 Jun 2018 14:55:33 +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 1960128F7E for ; Sat, 30 Jun 2018 14:55:31 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 93E646B0007; Sat, 30 Jun 2018 10:55:25 -0400 (EDT) Delivered-To: linux-mm-outgoing@kvack.org Received: by kanga.kvack.org (Postfix, from userid 40) id 89F426B000E; Sat, 30 Jun 2018 10:55: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 51C876B0007; Sat, 30 Jun 2018 10:55:25 -0400 (EDT) X-Original-To: linux-mm@kvack.org X-Delivered-To: linux-mm@kvack.org Received: from mail-ed1-f72.google.com (mail-ed1-f72.google.com [209.85.208.72]) by kanga.kvack.org (Postfix) with ESMTP id D32626B0008 for ; Sat, 30 Jun 2018 10:55:24 -0400 (EDT) Received: by mail-ed1-f72.google.com with SMTP id s21-v6so3689501edq.23 for ; Sat, 30 Jun 2018 07:55:24 -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=8wmfMmMSE5Y1dSUxXuvj+e0GPoSE+kp4Zq02Is+PG60=; b=PZj/Gvlbcynv91PlKyPnZxreXOdS2H6EUsv+vmRYWDO2o6YaNuRrtAvwxEGOsxtHPb qJksVFPLIhh+c1vMZCMxVFMhfLGWqLERSpbOj5MPuEgDOh2N5zCcI/L7ZhRIwiHfbwLS DqtPc8wlvhj7ZKY3PvmuRfZOxssgN29gn5dp0jSAeFe92bm2FjZ5rr8hcIa3pfj8Ono0 UHsi9Q2HroHIG5pdVQ9YLs+PKUU9HBbB4wYTgxhi366PD8Krqbr8PGADn4XWpEtvY0IK u/Q1eEjHI75hYuVR6MZyi8mPBSu0/DKHAD1lUTxF3EajOZ5A9ouVmQYOLix9Pwmp0dVr mklg== 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: APt69E1z8rY53gDprLbzI/gkf1VZPRQBA6y17d3LM9HoDypHackvs9Vj mTuGQKR2of7johEvKxpT9cz/N7s6iI2XRG+OsFdV6JiQk+unY2Afy7+6hq5/ZiNqRx1FQmctbS+ lwZk8wbFXYC54+tVJmAbz3OXP7EO9Pe77NgiqWIuQYvMlUWqF5S1nTesutK+qOas= X-Received: by 2002:a50:ba6e:: with SMTP id 43-v6mr9355623eds.292.1530370524326; Sat, 30 Jun 2018 07:55:24 -0700 (PDT) X-Google-Smtp-Source: AAOMgpfYcfnwSN3/gXGftogt4kLpnJnPhtBRLKOlg1X1YfXPBbjxJc+OGABtpuZj+mHepj8I9VL7 X-Received: by 2002:a50:ba6e:: with SMTP id 43-v6mr9355579eds.292.1530370523463; Sat, 30 Jun 2018 07:55:23 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1530370523; cv=none; d=google.com; s=arc-20160816; b=eFN1AXR3eSZgkrofCqofzE1jKdaq6J/xtvk8799rEMlyE9HNx9ArX95HiPNzp1qHsJ cObHQWvIJ47T37hDoveioApRB2/0juFoyzpa15DCSXnyAx2TPWvfmtzQk7b0LgBPgcrh KdVLGQsrgdK6mVL2G84vv3ehC5VhCURk5SnhPAJ4sQ9uxouvuoui/ynQP5LzXOtnIfLQ z37QokE6Y9eOnM5KVuckzJFC0cozolWoDhVk/4EJJe2/WHguYfDbEsOEY8bEDjNHK+Jk U2kH5hAyj8Gid13hu14OFtc5vk5vh0WYMDWtIRnm/QeZ0e+fYz7lmYPgqkMIii/yC1IV RQ3w== 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=8wmfMmMSE5Y1dSUxXuvj+e0GPoSE+kp4Zq02Is+PG60=; b=Hq8EMWkBilFYsDDPEibq7FgCOZLmjc6G/ELr03r16FTQtTTm4VOAswhy9yp/yYFGbN wpFbw4wd9uUWTq4qJ3DpGthFyxj0rDtQ7m98Wv8iNXYllaYHQPI5nt5wfXDg8QbqxLzo ZeVhUV6PbZoBeLuMqobsd/bi+8/zER7unOJutTzUZVMfBeSillJwx33m4hXlsPVilIhe vp4nYkcSp3EytPtk72/sRi9Ba2Gdt4jRph0wzyJB5O0zpetgHAbKj1rCuvvIMaMcKUBp qKmooSffbbkfP+3AUgzEaAS0iqT8/pCiuujypk+TIORWt05VZnk2STVLAK41mipL23tA A7jg== 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 h32-v6si3436372eda.150.2018.06.30.07.55.22 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sat, 30 Jun 2018 07:55:23 -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 (m0098404.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id w5UErV5S126276 for ; Sat, 30 Jun 2018 10:55:21 -0400 Received: from e06smtp01.uk.ibm.com (e06smtp01.uk.ibm.com [195.75.94.97]) by mx0a-001b2d01.pphosted.com with ESMTP id 2jx5xvacqx-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Sat, 30 Jun 2018 10:55:21 -0400 Received: from localhost by e06smtp01.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Sat, 30 Jun 2018 15:55:18 +0100 Received: from b06cxnps4075.portsmouth.uk.ibm.com (9.149.109.197) 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) Sat, 30 Jun 2018 15:55:16 +0100 Received: from d06av22.portsmouth.uk.ibm.com (d06av22.portsmouth.uk.ibm.com [9.149.105.58]) by b06cxnps4075.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id w5UEtFFp34537658 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL); Sat, 30 Jun 2018 14:55:15 GMT Received: from d06av22.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 1F8034C040; Sat, 30 Jun 2018 15:55:01 +0100 (BST) Received: from d06av22.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 821F64C04A; Sat, 30 Jun 2018 15:54:59 +0100 (BST) Received: from rapoport-lnx (unknown [9.148.205.240]) by d06av22.portsmouth.uk.ibm.com (Postfix) with ESMTPS; Sat, 30 Jun 2018 15:54:59 +0100 (BST) Received: by rapoport-lnx (sSMTP sendmail emulation); Sat, 30 Jun 2018 17:55:12 +0300 From: Mike Rapoport To: Jonathan Corbet Cc: Randy Dunlap , linux-doc , linux-mm , lkml , Mike Rapoport Subject: [PATCH v2 02/11] docs/mm: nobootmem: fixup kernel-doc comments Date: Sat, 30 Jun 2018 17:54:57 +0300 X-Mailer: git-send-email 2.7.4 In-Reply-To: <1530370506-21751-1-git-send-email-rppt@linux.vnet.ibm.com> References: <1530370506-21751-1-git-send-email-rppt@linux.vnet.ibm.com> X-TM-AS-GCONF: 00 x-cbid: 18063014-4275-0000-0000-00000293AA11 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 18063014-4276-0000-0000-0000379B1E25 Message-Id: <1530370506-21751-3-git-send-email-rppt@linux.vnet.ibm.com> X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:, , definitions=2018-06-30_05:, , signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 malwarescore=0 suspectscore=2 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-1806300176 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 * add kernel-doc marking to free_bootmem_late() description * add return value descriptions * mention that address parameter of free_bootmem{_node} is a physical address Signed-off-by: Mike Rapoport --- mm/nobootmem.c | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/mm/nobootmem.c b/mm/nobootmem.c index 9b02fda..c2cfa04 100644 --- a/mm/nobootmem.c +++ b/mm/nobootmem.c @@ -72,7 +72,7 @@ static void * __init __alloc_memory_core_early(int nid, u64 size, u64 align, return ptr; } -/* +/** * free_bootmem_late - free bootmem pages directly to page allocator * @addr: starting address of the range * @size: size of the range in bytes @@ -176,7 +176,7 @@ void __init reset_all_zones_managed_pages(void) /** * free_all_bootmem - release free pages to the buddy allocator * - * Returns the number of pages actually released. + * Return: the number of pages actually released. */ unsigned long __init free_all_bootmem(void) { @@ -193,7 +193,7 @@ unsigned long __init free_all_bootmem(void) /** * free_bootmem_node - mark a page range as usable * @pgdat: node the range resides on - * @physaddr: starting address of the range + * @physaddr: starting physical address of the range * @size: size of the range in bytes * * Partial pages will be considered reserved and left as they are. @@ -208,7 +208,7 @@ void __init free_bootmem_node(pg_data_t *pgdat, unsigned long physaddr, /** * free_bootmem - mark a page range as usable - * @addr: starting address of the range + * @addr: starting physical address of the range * @size: size of the range in bytes * * Partial pages will be considered reserved and left as they are. @@ -256,7 +256,7 @@ static void * __init ___alloc_bootmem_nopanic(unsigned long size, * * Allocation may happen on any node in the system. * - * Returns NULL on failure. + * Return: address of the allocated region or %NULL on failure. */ void * __init __alloc_bootmem_nopanic(unsigned long size, unsigned long align, unsigned long goal) @@ -293,6 +293,8 @@ static void * __init ___alloc_bootmem(unsigned long size, unsigned long align, * Allocation may happen on any node in the system. * * The function panics if the request can not be satisfied. + * + * Return: address of the allocated region. */ void * __init __alloc_bootmem(unsigned long size, unsigned long align, unsigned long goal) @@ -367,6 +369,8 @@ static void * __init ___alloc_bootmem_node(pg_data_t *pgdat, unsigned long size, * can not hold the requested memory. * * The function panics if the request can not be satisfied. + * + * Return: address of the allocated region. */ void * __init __alloc_bootmem_node(pg_data_t *pgdat, unsigned long size, unsigned long align, unsigned long goal) @@ -396,6 +400,8 @@ void * __init __alloc_bootmem_node_high(pg_data_t *pgdat, unsigned long size, * Allocation may happen on any node in the system. * * The function panics if the request can not be satisfied. + * + * Return: address of the allocated region. */ void * __init __alloc_bootmem_low(unsigned long size, unsigned long align, unsigned long goal) @@ -425,6 +431,8 @@ void * __init __alloc_bootmem_low_nopanic(unsigned long size, * can not hold the requested memory. * * The function panics if the request can not be satisfied. + * + * Return: address of the allocated region. */ void * __init __alloc_bootmem_low_node(pg_data_t *pgdat, unsigned long size, unsigned long align, unsigned long goal)