Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding configuration-specific CSR doc #1766

Merged
merged 10 commits into from
Feb 9, 2024

Conversation

jquevremont
Copy link
Contributor

First attempt to add configuration-specific CSR lists and descriptions in the user manual.
First attempt to point to a file in another subdirectory (common between user manual and design document). I think we need to PR to test if it creates the expected result in ReadTheDocs.

First attempt to add configuration-specific CSR lists and descriptions in the user manual.
First attempt to point to a file in another subdirectory
@jquevremont jquevremont added Component:Doc For issues in the Documentation (e.g. for README.md files) Type:Enhancement For feature requests and enhancements CV32A60AX Part: Application configuration (former "step1") CV32A65X Part: Embedded configuration labels Jan 16, 2024
Copy link
Contributor

✔️ successful run, report available here.

@JeanRochCoulon
Copy link
Contributor

To test the readthedoc generation, you can execute "make singlehtlm" after cloning repo in linux env.

@jquevremont jquevremont added the Status:Do-not-merge Pull request that should not be merged (yet) label Jan 22, 2024
@jquevremont
Copy link
Contributor Author

jquevremont commented Jan 22, 2024

To test the readthedoc generation, you can execute "make singlehtml" after cloning repo in linux env.

Thanks for the hint. I tested the include from another directory it looks operational.

@JeanRochCoulon, I need your help to proceed further:

As these are generated files, I do not edit them.

Copy link
Contributor

✔️ successful run, report available here.

@jquevremont
Copy link
Contributor Author

There is no csr_list.rst in csr-from-ip-xact/cv32a60ax

Also sphinx returns WARNING: toctree contains reference to document 'CSR_CV32A60AX' that doesn't have a title: non link will be generated, so I have added a placeholder instead of this file, while this is fixed.

Could you change the titles to be more specific in the .rst files as they directly appear in the generated doc? E.g. "CV32A60X CSR descriptions" instead of "REGISTERS CSR CV32A6" in csr-from-ip-xact/cv32a60x/csr.rst

I could find a workaround in index.rst with toctree syntax.

FYI @JeanRochCoulon, sphinx returns many such non-blocking warnings, that you might consider fixing in the CSR document generator:

REGISTERS CSR CV32A6
===================
../csr-from-ip-xact/cv32a60x/csr.rst:11: WARNING: Title underline too short.

Unimplemented CSR accessing generates an illegal instruction exception.
--------------------------
../csr-from-ip-xact/cv32a60x/csr.rst:13: WARNING: Title underline too short.

and

MSTATUS:Machine Status Register
--------------------------
../csr-from-ip-xact/cv32a60x/csr.rst:38: WARNING: Inline literal start-string without end-string.
../csr-from-ip-xact/cv32a60x/csr.rst:50: WARNING: Inline literal start-string without end-string.
../csr-from-ip-xact/cv32a60x/csr.rst:56: WARNING: Inline literal start-string without end-string.

@jquevremont jquevremont removed the Status:Do-not-merge Pull request that should not be merged (yet) label Jan 28, 2024
Copy link
Contributor

✔️ successful run, report available here.

@jquevremont
Copy link
Contributor Author

@JeanRochCoulon, can you merge?

@jquevremont jquevremont mentioned this pull request Jan 29, 2024
Copy link
Contributor

✔️ successful run, report available here.

@JeanRochCoulon
Copy link
Contributor

Sorry for the delay ! I merge

@JeanRochCoulon JeanRochCoulon merged commit ef3bb06 into openhwgroup:master Feb 9, 2024
19 checks passed
@jquevremont jquevremont deleted the jquevremont-doc-csr branch March 1, 2024 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component:Doc For issues in the Documentation (e.g. for README.md files) CV32A60AX Part: Application configuration (former "step1") CV32A65X Part: Embedded configuration Type:Enhancement For feature requests and enhancements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants