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

Clean up some man pages #1547

Merged
merged 2 commits into from
Oct 22, 2024
Merged

Clean up some man pages #1547

merged 2 commits into from
Oct 22, 2024

Conversation

Rangi42
Copy link
Contributor

@Rangi42 Rangi42 commented Oct 22, 2024

Fixes #1497

  • gbz80(7):
    • Breaks the instructions down into more categories
    • Puts the simplest category, load instructions, first
    • SWAP belongs with the shift/rotate instructions, not with BIT/RES/SET just because they're all prefix-encoded
    • CPL belongs with the bitwise logic instructions (it's bitwise logical NOT)
    • .Bl -tag -width Ds should make the flag effect lists more compact in HTML than .Bl -hang -compact
  • rgbasm(5):
    • Renames "Unions" to "Allocating overlapping spaces in RAM" to match the other subsection headings
    • Reorganizes the "Defining data" subsections to have ROM ones first and then RAM ones
    • "Requesting alignment" belongs with the "Defining data" subsections
  • rgbds(5):
    • The "RPN expressions" subsection heading was all-caps like a top-level section heading

@Rangi42 Rangi42 added the docs This affects the documentation (web-specific issues go to rgbds-www) label Oct 22, 2024
@Rangi42 Rangi42 added this to the v0.9.0 milestone Oct 22, 2024
@Rangi42 Rangi42 requested a review from ISSOtm October 22, 2024 13:57
ISSOtm
ISSOtm previously requested changes Oct 22, 2024
Copy link
Member

@ISSOtm ISSOtm left a comment

Choose a reason for hiding this comment

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

Thank you! This seems like indeed a very useful and welcome improvement. I merely happened to notice a single possible wording improvement while skimming; beyond it, consider this as an approving review—if you agree with the suggestion, feel free to merge this PR right after applying it :)

man/rgbasm.5 Outdated Show resolved Hide resolved
Co-authored-by: Eldred Habert <[email protected]>
@Rangi42 Rangi42 merged commit f048cbb into gbdev:master Oct 22, 2024
22 checks passed
@Rangi42 Rangi42 deleted the man-pages branch October 22, 2024 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This affects the documentation (web-specific issues go to rgbds-www)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Miscellaneous routine todos before release
2 participants