Just a quick note, Gabe: there are a set of tests for the Learning gem5 tutorial scripts which run in the CI tests ( https://gem5.googlesource.com/public/gem5/+/refs/heads/stable/tests/gem5/learning_gem5/). However, when people update those scripts in the gem5 source code they have not been updating the documentation. If you have ideas on how to keep prose-based documentation in step with the source code (other than asking people politely to update the docs), I would love to hear it!
Mike, we'll look into the segfault. Could you point to which example is segfaulting for you? Cheers, Jason On Thu, Apr 15, 2021 at 10:52 PM Gabe Black <[email protected]> wrote: > If you (or the documentation) expect things to work in a particular way, > one thing I've seen in some technical books I've read is that the examples > they have in the text are actually runnable, and they have a process which > goes through and runs them to make sure they work. Alternatively (and more > simply), you could just write unit tests which do what's in the > documentation, and if something changes then either that will be updated or > kokoro will reject the change. If you want something to keep working, it's > wise to write a test for it. > > Gabe > > On Thu, Apr 15, 2021 at 1:58 PM mike upton via gem5-dev <[email protected]> > wrote: > >> >> I have verified that the tutorial works in its original form on 20.0.0.3 >> and in its new form on 20.1.0.5 >> >> It segfaults on the current stable master: 21.0.0.0 >> >> >> >> On Thu, Apr 15, 2021 at 8:18 AM Jason Lowe-Power <[email protected]> >> wrote: >> >>> Hi Mike, >>> >>> It's a bit embarrassing how out of date our documentation is. >>> Unfortunately, we have a really hard time finding the resources or >>> convincing developers to update the documentation as the code changes. >>> >>> The canonical documentation can be found here: >>> http://www.gem5.org/documentation/ >>> and the Learning gem5 material here: >>> http://www.gem5.org/documentation/learning_gem5/introduction/ >>> >>> There's definitely mistakes and things that have changed. We would >>> greatly appreciate contributions. The code is available here: >>> https://gem5.googlesource.com/public/gem5-website/+/refs/heads/stable/ >>> and it's reviewed the same way as regular gem5 code. >>> >>> Let me know if you have any questions about contributing, etc. >>> >>> Cheers, >>> Jason >>> >>> On Thu, Apr 15, 2021 at 8:04 AM mike upton via gem5-dev < >>> [email protected]> wrote: >>> >>>> Hi, >>>> do we (I) have edit permissions on the tutorial documentation? >>>> >>>> I tried to follow the first steps of the tutorial, and the instructions >>>> are out of date for the develop head. Some googling resulted in the >>>> solution, but for me it still does not execute correctly. >>>> >>>> It looks like there are Jira issues documenting the needed updates. >>>> >>>> I have some issue where the tutorial is segfaulting. >>>> >>>> Can someone else verify that the tutorial actually works? >>>> _______________________________________________ >>>> gem5-dev mailing list -- [email protected] >>>> To unsubscribe send an email to [email protected] >>>> %(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s >>> >>> _______________________________________________ >> gem5-dev mailing list -- [email protected] >> To unsubscribe send an email to [email protected] >> %(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s > >
_______________________________________________ gem5-dev mailing list -- [email protected] To unsubscribe send an email to [email protected] %(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
