Re: Convert manpages to rst format

[Tedd Ho-Jeong An <hj.tedd.an@gmail.com>]

On Tue, 2021-05-04 at 11:58 -0700, Luiz Augusto von Dentz wrote:
> Hi Tedd,
> 
> On Tue, May 4, 2021 at 11:25 AM Tedd Ho-Jeong An <hj.tedd.an@gmail.com> wrote:
> > Hi
> > 
> > On Tue, 2021-05-04 at 01:44 -0700, bluez.test.bot@gmail.com wrote:
> > > This is automated email and please do not reply to this email!
> > > 
> > > Dear submitter,
> > > 
> > > Thank you for submitting the patches to the linux bluetooth mailing list.
> > > This is a CI test results with your patch series:
> > > PW Link:https://patchwork.kernel.org/project/bluetooth/list/?series=476657
> > > 
> > > ---Test result---
> > > 
> > > Test Summary:
> > > CheckPatch                    FAIL      1.09 seconds
> > > GitLint                       PASS      0.49 seconds
> > > Prep - Setup ELL              PASS      48.06 seconds
> > > Build - Prep                  PASS      0.11 seconds
> > > Build - Configure             PASS      8.27 seconds
> > > Build - Make                  PASS      205.97 seconds
> > > Make Check                    PASS      9.56 seconds
> > > Make Dist                     PASS      13.28 seconds
> > > Make Dist - Configure         PASS      5.14 seconds
> > > Make Dist - Make              PASS      82.48 seconds
> > > Build w/ext ELL - Configure   PASS      8.44 seconds
> > > Build w/ext ELL - Make        PASS      191.12 seconds
> > > 
> > > Details
> > > ##############################
> > > Test: CheckPatch - FAIL
> > > Desc: Run checkpatch.pl script with rule in .checkpatch.conf
> > > Output:
> > > monitor: Convert manpage to rst format
> > > WARNING:SPDX_LICENSE_TAG: Missing or malformed SPDX-License-Identifier tag in line 1
> > > #125: FILE: monitor/btmon.rst:1:
> > > +=====
> > > 
> > > - total: 0 errors, 1 warnings, 224 lines checked
> > > 
> > > NOTE: For some of the reported defects, checkpatch may be able to
> > >       mechanically convert to the typical style using --fix or --fix-inplace.
> > > 
> > > "[PATCH] monitor: Convert manpage to rst format" has style problems, please review.
> > > 
> > > NOTE: Ignored message types: COMMIT_MESSAGE COMPLEX_MACRO CONST_STRUCT FILE_PATH_CHANGES MISSING_SIGN_OFF PREFER_PACKED SPLIT_STRING SSCANF_TO_KSTRTO
> > > 
> > > NOTE: If any of the errors are false positives, please report
> > >       them to the maintainer, see CHECKPATCH in MAINTAINERS.
> > > 
> > > tools: Convert manpages to rst format
> > > WARNING:SPDX_LICENSE_TAG: Missing or malformed SPDX-License-Identifier tag in line 1
> > > #111: FILE: tools/bdaddr.rst:1:
> > > +======
> > > 
> > These errors can be ignored since no SPDX header is needed in the manpage file. Also
> > even if the SPDX license header is added, the checkpatch cannot parse .rst file and
> > still shows a warning.
> 
> Isn't there a way to make checkpatch ignore those then? I can apply
> them either way but going forward it would be great to avoid having
> these errors.
> 

Yes, there is a flag SPDX_LICENSE_TAG to turn off this check.
I will turn this off this then.

> > > WARNING:SPDX_LICENSE_TAG: Missing or malformed SPDX-License-Identifier tag in line 1
> > > #252: FILE: tools/btattach.rst:1:
> > > +========
> > > 
> > > WARNING:SPDX_LICENSE_TAG: Missing or malformed SPDX-License-Identifier tag in line 1
> > > #411: FILE: tools/ciptool.rst:1:
> > > +========
> > > 
> > > WARNING:SPDX_LICENSE_TAG: Missing or malformed SPDX-License-Identifier tag in line 1
> > > #652: FILE: tools/hciattach.rst:1:
> > > +=========
> > > 
> > > WARNING:SPDX_LICENSE_TAG: Missing or malformed SPDX-License-Identifier tag in line 1
> > > #1102: FILE: tools/hciconfig.rst:1:
> > > +=========
> > > 
> > > WARNING:SPDX_LICENSE_TAG: Missing or malformed SPDX-License-Identifier tag in line 1
> > > #1503: FILE: tools/hcidump.rst:1:
> > > +=======
> > > 
> > > WARNING:SPDX_LICENSE_TAG: Missing or malformed SPDX-License-Identifier tag in line 1
> > > #1889: FILE: tools/hcitool.rst:1:
> > > +=======
> > > 
> > > WARNING:SPDX_LICENSE_TAG: Missing or malformed SPDX-License-Identifier tag in line 1
> > > #2160: FILE: tools/hid2hci.rst:1:
> > > +========
> > > 
> > > WARNING:SPDX_LICENSE_TAG: Missing or malformed SPDX-License-Identifier tag in line 1
> > > #2298: FILE: tools/l2ping.rst:1:
> > > +======
> > > 
> > > WARNING:SPDX_LICENSE_TAG: Missing or malformed SPDX-License-Identifier tag in line 1
> > > #2469: FILE: tools/rctest.rst:1:
> > > +======
> > > 
> > > WARNING:SPDX_LICENSE_TAG: Missing or malformed SPDX-License-Identifier tag in line 1
> > > #2675: FILE: tools/rfcomm.rst:1:
> > > +======
> > > 
> > > WARNING:SPDX_LICENSE_TAG: Missing or malformed SPDX-License-Identifier tag in line 1
> > > #2919: FILE: tools/sdptool.rst:1:
> > > +=======
> > > 
> > > - total: 0 errors, 12 warnings, 1414 lines checked
> > > 
> > > NOTE: For some of the reported defects, checkpatch may be able to
> > >       mechanically convert to the typical style using --fix or --fix-inplace.
> > > 
> > > "[PATCH] tools: Convert manpages to rst format" has style problems, please review.
> > > 
> > > NOTE: Ignored message types: COMMIT_MESSAGE COMPLEX_MACRO CONST_STRUCT FILE_PATH_CHANGES MISSING_SIGN_OFF PREFER_PACKED SPLIT_STRING SSCANF_TO_KSTRTO
> > > 
> > > NOTE: If any of the errors are false positives, please report
> > >       them to the maintainer, see CHECKPATCH in MAINTAINERS.
> > > 
> > > 
> > > ##############################
> > > Test: GitLint - PASS
> > > Desc: Run gitlint with rule in .gitlint
> > > 
> > > ##############################
> > > Test: Prep - Setup ELL - PASS
> > > Desc: Clone, build, and install ELL
> > > 
> > > ##############################
> > > Test: Build - Prep - PASS
> > > Desc: Prepare environment for build
> > > 
> > > ##############################
> > > Test: Build - Configure - PASS
> > > Desc: Configure the BlueZ source tree
> > > 
> > > ##############################
> > > Test: Build - Make - PASS
> > > Desc: Build the BlueZ source tree
> > > 
> > > ##############################
> > > Test: Make Check - PASS
> > > Desc: Run 'make check'
> > > 
> > > ##############################
> > > Test: Make Dist - PASS
> > > Desc: Run 'make dist' and build the distribution tarball
> > > 
> > > ##############################
> > > Test: Make Dist - Configure - PASS
> > > Desc: Configure the source from distribution tarball
> > > 
> > > ##############################
> > > Test: Make Dist - Make - PASS
> > > Desc: Build the source from distribution tarball
> > > 
> > > ##############################
> > > Test: Build w/ext ELL - Configure - PASS
> > > Desc: Configure BlueZ source with '--enable-external-ell' configuration
> > > 
> > > ##############################
> > > Test: Build w/ext ELL - Make - PASS
> > > Desc: Build BlueZ source with '--enable-external-ell' configuration
> > > 
> > > 
> > > 
> > > ---
> > > Regards,
> > > Linux Bluetooth
> > > 
> > 
> > Regards,
> > Tedd
> > 
> 
>