From patchwork Sat Jun 30 14:54:58 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Rapoport X-Patchwork-Id: 10498231 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 CD28160284 for ; Sat, 30 Jun 2018 14:55:28 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id BF1A028F7E for ; Sat, 30 Jun 2018 14:55:28 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id B38DD2906A; Sat, 30 Jun 2018 14:55:28 +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 3E4D428F7E for ; Sat, 30 Jun 2018 14:55:28 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 5201A6B0008; 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 3E52C6B000D; 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 287996B000E; 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-wm0-f69.google.com (mail-wm0-f69.google.com [74.125.82.69]) by kanga.kvack.org (Postfix) with ESMTP id AC0756B0007 for ; Sat, 30 Jun 2018 10:55:24 -0400 (EDT) Received: by mail-wm0-f69.google.com with SMTP id w138-v6so1729201wmw.4 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=CKshpfWbYOY7IIbnJJGGt3y6jUL/2Og6CkyGnCY//pw=; b=NsxV5RJd6YOBl97HIT4DCrGhRR6PNicvrXKGYmgMcOU8S2qsciG5qTRcgsGaZwO+mB yNIUqhrx3nQo0/CQOkOt3jnlBZNssZsT+pccY20KfHgWkidcyvN+K+j8ocSM29O0XPY7 yXbg2K1njoPYwQk9kfVCfxQUjRQ3Bxl2L0HAvJoV1hbdCsa9XNBlCgYCSNQ8mIBzB32w O7vlk76J8n+zUMeQImbBadh4WwPyUk/bHmxdtuGfl0yVJcgIBk2spDauqM38YvmfV3W1 txU5a7iR0212JBS0R9l5GBufpPkdMDWL2PfDg2Zix968oPtqai+c8V7iANg8azIogncL c+PA== 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: APt69E2uD+MNEcefomUkMPnySoQHdl8Q+ajAiv5/Cqo9YJO+LvgOjTAh JFvuojJD26ZxvkdFHejDufNY6yj0D/PvHxsc6CDmZjGW88i+KZrTUR5Sd97eGmAxOCCnG4Tsulw pzg3fuw3H905vj2jg2ZDO2KRLfb55HG5ncGlP6pjJ/Vi0vRDuszpkrhJeXmtiVs4= X-Received: by 2002:adf:fed2:: with SMTP id q18-v6mr15706986wrs.165.1530370524230; Sat, 30 Jun 2018 07:55:24 -0700 (PDT) X-Google-Smtp-Source: AAOMgpe0KSRve2vUOLVyD/pO1tyjaVUxXOfwW84ttJAPbDPskLHb6ZSAVpO8TEtUhEZXqvewMTAf X-Received: by 2002:adf:fed2:: with SMTP id q18-v6mr15706961wrs.165.1530370523203; 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=ryI4Qw3KEZpzMtHJFjrhSVMOWIi0uyhlWNcVM5qJTO8sLwPhI6lllDogiAkHb7RZAC Ck+yVDB3JkalTjXhndPPVGpbEwDDjRdmg5DxxukDCoz+y79jS1vWTOg7CRffNE9bwokr KC12Iv190RIQTfVe4F1o+0c+dynFyltwsLCmpuBhdtt46El3jFOwB+vrc/CNq+cU3atf Y11z130qdyWHvXTxCa04VMZfsBjeRC7XKZaSpX5d2fKhamZF9ETLmToz1N32lqjj4opD 87Eyn/e/rcU0apl8NBFPT1Pr98KiFjT/o+/al/mdc80LB8WzCx7398Xq60FXStyvp11R IuDQ== 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=CKshpfWbYOY7IIbnJJGGt3y6jUL/2Og6CkyGnCY//pw=; b=x5DQXbqjfJmhQytTVl4H7IY2n4vaSYzjT5m0gQrqWVE9MGui3wZFpDlORLousBgI1I lF9lOeynz+GizcCw0m3GMOOk7rUencXkDX0FHQWtylXSUeBej6UI3OfPNWRqPrVx6pEU LzatYVLVcMp9zGm+O9zqYoEpBBa8mnxWz2/pemGe/p1CVyZmmSSVIMfzqIIqnit7+P0d 4nXo7XF471Ah31xHhZvYbLulorMZRAXhTssdDFMXaS7QIroMgyWvE1Ie7gkaQf5tT6z3 FI70FNnl+Ebmc9uKO6ZC0lSK9g/wJcmEFkcD50RPaq8SkS2CCMZHOxqmUZa2BY9lyjCb eyrg== 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 h204-v6si3528766wmd.23.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.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 (m0098416.ppops.net [127.0.0.1]) by mx0b-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id w5UErVih036153 for ; Sat, 30 Jun 2018 10:55:21 -0400 Received: from e06smtp07.uk.ibm.com (e06smtp07.uk.ibm.com [195.75.94.103]) by mx0b-001b2d01.pphosted.com with ESMTP id 2jx3g6x3bs-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 e06smtp07.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Sat, 30 Jun 2018 15:55:20 +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) Sat, 30 Jun 2018 15:55:18 +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 w5UEtH7641943278 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL); Sat, 30 Jun 2018 14:55:17 GMT Received: from d06av23.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id BE094A4040; Sat, 30 Jun 2018 15:55:03 +0100 (BST) Received: from d06av23.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 2D4EFA404D; Sat, 30 Jun 2018 15:55:02 +0100 (BST) Received: from rapoport-lnx (unknown [9.148.205.240]) by d06av23.portsmouth.uk.ibm.com (Postfix) with ESMTPS; Sat, 30 Jun 2018 15:55:02 +0100 (BST) Received: by rapoport-lnx (sSMTP sendmail emulation); Sat, 30 Jun 2018 17:55:15 +0300 From: Mike Rapoport To: Jonathan Corbet Cc: Randy Dunlap , linux-doc , linux-mm , lkml , Mike Rapoport Subject: [PATCH v2 03/11] docs/mm: bootmem: fix kernel-doc warnings Date: Sat, 30 Jun 2018 17:54:58 +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-0028-0000-0000-000002D6B5D3 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 18063014-0029-0000-0000-0000238E2AF3 Message-Id: <1530370506-21751-4-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=913 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 descriptions of the return value where they were missing and fixup the syntax for present ones. Signed-off-by: Mike Rapoport --- mm/bootmem.c | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/mm/bootmem.c b/mm/bootmem.c index 42ab0da..76fc17e 100644 --- a/mm/bootmem.c +++ b/mm/bootmem.c @@ -62,6 +62,8 @@ static unsigned long __init bootmap_bytes(unsigned long pages) /** * bootmem_bootmap_pages - calculate bitmap size in pages * @pages: number of pages the bitmap has to represent + * + * Return: the number of pages needed to hold the bitmap. */ unsigned long __init bootmem_bootmap_pages(unsigned long pages) { @@ -121,7 +123,7 @@ static unsigned long __init init_bootmem_core(bootmem_data_t *bdata, * @startpfn: first pfn on the node * @endpfn: first pfn after the node * - * Returns the number of bytes needed to hold the bitmap for this node. + * Return: the number of bytes needed to hold the bitmap for this node. */ unsigned long __init init_bootmem_node(pg_data_t *pgdat, unsigned long freepfn, unsigned long startpfn, unsigned long endpfn) @@ -134,7 +136,7 @@ unsigned long __init init_bootmem_node(pg_data_t *pgdat, unsigned long freepfn, * @start: pfn where the bitmap is to be placed * @pages: number of available physical pages * - * Returns the number of bytes needed to hold the bitmap. + * Return: the number of bytes needed to hold the bitmap. */ unsigned long __init init_bootmem(unsigned long start, unsigned long pages) { @@ -406,6 +408,8 @@ void __init free_bootmem(unsigned long physaddr, unsigned long size) * Partial pages will be reserved. * * The range must reside completely on the specified node. + * + * Return: 0 on success, -errno on failure. */ int __init reserve_bootmem_node(pg_data_t *pgdat, unsigned long physaddr, unsigned long size, int flags) @@ -427,6 +431,8 @@ int __init reserve_bootmem_node(pg_data_t *pgdat, unsigned long physaddr, * Partial pages will be reserved. * * The range must be contiguous but may span node boundaries. + * + * Return: 0 on success, -errno on failure. */ int __init reserve_bootmem(unsigned long addr, unsigned long size, int flags)