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

Fix section titles in Appendix I - OpenCL extensions #1087

Closed
wants to merge 1 commit into from

Conversation

kpet
Copy link
Contributor

@kpet kpet commented Mar 22, 2024

The section headers for "Name String", "Ratification Status", etc should be one level below the headers for individual extensions.

Another, possibly cleaner, way to fix this would be to add one level of nesting to headers in all the extension files under api/

Change-Id: I97bc12a845ccb39c421dfed16223b3cdee5203af

The section headers for "Name String", "Ratification Status", etc
should be one level below the headers for individual extensions.

Another, possibly cleaner, way to fix this would be to add one level
of nesting to headers in all the extension files under api/

Signed-off-by: Kevin Petit <kevin.petit@arm.com>
Change-Id: I97bc12a845ccb39c421dfed16223b3cdee5203af
@bashbaug bashbaug requested a review from oddhack March 25, 2024 19:59
@bashbaug
Copy link
Contributor

@oddhack do you have a preference how we do this?

I agree the spec TOC looks much nicer after this change.

@oddhack
Copy link
Contributor

oddhack commented Mar 26, 2024

I did something along these lines in the Vulkan scripts quite recently as well - let me take another pass at syncing up the scripts, as I'd like to keep those linked up between the various repos making use of them. It is a bit tricky because the refpage extraction script that assembles the extension refpages has to make some assumptions about the heading level of the extension appendix bits it extracts.

(Edit: TL;DR please hold off on this one for a bit if it is not urgent.)

oddhack added a commit that referenced this pull request Mar 29, 2024
…n nesting

The observable effects of this are

- Pushes the subsection titles in the extension appendices down one level, similar to #1087 but keeping the scripts in sync
- Adds an autogenerated 'API Interactions' section with currently only affects the cl_khr_command_buffer extension, since that's the only one with some APIs tagged in the XML as dependent on a particular core version
@oddhack
Copy link
Contributor

oddhack commented Mar 29, 2024

Please take a look at #1116 as an alternative. The nesting level adjustment falls out of synchronizing the scripts with the Vulkan scripts.

bashbaug pushed a commit that referenced this pull request Mar 31, 2024
…n nesting (#1116)

The observable effects of this are

- Pushes the subsection titles in the extension appendices down one level, similar to #1087 but keeping the scripts in sync
- Adds an autogenerated 'API Interactions' section with currently only affects the cl_khr_command_buffer extension, since that's the only one with some APIs tagged in the XML as dependent on a particular core version
@oddhack
Copy link
Contributor

oddhack commented Apr 1, 2024

@kpet this should probably be closed, with #1116 merged.

@kpet
Copy link
Contributor Author

kpet commented Apr 2, 2024

@oddhack Thanks! Closing this PR.

@kpet kpet closed this Apr 2, 2024
@kpet kpet deleted the fix-extension-toc branch April 2, 2024 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants