boostorg / boostorg/inspect

Ignoring whole folders with boost-no-inspect files is problematic

Open
#11 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
9
Forks
29
PR merge metrics
No merged PRs in 30d

Description

I worry about using these boost-no-inspect files to prevent scans for whole folders. I think the files themselves are distracting, but moreover, I think it shouldn't be necessary to ignore whole folders.

boost/status has a boost-no-inspect file, for example, but I think it should not. boost_check_library.py should have a license notice, and likewise the xml and xsd files in that folder. I am not a lawyer, but in my understanding everything in Boost which is not automatically generated by another program is by definition "source code", which then needs a license notice.

I think the boost-no-inspect files should not be needed, because the directory structure of Boost is very uniform in all projects and this is enforced. It should be predictable for the inspect tool which directories need to be scanned. I think the inspect tool has a good rule set for this, but it should definitely also ignore also what's in .gitignore, see my other issue.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by tracing how the inspect tool handles boost-no-inspect files and how it could account for .gitignore. Review boost/status, boost_check_library.py, and the XML and XSD files named in the report. Done means the scanner no longer needs whole-folder exclusions while still ignoring generated or gitignored content as intended.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.