From patchwork Sat Nov 4 04:20:44 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 161532 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:8f47:0:b0:403:3b70:6f57 with SMTP id j7csp1458749vqu; Fri, 3 Nov 2023 21:21:00 -0700 (PDT) X-Google-Smtp-Source: AGHT+IHSR5LVPDmBW8Hfge0mk+aOnyo2nuvWJFcgFsspRkhFO59A0JDMy7BUATkahDpS0CDqG8Sy X-Received: by 2002:a0d:ca49:0:b0:5a7:ba54:af02 with SMTP id m70-20020a0dca49000000b005a7ba54af02mr5139064ywd.38.1699071659651; Fri, 03 Nov 2023 21:20:59 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1699071659; cv=none; d=google.com; s=arc-20160816; b=i6S3pFhL0nevQfkDPTFrIQhn4V+Fg4K2k9x9nKditj5U+dg3/qKcw0yzwWTgVaDb4F 8jzYTSt+e0nMMMQ15m+9lVvlyiKZtXZGHKE/tnoVspJLSAJ6DyxCFKKw+Ng1gHEpo9o9 hm9oQtl1TAWJGtu49g/OGTAxeRXGdGjOY3+z0zjerX8i6geMEhIp7sacFq0F+tDjcRCP /r4FWroxmOydjRksRBcI9Bzd6QTA5G+ExO1MZ+sD41PBhykiks0e+EG30zcTKSwpVi7p M/ZFEQJZm4PthqaEZjl8l77UJG+L3H1Ocyrj98PfKDNNzvpc1/1ITgXkIDYsE0wLLjml tt0Q== 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=4xGq+RomEZH3DZvdz2VHIN1h6fcnWJicNhvkTuIdRC8=; fh=arDBqiz04l+5WHq+xmxbRsbCiBolyHOhnEeVFHJSQ5k=; b=aVC4nwCJqGswuYpas8V2mOSjax225o48pmmWanXZP+KiCkrSwbLKB9oLaXlKzr5WCd Zbv+Qpz42gMmYZlhZQmPpf0X4WTfgQ2GSc8PVOOYipIxv9WZytUnw9crWjsdbji/80xO 2vYc61fNKjhx0Yxkh+Nap9lNAIZjBkqFVRz7xqcsWY4HsKzu29WpG6YyzZ1+qpmXROfU wtBZHIu7yocfxbgpCYtQ354f6ZuMk8gYhpdMca4h/rAak+C8flHQfXnCsKA0uEeT1a1T B/6fXSJWDR6AXyRD3m+DIsuV6JSU8Gawphr6gDIo+2V0BzpjxslDBtHNldFl6UpCVpx0 NzKA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=Nl4ZYr0L; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from snail.vger.email (snail.vger.email. [23.128.96.37]) by mx.google.com with ESMTPS id f11-20020a056a00228b00b006b91e0fc586si3174580pfe.66.2023.11.03.21.20.59 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 03 Nov 2023 21:20:59 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) client-ip=23.128.96.37; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=Nl4ZYr0L; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by snail.vger.email (Postfix) with ESMTP id 7D0278029DD6; Fri, 3 Nov 2023 21:20:58 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at snail.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231486AbjKDEUx (ORCPT + 35 others); Sat, 4 Nov 2023 00:20:53 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36678 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229509AbjKDEUv (ORCPT ); Sat, 4 Nov 2023 00:20:51 -0400 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 11140D44; Fri, 3 Nov 2023 21:20:49 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=4xGq+RomEZH3DZvdz2VHIN1h6fcnWJicNhvkTuIdRC8=; b=Nl4ZYr0LZCWCk5uL/pzbkcuRh8 vMVseyrI1XyoINQzkJo80DKS3TEeoIEftWLfbc/zbDibdcTNz4SoLTS8jUDkWw6lF7TtzjUzXrWG2 BnRqey/L3ADb6SAuOEEmP603GRQQqqcRTffawia+Zl8uG4Adz1G/yFkTtA77nT5qb7w59dJV6wRvh X43i3PqvVGuBD4VJNBhdvUcKVTvFF/w9odc47tMlmpsVKZk6lICUmJLrAQD4a9Z/R8IQaCkeVSrzy f+jwRaGr8TDod+ZW7Ni/UrELu4h/bGx4tvmtzZJBdP+YSnORlBZmgNNH48MQCcyTcf5BSvpf7lU3M /a6tlwwQ==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1qz89N-00Cbnr-1I; Sat, 04 Nov 2023 04:20:47 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Luis Chamberlain , linux-modules@vger.kernel.org Subject: [PATCH] lib/test_kmod: fix kernel-doc warnings Date: Fri, 3 Nov 2023 21:20:44 -0700 Message-ID: <20231104042044.17807-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.42.0 MIME-Version: 1.0 X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_BLOCKED, SPF_HELO_NONE,SPF_NONE,T_SCC_BODY_TEXT_LINE,URIBL_BLOCKED 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: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (snail.vger.email [0.0.0.0]); Fri, 03 Nov 2023 21:20:58 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1781605764512668708 X-GMAIL-MSGID: 1781605764512668708 Fix all kernel-doc warnings in test_kmod.c: - Mark some enum values as private so that kernel-doc is not needed for them - s/thread_mutex/thread_lock/ in a struct's kernel-doc comments - add kernel-doc info for @task_sync test_kmod.c:67: warning: Enum value '__TEST_KMOD_INVALID' not described in enum 'kmod_test_case' test_kmod.c:67: warning: Enum value '__TEST_KMOD_MAX' not described in enum 'kmod_test_case' test_kmod.c:100: warning: Function parameter or member 'task_sync' not described in 'kmod_test_device_info' test_kmod.c:134: warning: Function parameter or member 'thread_mutex' not described in 'kmod_test_device' Signed-off-by: Randy Dunlap Cc: Luis Chamberlain Cc: linux-modules@vger.kernel.org --- lib/test_kmod.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff -- a/lib/test_kmod.c b/lib/test_kmod.c --- a/lib/test_kmod.c +++ b/lib/test_kmod.c @@ -58,11 +58,14 @@ static int num_test_devs; * @need_mod_put for your tests case. */ enum kmod_test_case { + /* private: */ __TEST_KMOD_INVALID = 0, + /* public: */ TEST_KMOD_DRIVER, TEST_KMOD_FS_TYPE, + /* private: */ __TEST_KMOD_MAX, }; @@ -82,6 +85,7 @@ struct kmod_test_device; * @ret_sync: return value if request_module() is used, sync request for * @TEST_KMOD_DRIVER * @fs_sync: return value of get_fs_type() for @TEST_KMOD_FS_TYPE + * @task_sync: kthread's task_struct or %NULL if not running * @thread_idx: thread ID * @test_dev: test device test is being performed under * @need_mod_put: Some tests (get_fs_type() is one) requires putting the module @@ -108,7 +112,7 @@ struct kmod_test_device_info { * @dev: pointer to misc_dev's own struct device * @config_mutex: protects configuration of test * @trigger_mutex: the test trigger can only be fired once at a time - * @thread_lock: protects @done count, and the @info per each thread + * @thread_mutex: protects @done count, and the @info per each thread * @done: number of threads which have completed or failed * @test_is_oom: when we run out of memory, use this to halt moving forward * @kthreads_done: completion used to signal when all work is done