Received-SPF: pass (google.com: domain of linux-crypto-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Eric Snowberg <eric.snowberg@oracle.com>
To:     jarkko@kernel.org, zohar@linux.ibm.com
Cc:     dhowells@redhat.com, dwmw2@infradead.org,
        herbert@gondor.apana.org.au, davem@davemloft.net,
        dmitry.kasatkin@gmail.com, paul@paul-moore.com, jmorris@namei.org,
        serge@hallyn.com, pvorel@suse.cz, noodles@fb.com, tiwai@suse.de,
        bp@suse.de, eric.snowberg@oracle.com, kanth.ghatraju@oracle.com,
        konrad.wilk@oracle.com, erpalmer@linux.vnet.ibm.com,
        coxu@redhat.com, keyrings@vger.kernel.org,
        linux-kernel@vger.kernel.org, linux-crypto@vger.kernel.org,
        linux-integrity@vger.kernel.org,
        linux-security-module@vger.kernel.org
Subject: [PATCH v2 02/10] KEYS: Add missing function documentation
Date:   Wed,  7 Dec 2022 12:12:30 -0500
Message-Id: <20221207171238.2945307-3-eric.snowberg@oracle.com>
In-Reply-To: <20221207171238.2945307-1-eric.snowberg@oracle.com>
References: <20221207171238.2945307-1-eric.snowberg@oracle.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?s9KZVafvUgvnV/b4kc8aTSDNn+EzVt3yNlg9sLeLwnuTS+1V/t0Leil5NZoG?=
 =?us-ascii?Q?JM9ahrz8/F8F1LvCJB/ltUw+vAfSuyOHvJ2mRqCVEJnq3L1XvsAzK/X5AzYm?=
 =?us-ascii?Q?xCUuNjCxOutaq386/eC2qSpcxQbnxhJZ4KYzXSYM8HP9KSaU/k6kUYzYPqXe?=
 =?us-ascii?Q?L5jpK5W7Q1OIIUeG+zt3xOWyVSAQToc3Sx+1ILj3hdIPoouui9UY0P/FbI1C?=
 =?us-ascii?Q?kZXxxcUNNBiMw55lRPxCqPausdlcY+p2n7id3vWjaQSM4B4rzF7pg1TvfjMM?=
 =?us-ascii?Q?rrPXbI0VLnUso341SO4QJnEIVv/VncU8Pz6EqXUwLvsFJZV65X1XSR939HNf?=
 =?us-ascii?Q?6THaOXluj/HUrRMuS7W4UfrDsLg9TjHajNyh5rQpr2+xF79TJK9IeJXtiohG?=
 =?us-ascii?Q?aHErlOC/F8ccmT+5R9FIiQGI+8BlzvlN2ez4kiA2tTkzPTgiWWQZDKwR2VDY?=
 =?us-ascii?Q?VjT/4xXhPwUzgJG004uxQzvOEZdxFzmIxGHCGA+/RDgG27lsynnrjaeiuhn9?=
 =?us-ascii?Q?XmDpPcdT4n0fsey8E19LH7JzrY6FCRGG7TrzYSYrZygXI1sk3A3eFp2NE7jK?=
 =?us-ascii?Q?AR/HoA1nR9RRONfOagTTHJDlfl0GYZ2t/vCbaS28xLlZl49TxctgTDvxqRol?=
 =?us-ascii?Q?AMhoSNFhyy77gApyXzDkMqzqOUrQtNX3BH8BQk1ScV10hUMjpQZpKM1ip+S+?=
 =?us-ascii?Q?5idlpZSCxgO9mRGp1ujTp+dZHkGW0OMMvkKn4n7jyKHLECJtPgtxFRKnpgO6?=
 =?us-ascii?Q?FhqmmOlleB9P0kvdLkB9E/MXZC5Yrout2XL5c4uGoDWDjNbnO6gTMGyA3rVL?=
 =?us-ascii?Q?X9XqwFiG2ltlV9FuGqTd0+qUfLG8Njy7JOFEwfs1midDp+ScZvpWMQTl0y9I?=
 =?us-ascii?Q?r3uZmgVsGGYkmw1ObXWE6vTzLkAEe88DJ5sTJqWK2S7ptaZJfOd7m+E6umSm?=
 =?us-ascii?Q?3IBIeqkfU5as0VByuE32PzndtOYDhF2LUntW0N21GQdgsh7ibTPwjK/PCJUJ?=
 =?us-ascii?Q?aw0dDlIJQ1KqwAezUmOtd+eCR0LqFNXtE+HPrgTzrB7I6hcfNXjhK6JyDzvv?=
 =?us-ascii?Q?ZD9anK2QZkN2of/9FpVt5mNBwlxd8C8E9yGW8GKeRPB8ZZw1BrXLwghtUBiw?=
 =?us-ascii?Q?TZGq5sPNxc8FyDO4xqXNMjGDHUTyocvbVqgYYYQMu7a/4jEB+xQKGlRvYhXp?=
 =?us-ascii?Q?5CnUewiVnz4AyFBrYQyI49JzeMZrRb3bb1BIdauGX0ZYgFli185wNCWcnNP7?=
 =?us-ascii?Q?hkucHy4UAsep3hmc8B/DtWr3bZW1z6lvgaSbjoQD2BvdaewOXo4O5S5KTO0z?=
 =?us-ascii?Q?PZVJpVF9CkTNf3qXQaCwqxR4q9MaDuYZCkr3b9WS2jzetS+LyrXnFDU5ilOT?=
 =?us-ascii?Q?YRwKA2wpctPIZqpPksL83GTlVIORnnt/KbZwdd7vdRqI5vw423xoTqasfGhH?=
 =?us-ascii?Q?KsIZ5liO21FYMfzmlkyLZ5I0spdPxr/Z0K2OebaXmYW+CfEpcCoLLCC3tHQH?=
 =?us-ascii?Q?/Xd7uPGu9iSUjqPftVe/oYbcLA64MeYvMoibPuA138SDq2V5fJfo3xPEcKIc?=
 =?us-ascii?Q?EyPsdEw1HsNFUaCF7ksXfYUj03LYnNbeZX3l+9BRVr6HfbHamVgCMWlEvoUf?=
 =?us-ascii?Q?EJ1akvhRcmldO/YaabyjgBI=3D?=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: e92b6910-e9cb-4858-a916-08dad876415d
X-MS-Exchange-CrossTenant-AuthSource: CH2PR10MB4150.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 07 Dec 2022 17:12:44.3568
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: QRxNUJ/4W/0PaImZSjZThgwPenv5TjnNf7IwyuXwAKTqLBzaBhdaUU5oavQuq1Ff+8viu49Yz0BM2duV4O5U+kX9KYGm4INYzd9gmn05c88=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DS7PR10MB5293
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.205,Aquarius:18.0.923,Hydra:6.0.545,FMLib:17.11.122.1
 definitions=2022-12-07_08,2022-12-07_01,2022-06-22_01
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 bulkscore=0 suspectscore=0
 malwarescore=0 phishscore=0 mlxlogscore=999 spamscore=0 adultscore=0
 mlxscore=0 classifier=spam adjust=0 reason=mlx scancount=1
 engine=8.12.0-2210170000 definitions=main-2212070150
X-Proofpoint-GUID: TZMJXBMj5RoaNWkorOTnKHJNiPOq5ykg
X-Proofpoint-ORIG-GUID: TZMJXBMj5RoaNWkorOTnKHJNiPOq5ykg
X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_LOW,
        RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_NONE autolearn=ham
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-crypto.vger.kernel.org>
X-Mailing-List: linux-crypto@vger.kernel.org

Compiling with 'W=1' results in warnings that 'Function parameter or member
not described'

Add the missing parameters for
restrict_link_by_builtin_and_secondary_trusted and
restrict_link_to_builtin_trusted.

Use /* instead of /** for get_builtin_and_secondary_restriction, since
it is a static function.

Signed-off-by: Eric Snowberg <eric.snowberg@oracle.com>
---
 certs/system_keyring.c | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/certs/system_keyring.c b/certs/system_keyring.c
index 5042cc54fa5e..250148298690 100644
--- a/certs/system_keyring.c
+++ b/certs/system_keyring.c
@@ -33,7 +33,11 @@ extern __initconst const unsigned long system_certificate_list_size;
 extern __initconst const unsigned long module_cert_size;
 
 /**
- * restrict_link_to_builtin_trusted - Restrict keyring addition by built in CA
+ * restrict_link_by_builtin_trusted - Restrict keyring addition by built in CA
+ * @dest_keyring: Keyring being linked to.
+ * @type: The type of key being added.
+ * @payload: The payload of the new key.
+ * @restriction_key: A ring of keys that can be used to vouch for the new cert.
  *
  * Restrict the addition of keys into a keyring based on the key-to-be-added
  * being vouched for by a key in the built in system keyring.
@@ -51,6 +55,10 @@ int restrict_link_by_builtin_trusted(struct key *dest_keyring,
 /**
  * restrict_link_by_builtin_and_secondary_trusted - Restrict keyring
  *   addition by both builtin and secondary keyrings
+ * @dest_keyring: Keyring being linked to.
+ * @type: The type of key being added.
+ * @payload: The payload of the new key.
+ * @restrict_key: A ring of keys that can be used to vouch for the new cert.
  *
  * Restrict the addition of keys into a keyring based on the key-to-be-added
  * being vouched for by a key in either the built-in or the secondary system
@@ -75,7 +83,7 @@ int restrict_link_by_builtin_and_secondary_trusted(
 					  secondary_trusted_keys);
 }
 
-/**
+/*
  * Allocate a struct key_restriction for the "builtin and secondary trust"
  * keyring. Only for use in system_trusted_keyring_init().
  */
-- 
2.27.0