[DPDK/DTS Bug 1455] Add support for checking docstring validity

[DPDK/DTS Bug 1455] Add support for checking docstring validity

[bugzilla]

[-- Attachment #1: Type: text/plain, Size: 1046 bytes --]

https://bugs.dpdk.org/show_bug.cgi?id=1455

            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. 

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

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.

[-- Attachment #2: Type: text/html, Size: 2990 bytes --]