From patchwork Wed Nov 7 15:08:36 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Rapoport X-Patchwork-Id: 10672533 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 8D6F514E2 for ; Wed, 7 Nov 2018 15:08:54 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 78DF12B90D for ; Wed, 7 Nov 2018 15:08:54 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 6CB7E2B9AC; Wed, 7 Nov 2018 15:08:54 +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.2 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_NONE,SUBJ_OBFU_PUNCT_FEW 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 0AEDF2B90D for ; Wed, 7 Nov 2018 15:08:53 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 8B37E6B0515; Wed, 7 Nov 2018 10:08:52 -0500 (EST) Delivered-To: linux-mm-outgoing@kvack.org Received: by kanga.kvack.org (Postfix, from userid 40) id 864AB6B0517; Wed, 7 Nov 2018 10:08:52 -0500 (EST) 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 705276B0518; Wed, 7 Nov 2018 10:08:52 -0500 (EST) X-Original-To: linux-mm@kvack.org X-Delivered-To: linux-mm@kvack.org Received: from mail-pf1-f197.google.com (mail-pf1-f197.google.com [209.85.210.197]) by kanga.kvack.org (Postfix) with ESMTP id 29CF86B0515 for ; Wed, 7 Nov 2018 10:08:52 -0500 (EST) Received: by mail-pf1-f197.google.com with SMTP id n22-v6so15541236pff.2 for ; Wed, 07 Nov 2018 07:08:52 -0800 (PST) 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:message-id; bh=ceyGD5QAbjbskzagnBNpeELSfL61qUfTJV7KJGo/UFs=; b=X9gaBpfjl+NQFk2dmyx1kCZBnqCiv1ixNlibw5GV4RDpUFmxG7zlrjlI4C+DOCG5Sr ZAQgvjc5qPxfCTr9c59OFxM88kS2QTvPt+I/cbnl40gIhBRkL2vc4/uo13E3EvjM0KXn CxsiJzpKtoo4rC/KGMP9JWRiUiluTl6CjTcUqRQuLcOMtxVbTG/ZWqmg2EEhq+G8HQCi aAgXDq+E/bzt4sRy0ORKFGiicbD042F12T1jBFZwCGTjP2dW9Tqw2fk/JYlvwtopJFU2 tWRDZB35cJMhDOEG/u67XtRsOnf+vtUnWwUaQfvP5xAPW9zrFcRsOw1GlXkMYywJY6/x 8X8Q== X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of rppt@linux.ibm.com designates 148.163.156.1 as permitted sender) smtp.mailfrom=rppt@linux.ibm.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=ibm.com X-Gm-Message-State: AGRZ1gKjnw6HTu91rpSjkzXAyS0WWQtihkZytsw0dPI1wBRClGgIhRD7 ymcR/f1v5HB2toRAPel1rjPuGVfHpT+LLqWiCGhRX6b4TlAMVgpew6eiJxZHFrytYKvLmirsm2P t/eYsw1WirbvnhDH2Qnh1rrbdzWeiAl7CByeCl9W+UpfzPK5y79xUdHJ1Exft31Kbxg== X-Received: by 2002:a62:1954:: with SMTP id 81-v6mr548467pfz.237.1541603331734; Wed, 07 Nov 2018 07:08:51 -0800 (PST) X-Google-Smtp-Source: AJdET5dOBotPuHGb0cFcWGIVmFLENmglYRmMQSzgKtF1JtsnEE6g43ZBw16EKNk3ANqULk6qcUOB X-Received: by 2002:a62:1954:: with SMTP id 81-v6mr548417pfz.237.1541603330780; Wed, 07 Nov 2018 07:08:50 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1541603330; cv=none; d=google.com; s=arc-20160816; b=uSPJ/CwtYWYLWmbUR1TLQ+/ACEr2najFsKmtYatoE578YsEjUL4Vd9ut387hdrLcLP V3Pb1B1XERmu1h04odDCZ2ltfdGD481eyRTFmV7Btp6Z4F52raa2VVCbFajhId38BGUg 0u03m8DJdrd2RQZuaFTaumV+7XtYlVmpRs1ZImBmk3ptROlFKigw4HPyW7NKBGARWYPJ 92ikVpiwHDhASxrUJ84qFIOYTnv0Upr9nrCrqo42/KT/o881YaCVHe4g55UjEaMXUFAo R6rxFMgitW+ddc1x9w9+21B80iQYegLdpr3EdURwUhZ8/Ism04hIRmghROaLJLHn3HaY DGug== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=message-id:date:subject:cc:to:from; bh=ceyGD5QAbjbskzagnBNpeELSfL61qUfTJV7KJGo/UFs=; b=0hIiQAuJPw7eckYMlnQsGn4f2harQKpjtGxYx7yoOylGjyeSmC5z4KFUV7w8dOiJxm qfwh0PwgAWnPZ/R76Qi4VMNfFNm6pYngYqfCZ/vyYHihMxgIOY9WUsaNPhxG8OVvlfRE +6/szFARyLZBXnAY1gmCv9QWHAobVzvTQgse8Pw9VPOkk47+1a1DvDI3V3bOKQe2EgDM BXa59fQp2oCcHqajxuiiWg2mKeSpjdRbZBXC4fkfOUQsaR2QcmiYHHCFSMnmwZBr0DRd zdzLi7ofHbQ+Zs9UPihijEiF4GNivoPKkk1Man7nfowodgvXjbMS7zyh6OMqMQ3qCQCs dzCw== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of rppt@linux.ibm.com designates 148.163.156.1 as permitted sender) smtp.mailfrom=rppt@linux.ibm.com; dmarc=pass (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 a23-v6si859679pls.322.2018.11.07.07.08.50 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 07 Nov 2018 07:08:50 -0800 (PST) Received-SPF: pass (google.com: domain of rppt@linux.ibm.com designates 148.163.156.1 as permitted sender) client-ip=148.163.156.1; Authentication-Results: mx.google.com; spf=pass (google.com: domain of rppt@linux.ibm.com designates 148.163.156.1 as permitted sender) smtp.mailfrom=rppt@linux.ibm.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=ibm.com Received: from pps.filterd (m0098394.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id wA7F05dM141252 for ; Wed, 7 Nov 2018 10:08:50 -0500 Received: from e06smtp02.uk.ibm.com (e06smtp02.uk.ibm.com [195.75.94.98]) by mx0a-001b2d01.pphosted.com with ESMTP id 2nm0uwmjuu-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Wed, 07 Nov 2018 10:08:49 -0500 Received: from localhost by e06smtp02.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Wed, 7 Nov 2018 15:08:43 -0000 Received: from b06cxnps4075.portsmouth.uk.ibm.com (9.149.109.197) by e06smtp02.uk.ibm.com (192.168.101.132) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; (version=TLSv1/SSLv3 cipher=AES256-GCM-SHA384 bits=256/256) Wed, 7 Nov 2018 15:08:41 -0000 Received: from b06wcsmtp001.portsmouth.uk.ibm.com (b06wcsmtp001.portsmouth.uk.ibm.com [9.149.105.160]) by b06cxnps4075.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id wA7F8e4V9568514 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL); Wed, 7 Nov 2018 15:08:40 GMT Received: from b06wcsmtp001.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 1EDCCA4059; Wed, 7 Nov 2018 15:08:40 +0000 (GMT) Received: from b06wcsmtp001.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id BC1C7A4054; Wed, 7 Nov 2018 15:08:38 +0000 (GMT) Received: from rapoport-lnx (unknown [9.148.8.58]) by b06wcsmtp001.portsmouth.uk.ibm.com (Postfix) with ESMTPS; Wed, 7 Nov 2018 15:08:38 +0000 (GMT) Received: by rapoport-lnx (sSMTP sendmail emulation); Wed, 07 Nov 2018 17:08:38 +0200 From: Mike Rapoport To: Andrew Morton Cc: linux-mm@kvack.org, linux-doc@vger.kernel.org, Mike Rapoport Subject: [PATCH] mm/gup: fix follow_page_mask kernel-doc comment Date: Wed, 7 Nov 2018 17:08:36 +0200 X-Mailer: git-send-email 2.7.4 X-TM-AS-GCONF: 00 x-cbid: 18110715-0008-0000-0000-0000028EA63E X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 18110715-0009-0000-0000-000021F8E645 Message-Id: <1541603316-27832-1-git-send-email-rppt@linux.ibm.com> X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:,, definitions=2018-11-07_12:,, 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=861 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1807170000 definitions=main-1811070135 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 Commit df06b37ffe5a ("mm/gup: cache dev_pagemap while pinning pages") modified the signature of follow_page_mask() function but left the parameter description behind. Update the description to make the code and comments agree again. While on it, update formatting of the return value description to match Documentation/doc-guide/kernel-doc.rst guidelines. Signed-off-by: Mike Rapoport --- mm/gup.c | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/mm/gup.c b/mm/gup.c index f76e77a..aa43620 100644 --- a/mm/gup.c +++ b/mm/gup.c @@ -385,11 +385,17 @@ static struct page *follow_p4d_mask(struct vm_area_struct *vma, * @vma: vm_area_struct mapping @address * @address: virtual address to look up * @flags: flags modifying lookup behaviour - * @page_mask: on output, *page_mask is set according to the size of the page + * @ctx: contains dev_pagemap for %ZONE_DEVICE memory pinning and a + * pointer to output page_mask * * @flags can have FOLL_ flags set, defined in * - * Returns the mapped (struct page *), %NULL if no mapping exists, or + * When getting pages from ZONE_DEVICE memory, the @ctx->pgmap caches + * the device's dev_pagemap metadata to avoid repeating expensive lookups. + * + * On output, the @ctx->page_mask is set according to the size of the page. + * + * Return: the mapped (struct page *), %NULL if no mapping exists, or * an error pointer if there is a mapping to something not represented * by a page descriptor (see also vm_normal_page()). */