Jump to content

Documentation on `uvm_do_[obj_]callbacks_exit_on is quite badly broken

Recommended Posts

1) The macro arguments are incorrectly documented. The first two arguments T, CB are swapped in the documentation - T shoudl be the type of the calling object, CB the type of the callback facade. The docs say "uvm_do_callbacks_exit_on(mycomp, mycb, ...)"

2) The macro is written as if it were a function body, which is fair enough because it must return a result. The documentation and examples, though, indicate wrongly that the macro itself should be called as if it were a function invocation. It's necessary to wrap it up in your own function.

Anyone disagree? If not I'll log the bug early next week.


Link to comment
Share on other sites

1) The docs say "uvm_do_callbacks_exit_on(mycomp, mycb, ...)"

Ooops, sorry, they don't. If the doc said that it would be right. Instead it says "uvm_do_callbacks_exit_on(mycb, mycomp, ...)" which is wrong.

In fact this error appears only in one specific place, the documentation of `uvm_do_callbacks_exit_on (the non-OBJ version). Unfortunately that's the one I used :-(

Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

  • Create New...