> On Jan. 25, 2013, 9:05 a.m., Nathan Binkert wrote: > > src/python/m5/stats/__init__.py, line 317 > > <http://reviews.gem5.org/r/1636/diff/1/?file=33196#file33196line317> > > > > Seems odd to get rid of pydoc in favor of doxygen. > > Sascha Bischoff wrote: > 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.
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. - Sascha ----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: http://reviews.gem5.org/r/1636/#review3898 ----------------------------------------------------------- On Jan. 29, 2013, 2:13 a.m., Andreas Hansson wrote: > > ----------------------------------------------------------- > This is an automatically generated e-mail. To reply, visit: > http://reviews.gem5.org/r/1636/ > ----------------------------------------------------------- > > (Updated Jan. 29, 2013, 2:13 a.m.) > > > Review request for Default. > > > 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. > > > Diffs > ----- > > src/Doxyfile 5532a1642108 > src/python/m5/stats/__init__.py 5532a1642108 > src/python/m5/stats/context.py PRE-CREATION > src/python/m5/stats/display.py PRE-CREATION > src/python/m5/stats/info.py PRE-CREATION > > Diff: http://reviews.gem5.org/r/1636/diff/ > > > Testing > ------- > > Ran a number of simulations > > > Thanks, > > Andreas Hansson > > _______________________________________________ gem5-dev mailing list [email protected] http://m5sim.org/mailman/listinfo/gem5-dev
