



Revision control of the OpenRISC architecture specification
by rnd on Apr 28, 2013 |
rnd
Posts: 2 Joined: Apr 28, 2013 Last seen: May 15, 2013 |
||
Hello.
I've new to the OpenCores community and actually read about OpenRISC for the first time yesterday. Needless to say, I was immediately hooked and stayed up until 4 am reading up about various information related to the project. Today I've started diving into the OpenRISC 1000 architecture specification. Made my first commit to the wiki just minutes ago about some minor details related to consistency [1]. I would be really interested in following the development of OpenRISC and hopefully be able to contribute something. I do believe it has a lot of potential and was so glad to discover an open source RISC processor implementation. One of the things that would really facilitate contributions and work related to the OpenRISC architecture specification would be if the changes were tracked in the revision control system. I know that the odt and pdf version of the specification are available via SVN, but since these are not really textual formats most of the benefits with a revision control system are lost. For instance I would love to be able to clone the repo containing the specification, make a few changes and send a pull request. Using odt instead of some textual format for the spec makes this more difficult. These pull requests could them be discussed and peer reviewed by the OpenCores community before being merged. Anyways, just throwing the idea out there. Thank you for all your amazing work so far and I hope the future will be a bright one for the OpenRISC project and OpenCores! Cheers /Robin [1]: http://opencores.org/or1k/Architecture_Specification#Consistency |
RE: Revision control of the OpenRISC architecture specification
by julius on Apr 30, 2013 |
julius
Posts: 363 Joined: Jul 1, 2008 Last seen: May 17, 2021 |
||
Hi Robin
Thanks for your comments, and for the contributions to the architecture specification page. Regarding the format of the architecture spec, there was talk of converting it to AsciiDoc a little while back (like what happened to the OR1200 specification), but we got over it because it would have been a lot of work, and the time most of us have to spend on the project is limited, so we decided it wasn't worth it. Also, I really don't think it's such a big deal to hold a relatively static document like the architecture specification manual in ODT format in an SVN repository. It really shouldn't be changing very often. The wiki page is the perfect place to stage proposals etc. Point taken, however, that it's cumbersome to nicely generate and present diffs on the mailing lists or on the wiki. As for looking at the history of the document, the changes are summarised in the document itself, and as metadata in the ODT. Cheers Julius |



