learning_gem5
learning_gem5 copied to clipboard
powerjg
Comments appear in hello_object.cc partway through tutorial
Before http://learning.gem5.org/book/part2/parameters.html, there are no comments in the hello_object.cc code that appears in the HTML. However, starting with this section, there are comments for member variables (myName, latency, timesLeft) that were previously introduced without comments. It's not a big deal, but it would be good to be consistent throughout.
Matt
I was thinking that I would put comments in the code that's distributed. In the HTML/Book there wouldn't be comments in the code, but the prose would do the work of the comments. Do you think this is the right way to do it?
This doesn't really address the issue. Those variables definitely need more prose! I was just wondering your thoughts after going through the first couple of parts.
That makes sense. My suggestion then would be to remove the comments from parameters.rst, to keep it consistent.
I don't think this is the hard part. I think the memoryobject and simplecache parts are much more complicated.
Matt