From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-13.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id C6DC8C433E0 for ; Mon, 15 Feb 2021 21:07:24 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id 69DCA64DF0 for ; Mon, 15 Feb 2021 21:07:24 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 69DCA64DF0 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linux.ibm.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id 01AB48D0143; Mon, 15 Feb 2021 16:07:24 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id F0E748D0140; Mon, 15 Feb 2021 16:07:23 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id DFD2E8D0143; Mon, 15 Feb 2021 16:07:23 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0002.hostedemail.com [216.40.44.2]) by kanga.kvack.org (Postfix) with ESMTP id C94318D0140 for ; Mon, 15 Feb 2021 16:07:23 -0500 (EST) Received: from smtpin10.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay05.hostedemail.com (Postfix) with ESMTP id 93F73182AE8AF for ; Mon, 15 Feb 2021 21:07:23 +0000 (UTC) X-FDA: 77821737966.10.snake37_4304dd32763e Received: from filter.hostedemail.com (10.5.16.251.rfc1918.com [10.5.16.251]) by smtpin10.hostedemail.com (Postfix) with ESMTP id 706BD16A4D8 for ; Mon, 15 Feb 2021 21:07:23 +0000 (UTC) X-HE-Tag: snake37_4304dd32763e X-Filterd-Recvd-Size: 5725 Received: from mx0b-001b2d01.pphosted.com (mx0b-001b2d01.pphosted.com [148.163.158.5]) by imf27.hostedemail.com (Postfix) with ESMTP for ; Mon, 15 Feb 2021 21:07:22 +0000 (UTC) Received: from pps.filterd (m0127361.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.42/8.16.0.42) with SMTP id 11FL2P5O082113; Mon, 15 Feb 2021 16:07:17 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ibm.com; h=date : from : to : cc : subject : message-id : references : mime-version : content-type : in-reply-to; s=pp1; bh=rlKvYgdWm39AnCGIAPVdu/6unMT0+MsaSQ/ZBnPTpn0=; b=IEoYE8UtPoP+lBrwHS4aeliEjQ2dgVncc7gOKd7ZHA5Fni55ObMXLGJLMfjQy18Mm9v5 GOw+FO1ocNCPZxK4eeygs+4VxuVCK9xj4cUSguvlZxc448NKjz7gvXXs9eT8Iw6tRJVL jrXHPHeb26LHeYLLbLDJwyWcOArSIIQysvpmj1kqBM6NwxSPJRpKtaFEfxkGO6UAFogw 8mI1dVAf8AbSu7CtAaFVFq6IpT9TpnUpKWdHt2IS/Qc8uo7i6GsD66OQMPl6AaHsIkd1 1uED8arhBvjwAUy3H18DLG2OmemWJife+MviKXuwGlwqRaVcScN9t/I3T207QVPRXr02 0Q== Received: from ppma04ams.nl.ibm.com (63.31.33a9.ip4.static.sl-reverse.com [169.51.49.99]) by mx0a-001b2d01.pphosted.com with ESMTP id 36r07wgg50-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Mon, 15 Feb 2021 16:07:17 -0500 Received: from pps.filterd (ppma04ams.nl.ibm.com [127.0.0.1]) by ppma04ams.nl.ibm.com (8.16.0.42/8.16.0.42) with SMTP id 11FL4A29019014; Mon, 15 Feb 2021 21:07:14 GMT Received: from b06cxnps4074.portsmouth.uk.ibm.com (d06relay11.portsmouth.uk.ibm.com [9.149.109.196]) by ppma04ams.nl.ibm.com with ESMTP id 36p6d8a6e4-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Mon, 15 Feb 2021 21:07:14 +0000 Received: from d06av23.portsmouth.uk.ibm.com (d06av23.portsmouth.uk.ibm.com [9.149.105.59]) by b06cxnps4074.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id 11FL7CtR36110800 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Mon, 15 Feb 2021 21:07:12 GMT Received: from d06av23.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 1236FA4051; Mon, 15 Feb 2021 21:07:12 +0000 (GMT) Received: from d06av23.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 14654A4059; Mon, 15 Feb 2021 21:07:11 +0000 (GMT) Received: from linux.ibm.com (unknown [9.145.156.52]) by d06av23.portsmouth.uk.ibm.com (Postfix) with ESMTPS; Mon, 15 Feb 2021 21:07:10 +0000 (GMT) Date: Mon, 15 Feb 2021 23:07:08 +0200 From: Mike Rapoport To: "Matthew Wilcox (Oracle)" Cc: Andrew Morton , linux-mm@kvack.org Subject: Re: [PATCH] mm/gfp: Add kernel-doc for gfp_t Message-ID: <20210215210708.GT299309@linux.ibm.com> References: <20210215204909.3824509-1-willy@infradead.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20210215204909.3824509-1-willy@infradead.org> X-TM-AS-GCONF: 00 X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.369,18.0.761 definitions=2021-02-15_16:2021-02-12,2021-02-15 signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 bulkscore=0 adultscore=0 mlxlogscore=900 spamscore=0 malwarescore=0 impostorscore=0 phishscore=0 mlxscore=0 suspectscore=0 lowpriorityscore=0 clxscore=1015 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2009150000 definitions=main-2102150156 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: On Mon, Feb 15, 2021 at 08:49:09PM +0000, Matthew Wilcox (Oracle) wrote: > The generated html will link to the definition of the gfp_t automatically > once we define it. Move the one-paragraph overview of GFP flags from the > documentation directory into gfp.h and pull gfp.h into the documentation. > > Signed-off-by: Matthew Wilcox (Oracle) Acked-by: Mike Rapoport > --- > Documentation/core-api/mm-api.rst | 7 ++----- > include/linux/gfp.h | 11 +++++++++++ > 2 files changed, 13 insertions(+), 5 deletions(-) > > diff --git a/Documentation/core-api/mm-api.rst b/Documentation/core-api/mm-api.rst > index 2adffb3f7914..201b5423303b 100644 > --- a/Documentation/core-api/mm-api.rst > +++ b/Documentation/core-api/mm-api.rst > @@ -19,11 +19,8 @@ User Space Memory Access > Memory Allocation Controls > ========================== > > -Functions which need to allocate memory often use GFP flags to express > -how that memory should be allocated. The GFP acronym stands for "get > -free pages", the underlying memory allocation function. Not every GFP > -flag is allowed to every function which may allocate memory. Most > -users will want to use a plain ``GFP_KERNEL``. > +.. kernel-doc:: include/linux/gfp.h > + :internal: > > .. kernel-doc:: include/linux/gfp.h > :doc: Page mobility and placement hints > diff --git a/include/linux/gfp.h b/include/linux/gfp.h > index 52cd415b436c..ecd1b5d27936 100644 > --- a/include/linux/gfp.h > +++ b/include/linux/gfp.h > @@ -8,6 +8,17 @@ > #include > #include > > +/** > + * typedef gfp_t - Memory allocation flags. > + * > + * GFP flags are commonly used throughout Linux to indicate how memory > + * should be allocated. The GFP acronym stands for "get free pages", > + * the underlying memory allocation function. Not every GFP flag is > + * supported by every function which may allocate memory. Most users > + * will want to use a plain ``GFP_KERNEL``. > + */ > +typedef unsigned int __bitwise gfp_t; // repeated here for kernel-doc > + > struct vm_area_struct; > > /* > -- > 2.29.2 > -- Sincerely yours, Mike.