From patchwork Mon Jan 2 18:43:49 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Federico Vaga X-Patchwork-Id: 38178 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:4e01:0:0:0:0:0 with SMTP id p1csp4275880wrt; Mon, 2 Jan 2023 10:46:35 -0800 (PST) X-Google-Smtp-Source: AMrXdXuPO4hOgsSwPK1GUi9oMR3FpgVQpKZNEnWDS3nP5A2hwi/ZqXxRt6o06+NKbg3FYI5Y98ub X-Received: by 2002:a05:6a20:93a1:b0:ad:f140:79a3 with SMTP id x33-20020a056a2093a100b000adf14079a3mr12705685pzh.6.1672685195262; Mon, 02 Jan 2023 10:46:35 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1672685195; cv=none; d=google.com; s=arc-20160816; b=JLT5J0GpZB0gu937tWdoZelzVCZ2BN+sHB7FIivmQxYQmgSQJAEMjBrZxTlNcJ7Xvk /kO8F/P8pSkKbvF3NSCYcBZ9gsGOmwXIQQvaSNQGPG09LAEz/dOuCGLhr5EBcsS27dl6 aJiYDR6HUPY34oG5SkjM12cIGrjgAvJ3yT1n8s0Cd7H+G/v0MwFyczJDOYbnBr1T8I9X p/9aPjRMhGMLF2UOS8e55rQHKFnzwrvN8HUXi9Ctd7nfE3/Ce4yjr/UxHm7g8t8sImMt r7bzk6GPrpHDMCedATWaZdqqqmbL6HW3VeabcyeIc3J7SZBkA4E/+ALTvaYlC7d2usD0 j6Lg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=PE2QbDuec+iFICdEPvX1KX5WQKys9UPqNPqt1/TRius=; b=WNvfbA/spSoath3QGI3Gi25S82Ff/EJf/U6/2JMPi8bGxO+H1zP9NFU4gkvcBEKFg0 XmaPNiuuYDlpxbpnH/XTvpCF88cFIPjjX7koIHvwis7pi9qEPu79FU2CA58uE/PpFihW N/K4jDX14XKUWkL6hdSPv8P4DU4suQX1FvKk3tuf6BHd4t8aITHE4dddUcHDOXjipcBE fFXqPRt5qDXS3wjFL8jiH3g27eIVnQjsmdW9oyvOXWHgzVJ/NH9kAyfj+nAUFpJs6ZiB CrWqKiQo8FKTWdVT8tBxU5tXb9UwKaDyo1aclizl/TaZ9tNJR2iOCpxiyGd85k4Oqtdc HiTw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kolabnow.com header.s=dkim20160331 header.b=tTVaFoqI; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id f6-20020a170902ce8600b00186a397324asi33757636plg.373.2023.01.02.10.46.23; Mon, 02 Jan 2023 10:46:35 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@kolabnow.com header.s=dkim20160331 header.b=tTVaFoqI; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233227AbjABSoN (ORCPT + 99 others); Mon, 2 Jan 2023 13:44:13 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:58678 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229964AbjABSoL (ORCPT ); Mon, 2 Jan 2023 13:44:11 -0500 Received: from mx.kolabnow.com (mx.kolabnow.com [212.103.80.153]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 55664BC92; Mon, 2 Jan 2023 10:44:09 -0800 (PST) Received: from localhost (unknown [127.0.0.1]) by mx.kolabnow.com (Postfix) with ESMTP id D4BC340D72; Mon, 2 Jan 2023 19:44:07 +0100 (CET) Authentication-Results: ext-mx-out003.mykolab.com (amavisd-new); dkim=pass (4096-bit key) reason="pass (just generated, assumed good)" header.d=kolabnow.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=kolabnow.com; h= content-transfer-encoding:mime-version:message-id:date:date :subject:subject:from:from:received:received:received; s= dkim20160331; t=1672685045; x=1674499446; bh=PE2QbDuec+iFICdEPvX 1KX5WQKys9UPqNPqt1/TRius=; b=tTVaFoqI6mGYv8yD8vJv9KQ3h+IlXVXEL89 74+C5z71UA5asqkUsnu8tv0nMrcVcDrDx3qsm5j9oLN+jW+DK5u3O1HIHCuBDQO8 xTuZakfM2KG/khjPdHSNETxJZmKGwixPFa52LIrR7sYgNooIrla5q5H1nJwdoRVk SJCIGlaZXKKlbOTnoZ/pEo5izMyAzwS5XxXrhXIPqYZJ/kBV4f2omEaorXficA1M Q5Bv/hJVgFPluF/+RaH7Ac8R0Lryi2qTcm70UFKFhBBDkbK3aSazVw7YQ479k5se kT8rFwppx+PDcMMdkgWTgkeJMjmPGlNo0ik/m1Zx4dBxVrL/KZvHwx1q2UhoFsjI LPSM16Fh6yfBXBj2NR5UFmNUTBwZz/B54d2HR3HGiFLrMkMISkNiDXVEoxHoPS5C DoJMOKDX2118vMxM7nMAvBCZ15o8w7+mgSL/hBLGo1ZCxTFAd/eo+lobohXX5z0Q yCfXiCyv+LNhpEVmme8iz7Z4dEupRbPcupdY/1mizkfl01nse/2rSZi73gYb+SG7 I4U1ATM5699hROcpsKyqyb1m0XOkjpiscKjZoUD/lw0bQZH/6fB7w2QG1h3DL61t NkE2V1+TjracUomgj4UdslnTlnmkPUhnJbQVw45mEVrfpb6VRv5NZtc1wCGVNgK/ wQgfzKJ0= X-Virus-Scanned: amavisd-new at mykolab.com X-Spam-Score: -1.9 X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 Received: from mx.kolabnow.com ([127.0.0.1]) by localhost (ext-mx-out003.mykolab.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id AujhSXFK8cEn; Mon, 2 Jan 2023 19:44:05 +0100 (CET) Received: from int-mx002.mykolab.com (unknown [10.9.13.2]) by mx.kolabnow.com (Postfix) with ESMTPS id 2B2AF40CA1; Mon, 2 Jan 2023 19:44:05 +0100 (CET) Received: from ext-subm002.mykolab.com (unknown [10.9.6.2]) by int-mx002.mykolab.com (Postfix) with ESMTPS id A4D311B6F; Mon, 2 Jan 2023 19:44:04 +0100 (CET) From: Federico Vaga To: Jonathan Corbet , Jens Axboe , Keith Busch , Peter Zijlstra , Andrew Morton , Mark Rutland , Mikulas Patocka , Andy Shevchenko Cc: Federico Vaga , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH] doc: add kernel-doc comment for u64_to_user_ptr Date: Mon, 2 Jan 2023 19:43:49 +0100 Message-Id: <20230102184349.10399-1-federico.vaga@vaga.pv.it> MIME-Version: 1.0 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1753937550992004646?= X-GMAIL-MSGID: =?utf-8?q?1753937550992004646?= Add a kernel-doc comment in kernel.h to document the macro `u64_to_user_ptr`. As of today, this macro is mentioned in the documentation in 'ioctl.rst' and 'botching-up-ioctls.rst' Signed-off-by: Federico Vaga --- include/linux/kernel.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/include/linux/kernel.h b/include/linux/kernel.h index fe6efb24d151..8bcd126f64f2 100644 --- a/include/linux/kernel.h +++ b/include/linux/kernel.h @@ -56,6 +56,10 @@ #define PTR_IF(cond, ptr) ((cond) ? (ptr) : NULL) +/** + * u64_to_user_ptr - convert an unsigned 64bit number into a user pointer + * @x: the number to convert + */ #define u64_to_user_ptr(x) ( \ { \ typecheck(u64, (x)); \