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=-16.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=unavailable 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 03311C43460 for ; Mon, 17 May 2021 04:00:45 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id D5B646100A for ; Mon, 17 May 2021 04:00:44 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229674AbhEQEB6 (ORCPT ); Mon, 17 May 2021 00:01:58 -0400 Received: from mail.loongson.cn ([114.242.206.163]:35208 "EHLO loongson.cn" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S229452AbhEQEB5 (ORCPT ); Mon, 17 May 2021 00:01:57 -0400 Received: from linux.localdomain (unknown [113.200.148.30]) by mail.loongson.cn (Coremail) with SMTP id AQAAf9Ax7chk6qFgYAoYAA--.31444S2; Mon, 17 May 2021 12:00:37 +0800 (CST) From: Tiezhu Yang To: Jonathan Corbet , Joe Perches , Dwaipayan Ray , Lukas Bulwahn Cc: linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org Subject: [PATCH] Documentation: checkpatch: add description if no filenames are given Date: Mon, 17 May 2021 12:00:36 +0800 Message-Id: <1621224036-32092-1-git-send-email-yangtiezhu@loongson.cn> X-Mailer: git-send-email 2.1.0 X-CM-TRANSID: AQAAf9Ax7chk6qFgYAoYAA--.31444S2 X-Coremail-Antispam: 1UD129KBjvJXoW7Xw4Dtw4xXryUuFyfJrykuFg_yoW8Jr4xpa n5GrySgrZ8GryrX34jv3WxWFyfAaykXFZ8GF1vgF15tFZ8Xa9aqryfKw1Yy3W7CFWrCa9I vr48Xr9avF1jvFDanT9S1TB71UUUUUUqnTZGkaVYY2UrUUUUjbIjqfuFe4nvWSU5nxnvy2 9KBjDU0xBIdaVrnRJUUUkIb7Iv0xC_Kw4lb4IE77IF4wAFF20E14v26r1j6r4UM7CY07I2 0VC2zVCF04k26cxKx2IYs7xG6rWj6s0DM7CIcVAFz4kK6r1j6r18M28lY4IEw2IIxxk0rw A2F7IY1VAKz4vEj48ve4kI8wA2z4x0Y4vE2Ix0cI8IcVAFwI0_Xr0_Ar1l84ACjcxK6xII jxv20xvEc7CjxVAFwI0_Gr0_Cr1l84ACjcxK6I8E87Iv67AKxVW8Jr0_Cr1UM28EF7xvwV C2z280aVCY1x0267AKxVW0oVCq3wAS0I0E0xvYzxvE52x082IY62kv0487Mc02F40EFcxC 0VAKzVAqx4xG6I80ewAv7VC0I7IYx2IY67AKxVWUJVWUGwAv7VC2z280aVAFwI0_Gr0_Cr 1lOx8S6xCaFVCjc4AY6r1j6r4UM4x0Y48IcxkI7VAKI48JMxkIecxEwVAFwVW8XwCF04k2 0xvY0x0EwIxGrwCFx2IqxVCFs4IE7xkEbVWUJVW8JwC20s026c02F40E14v26r1j6r18MI 8I3I0E7480Y4vE14v26r106r1rMI8E67AF67kF1VAFwI0_JF0_Jw1lIxkGc2Ij64vIr41l IxAIcVC0I7IYx2IY67AKxVWUJVWUCwCI42IY6xIIjxv20xvEc7CjxVAFwI0_Jr0_Gr1lIx AIcVCF04k26cxKx2IYs7xG6rW3Jr0E3s1lIxAIcVC2z280aVAFwI0_Jr0_Gr1lIxAIcVC2 z280aVCY1x0267AKxVW8JVW8JrUvcSsGvfC2KfnxnUUI43ZEXa7IUY8-PUUUUUU== X-CM-SenderInfo: p1dqw3xlh2x3gn0dqz5rrqw2lrqou0/ Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org After commit 45107ff6d526 ("checkpatch: if no filenames then read stdin"), if no filenames are given, it will read patch from stdin rather than exit directly, it is a bit confusing whether the script hangs, I do not quite know what to do next util I understand the code logic. At the beginning, I want to print some info if no filenames are given [1], but as Joe Perches said, this is unnecessary. It's like trying to make cat without command line arguments emit something. So as Lukas Bulwahn suggested, add description for somebody that actually reads the available kernel documentation on checkpatch. [1] https://lore.kernel.org/patchwork/patch/1429026/ Signed-off-by: Tiezhu Yang --- Documentation/dev-tools/checkpatch.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst index 51fed1b..181b95e 100644 --- a/Documentation/dev-tools/checkpatch.rst +++ b/Documentation/dev-tools/checkpatch.rst @@ -210,6 +210,8 @@ Available options: Display the help text. +When FILE is -, or no filenames are given, read standard input. + Message Levels ============== -- 2.1.0