Generating bytecode documentation from Interpreter.cpp
Hi all, it seems that squirrelfish-bytecode.html is out of sync with the reality again. A simple grep on the DEFINE_OPCODE (and removing some) shows that we have about 136 opcodes, searching for "<h2><code>" in the HTML only reveals 78 documented opcodes. I have tried to find a missing one (to support my hypothesis) and "op_eq_null" seems to be among the undocumented ones. Is there any interest to generate the documentation from the switch/case of the Interpreter.cpp? I think I could come up with a small python script to do that. comments?
On Sep 21, 2010, at 9:50 AM, Holger Freyther wrote:
Hi all,
it seems that squirrelfish-bytecode.html is out of sync with the reality again. A simple grep on the DEFINE_OPCODE (and removing some) shows that we have about 136 opcodes, searching for "<h2><code>" in the HTML only reveals 78 documented opcodes. I have tried to find a missing one (to support my hypothesis) and "op_eq_null" seems to be among the undocumented ones.
Is there any interest to generate the documentation from the switch/case of the Interpreter.cpp? I think I could come up with a small python script to do that.
comments?
The docs actually are generated from Interpreter.cpp, from the doc comments on each case statement. It just hasn't been updated in a while. Also the following opcodes lack documentation: UNDOCUMENTED: get_by_id_self_list UNDOCUMENTED: get_by_id_proto_list UNDOCUMENTED: get_by_id_getter_self_list UNDOCUMENTED: get_by_id_getter_proto_list UNDOCUMENTED: get_by_id_custom_self_list UNDOCUMENTED: get_by_id_custom_proto_list UNDOCUMENTED: get_by_pname UNDOCUMENTED: load_varargs UNDOCUMENTED: strcat UNDOCUMENTED: to_primitive UNDOCUMENTED: method_check Regards, Maciej
On 09/22/2010 01:38 AM, Maciej Stachowiak wrote:
comments?
The docs actually are generated from Interpreter.cpp, from the doc comments on each case statement. It just hasn't been updated in a while. Also the following opcodes lack documentation:
Could you help me to find that script? I can help with describing the semantic of these opcodes.
participants (2)
-
Holger Freyther
-
Maciej Stachowiak