From patchwork Tue Nov 22 08:55:23 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John Ogness X-Patchwork-Id: 24211 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:f944:0:0:0:0:0 with SMTP id q4csp2086514wrr; Tue, 22 Nov 2022 00:59:42 -0800 (PST) X-Google-Smtp-Source: AA0mqf4VFyJRwcaN+RQechU/2y2lYg1Fd0XoQaZYv7WDaQGlv9x9+JPukEVjKsSFXd4k7lZ5FAJI X-Received: by 2002:a05:6a00:4c0b:b0:562:ebc8:6195 with SMTP id ea11-20020a056a004c0b00b00562ebc86195mr3073667pfb.38.1669107582181; Tue, 22 Nov 2022 00:59:42 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1669107582; cv=none; d=google.com; s=arc-20160816; b=Ysvqrj5r6Blrhm5zaHXjEwIW8sBVJDNOqyZYzbyx+LiOYgNwt276Xco1/JP1YKjYNt UeT1sHC6SDoLjYwOZVwJsDlgCmYuL8xznvGqG/N3sVxMeUZYHYMP95oKNNBDSOdbSVOP mafSXBMRGfrrt4GH+6hWZwskiu1hNfvQrzCYO0K/4L0rCvWfVDabdrvXc8pGuSSzu1C4 6CqNcJBjpuJ0lD+eIQov9BQsXlgs7o/1f0rBKEaQT0IPUyyxNzKzFqIpRslsg/nhg5mN Kma2BmSLbzFDE1flHzu8IH4kmuaccqLYLRCm8zO2z3PAGso+Cjh0yUzqcJaabiEed73B Tabw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:mime-version:message-id:date:references :in-reply-to:subject:cc:to:dkim-signature:dkim-signature:from; bh=WHpMFQ3nTDIAnDhdGTOVqww/Tpb7qPsjpJRCRXT0sZg=; b=iBzoUgiEJ/tSTn1nOPYjlMBF2912jy9vP0KBPhknUOXAE6WZwYu2zEQhGJZkfrmTU7 gZabyXB+VfMyOxDB/S/2yv1BMxbWgcmTLFYU+XdUwEpY8R3YSLipGwMf9ERVl4DXO08l Vi2+xdS5F1VFy13ITk/CwjmsKgIl+wRASCOe8366984NC9f05g7gDgM51toyYVn+vw5+ ZY9zLRUXpwAakn40G37/YACOsNzVAWoGcR8bKuAIBCG6BzjIwleVUrjkijshWFF7anZ1 iyjf96SC2blHKBdcoFRySYuheAob62twImLTqje2BYtsYPWsYtx+BsyQLB5BSj4TFLsS lqEg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=e42iyoX1; dkim=neutral (no key) header.i=@linutronix.de header.s=2020e header.b=ONYwZcqC; 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; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id z19-20020a17090a541300b001faf9ba369fsi14958189pjh.164.2022.11.22.00.59.27; Tue, 22 Nov 2022 00:59:42 -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=@linutronix.de header.s=2020 header.b=e42iyoX1; dkim=neutral (no key) header.i=@linutronix.de header.s=2020e header.b=ONYwZcqC; 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; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232509AbiKVIzh (ORCPT + 99 others); Tue, 22 Nov 2022 03:55:37 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56104 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232955AbiKVIzd (ORCPT ); Tue, 22 Nov 2022 03:55:33 -0500 Received: from galois.linutronix.de (Galois.linutronix.de [IPv6:2a0a:51c0:0:12e:550::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 4B09829C88 for ; Tue, 22 Nov 2022 00:55:32 -0800 (PST) From: John Ogness DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020; t=1669107330; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=WHpMFQ3nTDIAnDhdGTOVqww/Tpb7qPsjpJRCRXT0sZg=; b=e42iyoX1Y1pobvlJl/4/5733Fcvpd/RZVQKgYOq8jAqmuFBuvxk85+fhXQjWIH4lCCLzs0 +CxPXp3/j/b5BrtgF4bP81tNXVxk5srbgu+aHXlxjom8xmJkQXvx8wvgdafLdouDf2pilZ tyBQS5SQfQhlEWJbzWhz0cvoT/QRv/90B3W9l5sxQpHyx77ltlEooeCP4a2WaoFnKr0+p6 nGQY3HvQvg/sfukZn9cxwfAO4PYvdC6SseXM8caHxdAF3RUv//XemXdB4oqKUT1mLKiN+f IkVJ37Vi3xiOSrqJr65+nlS/0j6bqtqWLBC2lLRbxJus/Vqg1u8U2AHvXe4/xg== DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020e; t=1669107330; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=WHpMFQ3nTDIAnDhdGTOVqww/Tpb7qPsjpJRCRXT0sZg=; b=ONYwZcqCk+x/QIhXQ3Q/hCg5Yua1/fEFiBBJAQFviouHMZdGgAqRqWRM/EaIBnXJp0UbT5 dgGx3NKb+KgaNpDQ== To: Petr Mladek Cc: Sergey Senozhatsky , Steven Rostedt , linux-kernel@vger.kernel.org, Stephen Rothwell Subject: [PATCH printk] printk: htmldocs: add missing description In-Reply-To: <20221122181052.75618842@canb.auug.org.au> References: <20221122181052.75618842@canb.auug.org.au> Date: Tue, 22 Nov 2022 10:01:23 +0106 Message-ID: <87zgcjpdvo.fsf@jogness.linutronix.de> MIME-Version: 1.0 X-Spam-Status: No, score=-3.9 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,INVALID_DATE_TZ_ABSURD, RCVD_IN_DNSWL_MED,SPF_HELO_NONE,SPF_PASS 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-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1750186151874568994?= X-GMAIL-MSGID: =?utf-8?q?1750186151874568994?= Variable and return descriptions were missing from the SRCU read lock functions. Add them. Signed-off-by: John Ogness --- Fix htmldocs build warning as reported by Stephen [0]. Thanks Stephen! [0] https://lore.kernel.org/lkml/20221122181052.75618842@canb.auug.org.au kernel/printk/printk.c | 2 ++ 1 file changed, 2 insertions(+) diff --git a/kernel/printk/printk.c b/kernel/printk/printk.c index 503d55ccc835..9ec101766471 100644 --- a/kernel/printk/printk.c +++ b/kernel/printk/printk.c @@ -282,6 +282,7 @@ EXPORT_SYMBOL(console_list_unlock); * Use for_each_console_srcu() to iterate the console list * * Context: Any context. + * Return: A cookie to pass to console_srcu_read_unlock(). */ int console_srcu_read_lock(void) { @@ -292,6 +293,7 @@ EXPORT_SYMBOL(console_srcu_read_lock); /** * console_srcu_read_unlock - Unregister an old reader from * the SRCU-protected console list + * @cookie: cookie returned from console_srcu_read_lock() * * Counterpart to console_srcu_read_lock() */