Switch "CPU instruction set" to document encoding instead #511
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
avivace
approved these changes
Dec 10, 2023
iximeow
reviewed
Dec 13, 2023
|
broadly this seems really nice! i have the one nit, otherwise 👍 . you have a TODO about links to optables, are you thinking a paragraph of preface about those other resources? or something more deeply connected to the revised docs? |
|
I wanted to write a paragraph explaining the choice of what that page documents and what it doesn't, as well as giving links to other complementary resources. Glad you like it! ^^ |
|
The paragraph linking to other resources was easy to write, but an attempt at a key proved tremendously more difficult; I can't help but think I've fumbled it. But at least it's something that can be discussed. |
|
I'm planning to merge this next week without further activity. |
avivace
approved these changes
Dec 29, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #456.
As mentioned there, optables provides a very compact view of instructions, but may not help discerning patterns; whereas gbz80(7) describes the instructions themselves, but does not work well as a cheat sheet.
This PR attempts to document what neither of those two resources do: the instructions' encoding, in a manner closer to how the CPU decodes them. The patterns can be gleaned from optables, especially in the octal view, but not everyone may connect the dots.
Cycle counts, behaviour descriptions, etc. have been removed, since that information can be found in gbz80(7) and optables; and removing that data makes this page more compact, and thus I think easier to navigate and grasp.
Instructions have been grouped thematically, and those groups roughly ordered—though blocks 0 and 3 are quite resistant to any consensus ordering.
Anyone and everyone is welcome to share their feedback on the decisions made about the content and the presentation. Thank you!