Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bunch of things undocumented #293

Open
3 of 8 tasks
zoffixznet opened this issue Jun 25, 2016 · 11 comments
Open
3 of 8 tasks

Bunch of things undocumented #293

zoffixznet opened this issue Jun 25, 2016 · 11 comments
Assignees

Comments

@zoffixznet
Copy link
Contributor

zoffixznet commented Jun 25, 2016

If they are, I couldn't find where when searching the repo:

  • syncpipe
  • getcodelocation
  • closefh_i
  • queuepoll
  • getcurhllsym
  • bindhllsym
  • gethllsym
  • const::PIPE_CAPTURE_ERR
@zoffixznet zoffixznet changed the title getcurhllsym is not documented getcurhllsym and gethllsym are not documented Jun 26, 2016
@zoffixznet zoffixznet changed the title getcurhllsym and gethllsym are not documented getcurhllsym, bindhllsym, and gethllsym are not documented Jun 27, 2016
@zoffixznet zoffixznet changed the title getcurhllsym, bindhllsym, and gethllsym are not documented queuepoll, getcurhllsym, bindhllsym, and gethllsym are not documented Jul 21, 2016
@zoffixznet zoffixznet changed the title queuepoll, getcurhllsym, bindhllsym, and gethllsym are not documented closefh_i, queuepoll, getcurhllsym, bindhllsym, and gethllsym are not documented Jul 21, 2016
@zoffixznet zoffixznet changed the title closefh_i, queuepoll, getcurhllsym, bindhllsym, and gethllsym are not documented getcodelocation, closefh_i, queuepoll, getcurhllsym, bindhllsym, and gethllsym are not documented Aug 3, 2016
@zoffixznet zoffixznet changed the title getcodelocation, closefh_i, queuepoll, getcurhllsym, bindhllsym, and gethllsym are not documented getcodelocation, closefh_i, queuepoll, getcurhllsym, bindhllsym, gethllsym, const::PIPE_CAPTURE_ERR are not documented Sep 5, 2016
@zoffixznet zoffixznet changed the title getcodelocation, closefh_i, queuepoll, getcurhllsym, bindhllsym, gethllsym, const::PIPE_CAPTURE_ERR are not documented Bunch of things undocumented Sep 5, 2016
@MasterDuke17
Copy link
Contributor

https://gist.github.com/MasterDuke17/8833c501a6840ab9b2f29ea66d3db120
Here are all nqp::s where there's no entry for them in ops.markdown.

@coke
Copy link
Contributor

coke commented Sep 6, 2016

FYI, there's a test for this from 2013 or so:

$ make
$ prove -v -e ./nqp t/docs/opcodes.t

This has 253 tests failing for undocumented opcodes, whereas the gist only has 206 - it reports on everything in the description, except the const:: entry.

@coke
Copy link
Contributor

coke commented Sep 8, 2016

the 253 failures was for more than just undocc'd opcodes, and didn't include the js backend.

Latest totals:

17:32 < [Coke]> down to 387 failures in nqp's t/docs/opcodes.t
17:35 < [Coke]> of that, 258 are actual undocumented opcodes. 126 are opcodes
that probably don't exist yet in js.

Note that the undocumented opcodes are across all three backends (and may suffer from bad guessing of what's an opcode)

@coke
Copy link
Contributor

coke commented Jan 17, 2017

Down to 316 failures in nqp's t/docs/opcodes.t; Of that, 48 are opcodes that probably don't exist yet in js.

@coke
Copy link
Contributor

coke commented Apr 3, 2020

Was a spike over 400 - with recent updates, down to 351 - they are all "missing documentation" errors, and note that there are several stubs in the ops documentation that should also be considered failures (but the test is only checking for headings, not actual docs)

@coke coke self-assigned this Apr 11, 2020
@coke
Copy link
Contributor

coke commented Apr 24, 2020

Down to 270 failures.

@coke
Copy link
Contributor

coke commented Oct 16, 2020

260 failures. (Note that several of the passes are stubs with just the opcode name. :(

@coke
Copy link
Contributor

coke commented Oct 24, 2020

Test no longer allows stubs with just the opcode name to pass, now reporting 289 failures.

@coke
Copy link
Contributor

coke commented Oct 24, 2020

Snapshot of current failures at https://gist.github.com/coke/f87ab505c6cb825db51afcb5cb6a8990 (186 not ok)

@coke
Copy link
Contributor

coke commented Oct 25, 2020

Updated the test file to skip moarvm opcodes that are found but not exposed. Fixed a few docs that had heading level docs to have per-opcode docs to satisfy the test. Updated the gist.

@coke
Copy link
Contributor

coke commented Feb 5, 2022

back up to 617 failures earlier today due to changes in detection of ops in source file. committed a fix to the opcode test (b2880cb) back down to 191 failures. (with overlap: 160 missing on JVM, 125 JS, 163 moar)

coke added a commit that referenced this issue Feb 5, 2022
MOAR opcode definition was updated, make test match

see #293
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants