stats: Add documentation to the python statistics system

Information
Submitter:	Andreas Hansson
Repository:	gem5
Branch:	default
Bugs:
Depends On:
Reviewers
Groups:	Default
People:

Description

Changeset 9510:a32b2d4dcb49
---------------------------
stats: Add documentation to the python statistics system

Adds documentation to the python statistics which previously had
almost no documentation. This documentation is in doxygen style and is
therefore included in the standard doxygen documentation for gem5. The
path to the python stats system has been included in the doxygen
search path.

Testing Done

Ran a number of simulations

Issue Summary

Description	From	Last Updated	Status
Seems odd to get rid of pydoc in favor of doxygen.	Nathan Binkert	Jan. 25, 2013, 1:05 a.m.	Open
Why is this in this commit? doesn't seem like a bugfix to me. What problem is this fixing?	Nathan Binkert	Jan. 28, 2013, 6:05 p.m.	Resolved

there is a lot of random stuff in this commit.  It would be easier to review if it were split up and a bit of explanation of the bugfixes were given.

src/python/m5/stats/__init__.py (Diff revision 1)

Seems odd to get rid of pydoc in favor of doxygen.

Show all issues

Sascha Bischoff Jan. 28, 2013, 7:06 p.m. (Jan. 28, 2013, 7:06 p.m.)

We decided to use doxygen as it allowed us to have the documentation for the python stats in the same place as the documentation for the C++ backend which collects the statistics.

Sascha Bischoff April 23, 2013, 8:33 p.m. (April 23, 2013, 8:33 p.m.)

I have had a look at converting the doxygen documentation to pydoc style documentation. However, when trying to generate the pydoc documentation for gem5 it appears that there is some inherent issue. For example, I get errors along the lines of:

problem in m5.core - <type 'exceptions.ImportError'>: No module named core
problem in m5.debug - <type 'exceptions.ImportError'>: No module named core
problem in m5.defines - <type 'exceptions.ImportError'>: No module named core
problem in m5.event - <type 'exceptions.ImportError'>: No module named core
problem in m5.stats - <type 'exceptions.ImportError'>: No module named core

and

TypeError: 'ParamFactory' object is not iterable

Therefore, unless someone is able to offer a suggestion as to why pydoc is failing, I propose that we leave the documentation as doxygen. There will always be the opportunity to change to pydoc at a later stage if the above issues are resolved.

src/python/m5/stats/display.py (Diff revision 1)

Why is this in this commit?  doesn't seem like a bugfix to me.  What problem is this fixing?

Show all issues

Sascha Bischoff Jan. 28, 2013, 7:04 p.m. (Jan. 28, 2013, 7:04 p.m.)

I have split this into a second patch. It was trying to address issues with formulas not being printed in the same way as in the old C++ stats system.

Summary:

-	stats: Add documentation and bug fixes to the python statistics
+	stats: Add documentation to the python statistics system

Description:

~		Changeset 9489:73ffb931b216
	~	Changeset 9510:a32b2d4dcb49

~		stats: Add documentation and bug fixes to the python statistics
	~	stats: Add documentation to the python statistics system

~		Adds doxygen parsable documentation to the python statistics which previously
~		had almost no documentation.
~
~		Functionality has been changed such that the stats.txt is not appended to, but
~		is instead overwritten to bring it inline with the C++-based stats dumps. The
	~	Adds documentation to the python statistics which previously had
	~	almost no documentation. This documentation is in doxygen style and is
	~	therefore included in the standard doxygen documentation for gem5. The
	~	path to the python stats system has been included in the doxygen
	~	search path.
-		first stats dump will overwrite stats.txt should it exist, whereas subsequent
-		dumps append to the file.
-
-		The totals for formulas were previously not being calculated correctly, and are
-		now calculated using ASTs. This ensures that the operations are evaluated in
-		the correct order.

Diff:

Revision 2 (+442 -11)

Show changes

	src/Doxyfile
	src/python/m5/stats/__init__.py
	src/python/m5/stats/context.py
	src/python/m5/stats/display.py
	src/python/m5/stats/info.py

You have a pending review.

Review Board 2.0.15

Screenshots

Files

Issue Summary

Summary:

Description:

Changeset 9489:73ffb931b216

Changeset 9510:a32b2d4dcb49

Diff: