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

[doc,dif] Fix link in dif header files #19810

Open
matutem opened this issue Sep 29, 2023 · 0 comments
Open

[doc,dif] Fix link in dif header files #19810

matutem opened this issue Sep 29, 2023 · 0 comments
Assignees
Labels

Comments

@matutem
Copy link
Contributor

matutem commented Sep 29, 2023

Description

The dif header files have a link to /hw/ip/, this should be /book/hw/ip/ instead.
For example, the rendered https://opentitan.org/gen/doxy/dif__pwrmgr__autogen_8h.html has a PWRMGR link at the start and it gives a 404 error.

Moreover, this will need to be aware of top-specific IPs, since the link should point to a top-specific ip_autogen directory.

matutem added a commit to matutem/opentitan that referenced this issue Sep 29, 2023
Fix header generation. This was generating the checklist into dif_<ip>.h.
Fix format issues in make_new_dif.py.
Fix embedded link to IP docs in generated header files.

Addresses lowRISC#19810

Signed-off-by: Guillermo Maturana <[email protected]>
matutem added a commit to matutem/opentitan that referenced this issue Sep 29, 2023
- Fix header generation. This was generating the checklist into dif_<ip>.h.
- Fix the file comments explaining the script usage.
- Add the file comments to the help message.
- Fix format issues in make_new_dif.py.
- Fix embedded link to IP docs in generated header files.

Addresses lowRISC#19810

Signed-off-by: Guillermo Maturana <[email protected]>
matutem added a commit to matutem/opentitan that referenced this issue Sep 30, 2023
- Fix header generation. This was generating the checklist into dif_<ip>.h.
- Fix the file comments explaining the script usage.
- Add the file comments to the help message.
- Fix format issues in make_new_dif.py.
- Fix embedded link to IP docs in generated header files.

Addresses lowRISC#19810

Signed-off-by: Guillermo Maturana <[email protected]>
matutem added a commit to matutem/opentitan that referenced this issue Sep 30, 2023
- Fix header generation. This was generating the checklist into dif_<ip>.h.
- Fix the file comments explaining the script usage.
- Add the file comments to the help message.
- Fix format issues in make_new_dif.py.
- Fix embedded link to IP docs in generated header files.
- Regenerate autogen files.

Addresses lowRISC#19810

Signed-off-by: Guillermo Maturana <[email protected]>
matutem added a commit to matutem/opentitan that referenced this issue Sep 30, 2023
…files

The link starts at /book since that was changed some time ago.
The link lands in ip/<block> so it picks up README.md.
This only changes the templates. A separate commit will regenerate the
autogen difs.

Addresses lowRISC#19810

Signed-off-by: Guillermo Maturana <[email protected]>
matutem added a commit to matutem/opentitan that referenced this issue Oct 4, 2023
…files

The link starts at /book since that was changed some time ago.
The link lands in ip/<block> so it picks up README.md.
This only changes the templates. A separate commit will regenerate the
autogen difs.

Addresses lowRISC#19810

Signed-off-by: Guillermo Maturana <[email protected]>
matutem added a commit to matutem/opentitan that referenced this issue Oct 9, 2023
…files

The link starts at /book since that was changed some time ago.
The link lands in ip/<block> so it picks up README.md.
This only changes the templates. A separate commit will regenerate the
autogen difs.

Addresses lowRISC#19810

Signed-off-by: Guillermo Maturana <[email protected]>
matutem added a commit that referenced this issue Oct 10, 2023
…files

The link starts at /book since that was changed some time ago.
The link lands in ip/<block> so it picks up README.md.
This only changes the templates. A separate commit will regenerate the
autogen difs.

Addresses #19810

Signed-off-by: Guillermo Maturana <[email protected]>
@msfschaffner msfschaffner added the Component:Doc Documentation issue label Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants