From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id CA87444161; Wed, 5 Jun 2024 19:41:28 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 9B0A3402E1; Wed, 5 Jun 2024 19:41:28 +0200 (CEST) Received: from inbox.dpdk.org (inbox.dpdk.org [95.142.172.178]) by mails.dpdk.org (Postfix) with ESMTP id 31F5840265 for ; Wed, 5 Jun 2024 19:41:27 +0200 (CEST) Received: by inbox.dpdk.org (Postfix, from userid 33) id 275D644164; Wed, 5 Jun 2024 19:41:27 +0200 (CEST) From: bugzilla@dpdk.org To: dev@dpdk.org Subject: [DPDK/DTS Bug 1455] Add support for checking docstring validity Date: Wed, 05 Jun 2024 17:41:27 +0000 X-Bugzilla-Reason: AssignedTo X-Bugzilla-Type: new X-Bugzilla-Watch-Reason: None X-Bugzilla-Product: DPDK X-Bugzilla-Component: DTS X-Bugzilla-Version: 24.07 X-Bugzilla-Keywords: X-Bugzilla-Severity: minor X-Bugzilla-Who: probb@iol.unh.edu X-Bugzilla-Status: UNCONFIRMED X-Bugzilla-Resolution: X-Bugzilla-Priority: Normal X-Bugzilla-Assigned-To: dev@dpdk.org X-Bugzilla-Target-Milestone: --- X-Bugzilla-Flags: X-Bugzilla-Changed-Fields: bug_id short_desc product version rep_platform op_sys bug_status bug_severity priority component assigned_to reporter cc target_milestone Message-ID: Content-Type: multipart/alternative; boundary=17176092870.ccFEa6a8.2704699 Content-Transfer-Encoding: 7bit X-Bugzilla-URL: http://bugs.dpdk.org/ Auto-Submitted: auto-generated X-Auto-Response-Suppress: All MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org --17176092870.ccFEa6a8.2704699 Date: Wed, 5 Jun 2024 19:41:27 +0200 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable X-Bugzilla-URL: http://bugs.dpdk.org/ Auto-Submitted: auto-generated X-Auto-Response-Suppress: All https://bugs.dpdk.org/show_bug.cgi?id=3D1455 Bug ID: 1455 Summary: Add support for checking docstring validity Product: DPDK Version: 24.07 Hardware: All OS: All Status: UNCONFIRMED Severity: minor Priority: Normal Component: DTS Assignee: dev@dpdk.org Reporter: probb@iol.unh.edu CC: juraj.linkes@pantheon.tech, probb@iol.unh.edu Target Milestone: --- DTS is using the Google docstring format, but there is no check in dts-check-format.sh for function docstring validity.=20 As the docstring requirement is universal, add some check to this script wh= ich will flag patches which are not adding the required docstrings for new functions, or are adding them without following the valid google format.=20 Search to see if there is a 3rd party tool which checks this already for the google format. --=20 You are receiving this mail because: You are the assignee for the bug.= --17176092870.ccFEa6a8.2704699 Date: Wed, 5 Jun 2024 19:41:27 +0200 MIME-Version: 1.0 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable X-Bugzilla-URL: http://bugs.dpdk.org/ Auto-Submitted: auto-generated X-Auto-Response-Suppress: All
Bug ID 1455
Summary Add support for checking docstring validity
Product DPDK
Version 24.07
Hardware All
OS All
Status UNCONFIRMED
Severity minor
Priority Normal
Component DTS
Assignee dev@dpdk.org
Reporter probb@iol.unh.edu
CC juraj.linkes@pantheon.tech, probb@iol.unh.edu
Target Milestone --- 

DTS is using the Google docstring =
format, but there is no check in
dts-check-format.sh for function docstring validity.=20

As the docstring requirement is universal, add some check to this script wh=
ich
will flag patches which are not adding the required docstrings for new
functions, or are adding them without following the valid google format.=20

Search to see if there is a 3rd party tool which checks this already for the
google format.

You are receiving this mail because:
  • You are the assignee for the bug.
=20=20=20=20=20=20=20=20=20=20
= --17176092870.ccFEa6a8.2704699--