ibex icon indicating copy to clipboard operation
ibex copied to clipboard

[doc] Documentation Improvement - catch all for documentation issues

Open johngt opened this issue 3 years ago • 5 comments

Catch all for all issues where users have had a misunderstanding or we have some explicit knowledge that should be shared with the community via OT documentation (e.g. knowing that specific versions work for tools).

Note: Not making this explicitly an issue for V2 but if we have spare cycles we should look at improving the documentation.

estimate 32

johngt avatar Jul 19 '22 08:07 johngt

https://github.com/lowRISC/ibex/issues/1676 - xlm / vcs differences in output. Explain the output expected from the different tools and explain the difference. Closes issue 1676

johngt avatar Jul 19 '22 08:07 johngt

https://github.com/lowRISC/ibex/issues/1669 - log file might grow indefinitely if pkg_config not set up explicitly. Although the issue may be resolved, need to check that in the configuration guide that we capture common errors and highlight specific expected errors if pkg_config is not set, at least for a few issues that have been reported.

johngt avatar Jul 19 '22 08:07 johngt

https://github.com/lowRISC/ibex/issues/1646 - I believe that the linked issue can be closed with an update to the documentation

johngt avatar Jul 19 '22 08:07 johngt

Not specifically an Ibex DV / documentation issue, but tracking https://github.com/lowRISC/opentitan/issues/2498 as a documentation issue so that we can close that out.

johngt avatar Jul 29 '22 15:07 johngt

Shifting this out of the V2 milestone

GregAC avatar Aug 31 '22 17:08 GregAC

Closing this as it was only relevant to prior project tracking.

GregAC avatar Feb 27 '23 10:02 GregAC