search

opensocdebug / osd-doc

Open Soc Debug Documentation, including the specification
http://www.opensocdebug.org
Other
1 stars 3 forks source link

Added doc for DEM_UART #20

Closed ThomasLeyk closed 6 years ago

ThomasLeyk commented 6 years ago

fixes #19

ThomasLeyk commented 6 years ago

I've fixed the mistakes and tried to add some more details. Is the diagram OK this way or should it also contain more details?

ThomasLeyk commented 6 years ago

I've amended the commit to include the requested changes.

ThomasLeyk commented 6 years ago

I've fixed some of the smaller mistakes, but im not sure if the specifications of the UART are detailed enough.

ThomasLeyk commented 6 years ago

I've looked at the html version of the doc and it looks good to me now. I couldn't manage to get 'make latexpdf' to work properly so i don't know about that.

imphil commented 6 years ago

I couldn't manage to get 'make latexpdf' to work properly so i don't know about that.

What errors did you encounter?

ThomasLeyk commented 6 years ago

A couple warnings like "a suitable image for latex builder not found", for old & new rst files.

Then LaTeX can't find a couple of files (01_overview/getting_started/img/overviewexample*) so i have to manually continue the build process.

At some point Latexmk decides to abort the build process, so im pretty sure it doesn't even get to any of the files under src/02_spec.

imphil commented 6 years ago

Please open an issue in this repository and attach the exact error log to get this fixed.

ThomasLeyk commented 6 years ago

Unfortunately not, i used wavedrom.com to create them and then just used some online PNG->SVG converter. What program could i use to create timing diagrams in the SVG format?

imphil commented 6 years ago

Wavedrom can export images as SVG directly. If you want to further edit SVG files you can use Inkscape.

ThomasLeyk commented 6 years ago

I've added real SVG versions of the timing diagrams now.

imphil commented 6 years ago

Please also fix the table width settings (please see my in-code comments), and then this is ready to go.

ThomasLeyk commented 6 years ago

Done.

imphil commented 6 years ago

This is now merged and should show up on https://opensocdebug.readthedocs.org in a couple of minutes. Thanks @ThomasLeyk for following through with this PR and getting it ready for being merged!