Skip to content

chore: get instruction appendix ready for release #708

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

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

Conversation

dhower-qc
Copy link
Collaborator

@dhower-qc dhower-qc commented Apr 30, 2025

This does several things:

  • fix(build): make instruction appendix dependent on docs-resources
  • fix: remove stray '<' in instruction appendix pages
  • refactor: use cfg_arch.possible_instructions to get appendix list
    • Also removes InstructionIndex class (redundant now)
  • ci: only generate asciidoc for instruction appendix regress
  • ci: add instruction appendix to deployment

I'll also add a regression to check a "golden" output.

@dhower-qc dhower-qc requested a review from AFOliveira April 30, 2025 18:57
Copy link
Collaborator

@AFOliveira AFOliveira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM so far. Will you also add the assembly field to the erb template or do you prefer me to do so in a separate PR?

@AFOliveira
Copy link
Collaborator

@dhower-qc is it fine with you if I add a commit with a Assembly field being reliant on an environment variable?

@dhower-qc
Copy link
Collaborator Author

@dhower-qc is it fine with you if I add a commit with a Assembly field being reliant on an environment variable?

What would that look like?

@AFOliveira
Copy link
Collaborator

My idea was to add a couple lines to the erb template that prints the Assembly field if "ASSEMBLY=1".

@dhower-qc
Copy link
Collaborator Author

ahhh, I see. I thought you meant a variable that changes the string.

I have no problem with ASSEMBLY=1

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.

2 participants