C++: Create tests readme. - #4719
Conversation
|
Who am I supposed to @ mention for a docs review? |
That's @hubwriter, according to CODEOWNERS. When you mark your PR as ready for review, CODEOWNERS (and the C team) will start getting notifications for this PR. There is no code owner of |
hubwriter
left a comment
hubwriter
left a comment
There was a problem hiding this comment.
This looks good.
I've made a few suggestions. Feel free to ignore these, of course.
| - ISO/IEC Programming languages - C (all versions) | ||
| - ISO/IEC Programming languages - C++ (all versions) |
There was a problem hiding this comment.
I wasn't initially sure what these referred to. Maybe link "ISO/IEC Programming languages - C" to:
https://www.iso.org/standard/74528.html or https://www.iso.org/search.html?q=ISO/IEC%209899
and "ISO/IEC Programming languages - C++" to:
https://www.iso.org/standard/68564.html or https://www.iso.org/search.html?q=ISO/IEC%2014882
There was a problem hiding this comment.
I think I prefer the links to specific versions, even though they will become outdated, because as a user I'd prefer to be linked to something specific over a link to a search.
There are also draft versions, which I believe are free and thus probably quite popular in practice (despite potentially being inaccurate to the final standard).
Co-authored-by: hubwriter <hubwriter@github.com>
5 participants
Add a
README.mdfor the C/C++ CodeQL tests. See https://github.com/github/codeql-c-analysis-team/issues/84.A specific goal is to document how we include declarations of standard library functions and types in the tests, without creating any dependencies (that might vary from machine to machine) or potential IP concerns. This policy was decided before Semmle was acquired by GitHub, and is a little strict IMO, but is still assumed to be current.
It's very much open to discussion what else should be in this document, and how it should be presented.
TODO: