Everyone,

I think we really need some better documentation on the files is src/base. 
They're supposed to be generic code that is used throughout M5, but I don't 
even know what some of it does. Minimally, we should have doxgyen comments on 
the files that describe what the code is trying to do, and preferably some 
information about how to actually use it in comments on the constructor and 
major functions. I've gone through all the code in that directory and come up 
with the list below of the person who wrote the code. It shouldn't take more 
than an hour (except for Nate), and think of it as a gift for all the M5 
developers:

Ali
bigint.hh
cp_annotate.hh
random.hh
range_map.hh
range_ops.hh

Gabe:
bitunion.hh (just convert to doxygen, comments already there)
types.hh

Nate:
circlebuf.hh
cprintf.hh
cprintf_formats.hh
fifo_buffer.hh
flags.hh
hashmap.hh
inet.hh
match.hh
pollevent.hh
predictor.hh
refcnt.hh
res_list.hh
socket.hh
str.hh
time.hh
timebuf.hh (or try to get Kevin to do it)

        
Steve:
dbllist.hh
trace.hh

Thanks,
Ali

_______________________________________________
m5-dev mailing list
[email protected]
http://m5sim.org/mailman/listinfo/m5-dev

Reply via email to