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=-8.5 required=3.0 tests=BAYES_00,DKIM_ADSP_CUSTOM_MED, DKIM_INVALID,DKIM_SIGNED,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE, SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham 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 107C5C433E0 for ; Sat, 20 Feb 2021 12:02:21 +0000 (UTC) Received: from hemlock.osuosl.org (smtp2.osuosl.org [140.211.166.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 94ED264EDB for ; Sat, 20 Feb 2021 12:02:20 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 94ED264EDB Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=linux-kernel-mentees-bounces@lists.linuxfoundation.org Received: from localhost (localhost [127.0.0.1]) by hemlock.osuosl.org (Postfix) with ESMTP id 6A69E874DC; Sat, 20 Feb 2021 12:02:20 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from hemlock.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 5vmoyJs57x25; Sat, 20 Feb 2021 12:02:19 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [140.211.9.56]) by hemlock.osuosl.org (Postfix) with ESMTP id A3562874C7; Sat, 20 Feb 2021 12:02:19 +0000 (UTC) Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id 907B5C000A; Sat, 20 Feb 2021 12:02:19 +0000 (UTC) Received: from smtp3.osuosl.org (smtp3.osuosl.org [140.211.166.136]) by lists.linuxfoundation.org (Postfix) with ESMTP id 7E54FC0001 for ; Sat, 20 Feb 2021 12:02:18 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp3.osuosl.org (Postfix) with ESMTP id 6A09D6F55F for ; Sat, 20 Feb 2021 12:02:18 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp3.osuosl.org ([127.0.0.1]) by localhost (smtp3.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id Gei6PENUTYxJ for ; Sat, 20 Feb 2021 12:02:17 +0000 (UTC) Received: by smtp3.osuosl.org (Postfix, from userid 1001) id B208E6F500; Sat, 20 Feb 2021 12:02:17 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.8.0 Received: from mail-pl1-f173.google.com (mail-pl1-f173.google.com [209.85.214.173]) by smtp3.osuosl.org (Postfix) with ESMTPS id E34496F60A for ; Sat, 20 Feb 2021 12:02:16 +0000 (UTC) Received: by mail-pl1-f173.google.com with SMTP id 17so1560560pli.10 for ; Sat, 20 Feb 2021 04:02:16 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=PYn75oOTsCK1wv+wG6RJjEvw1yuvJVUno/JpN+AI5ys=; b=OI4MHEvQ/wRgHvcO2KzDnyInh0WB1yDezlJN10IBMm9fnata2or1Xv4bqd6JAg15h0 68psk5RI8qSNFNuCkb5hnOKPoQz0l73QfZEDy1XfjI8xfaFiVI7bO6hHGQgXvV0hi6A0 bnatR5EuH8N95/qQQP7/t6GuGId+vm93r7qVWhO9wnVskJ3PN2us5DQRwoaJRL4TM/2u 6+QDJss+qSr+0Lb6emHTwB4hooNKoKCvshQ3i0o5pnEgTvIbH1749nhDEpi4Zbp+In0h 0LXLPacJEyjADei5Ii+zn+mlGN8EbF+PszFcw7bfZgAGSleGqbd7IOzRrOlAy9XWHBv3 O1CA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=PYn75oOTsCK1wv+wG6RJjEvw1yuvJVUno/JpN+AI5ys=; b=tfWQh1/LaI52kFg034WxgaiBI0XN6SELb7lwNcanTS0M3ZlUi9Bqul53omDchyc8TL sZX4QlpEyGwg5z50dGZf1CB/r7JCZsICzHlleBBECltTsGvAVTkidYusdTofkMBYQH1g Iq3Rwfgv9NgXK8GXYkDawFu7YPFNRCa6nVwBhx0YNWS/3u7L8DTyKFG1Sgkh3u94iGdN JDEYbNDQBJHKfLUQ4em2qdXYctYyaygVwPA/YB+UoIJR+GiTmgSI5/vKuuHkEOdQNUn2 Tm6gYuWwn2uCN3pM47YfZrvYV2rdP15qf2VL+iJz3Vptux+rYQCwFxb1wPxo6qzKc/Hz 9p9A== X-Gm-Message-State: AOAM530ru+BMVPWj2Ed7VGDdrW6RPkqaGwX0Y0qYEZgHIzE4iA6p6jcr RweQVLA7gQFZIHhek9/5phA= X-Google-Smtp-Source: ABdhPJw8Ulbtwws1WMMTR78vSG9oRFTWz5Ft7TjAAkbmFL4NTAgGjmgHHU90xqXMQ8/8G/Ivg8/+Rg== X-Received: by 2002:a17:90b:ec5:: with SMTP id gz5mr13909019pjb.34.1613822536222; Sat, 20 Feb 2021 04:02:16 -0800 (PST) Received: from localhost.localdomain ([2405:201:9004:6b3c:bf56:7f84:6ce5:cf93]) by smtp.gmail.com with ESMTPSA id ml7sm6567046pjb.28.2021.02.20.04.02.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 20 Feb 2021 04:02:15 -0800 (PST) From: Dwaipayan Ray To: joe@perches.com Date: Sat, 20 Feb 2021 17:32:18 +0530 Message-Id: <20210220120220.32585-1-dwaipayanray1@gmail.com> X-Mailer: git-send-email 2.30.0 MIME-Version: 1.0 Cc: linux-kernel-mentees@lists.linuxfoundation.org, linux-kernel@vger.kernel.org, Dwaipayan Ray Subject: [Linux-kernel-mentees] [PATCH v5 0/2] checkpatch: add verbose mode X-BeenThere: linux-kernel-mentees@lists.linuxfoundation.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: linux-kernel-mentees-bounces@lists.linuxfoundation.org Sender: "Linux-kernel-mentees" Add a new verbose mode to checkpatch. The verbose test descriptions are read from the checkpatch documentation file at `Documentation/dev-tools/checkpatch.rst`. The verbose mode is optional and can be enabled by the flag -v or --verbose. The documentation file is only parsed by checkpatch.pl if the verbose mode is enabled. The verbose mode can not be used together with the --terse option. Changes in v5: - Change the reference format to use absolute links. - Print verbose descriptions only for the first time a message type is encountered. Changes in v4: - Change the type description format - Group the message types by usage - Make handling of --terse with --verbose simpler Changes in v3: - Simplify documentation file parsing in checkpatch - Document a total of 33 message types for checkpatch Changes in v2: - Use .rst Field Lists to specify the type descriptions. - Add a few more type descriptions to documentation. Dwaipayan Ray (2): checkpatch: add verbose mode docs: add documentation for checkpatch Documentation/dev-tools/checkpatch.rst | 526 +++++++++++++++++++++++++ Documentation/dev-tools/index.rst | 1 + scripts/checkpatch.pl | 63 ++- 3 files changed, 587 insertions(+), 3 deletions(-) create mode 100644 Documentation/dev-tools/checkpatch.rst -- 2.30.0 _______________________________________________ Linux-kernel-mentees mailing list Linux-kernel-mentees@lists.linuxfoundation.org https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees