Skip to content

aaelf64: link relocation entries to their notes - #426

Merged
smithp35 merged 1 commit into
ARM-software:mainfrom
sivan-shani:table_links
Sep 23, 2026
Merged

smithp35 merged 1 commit into
ARM-software:mainfrom
sivan-shani:table_links

Conversation

@sivan-shani

Copy link
Copy Markdown
Contributor

Replace ambiguous “see notes below” text with named RST footnote references.

@sivan-shani

Copy link
Copy Markdown
Contributor Author

@smithp35
@stuij

@sivan-shani

Copy link
Copy Markdown
Contributor Author

Before:
before-table-line
before-footnote
After:
after-table-line
after-footnote

@smithp35 smithp35 added the aaelf64 Issue affects ELF for the Arm Architecture label Sep 15, 2026

@smithp35 smithp35 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think if we are going to do this change, then it needs to be done to all the relocation tables so the document is stylistically consistent. I can see a few tables with the (see notes below) interleaved with your suggested change. Can you go through all the relocation tables?

Comment thread aaelf64/aaelf64.rst Outdated
Comment thread aaelf64/aaelf64.rst Outdated
@smithp35
smithp35 requested a review from stuij September 15, 2026 13:17
@sivan-shani
sivan-shani force-pushed the table_links branch 3 times, most recently from d8bba66 to 088ecee Compare September 15, 2026 17:16

@smithp35 smithp35 left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the update. That looks good to me, although I'd like to keep this open for a while to give other reviewers the opportunity to comment/object.

@ilinpv

ilinpv commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

Before: before-table-line before-footnote After: after-table-line after-footnote

Thanks for the readability improvements! I think these numbered backlinks 1,2,3,4 can be a bit confusing. Could we use the relocation names they refer back to instead or some other text that makes it clear what each link points back to?

@stuij

stuij commented Sep 22, 2026

Copy link
Copy Markdown
Member

Or remove the backlinks altogether if that's possible.

@sivan-shani
sivan-shani force-pushed the table_links branch 2 times, most recently from 354a296 to 655d221 Compare September 23, 2026 10:53
@sivan-shani

sivan-shani commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor Author

Commit rebased on main and updated to include named commits with no backlinks.
It seems as rst does not implement named backlinkes.

Example:
image

@smithp35 smithp35 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the updates. Even though it loses the back-references it should remove the confusion over the numbers.

Link to the rendered doc https://github.com/sivan-shani/abi-aa/blob/f7a8f1f613d62f669e168bad23707e030af01dc8/aaelf64/aaelf64.rst

@stuij @ilinpv if Sivan's can you let us know if these changes are OK for you? Once the @ characters have been removed I can approve.

Comment thread aaelf64/aaelf64.rst Outdated
| ELF64 Code | Name | Operation | Comment |
+============+=============================+============+=================================================================================================================+
| 270 | R\_AARCH64\_MOVW\_SABS\_G0 | S + A | Set a MOV[NZ] immediate field using bits [15:0] of X (see notes below); check -2\ :sup:`16` <= X < 2\ :sup:`16` |
| 270 | R\_AARCH64\_MOVW\_SABS\_G0 | S + A | Set a MOV[NZ] immediate field using bits [15:0] of X (see `Signed MOVW`_);@ -2\ :sup:`16` <= X < 2\ :sup:`16` |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think the @ character in these 3 references isn't needed. It is showing up raw in the text. I think these are the only references with the @

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yea this looks fine to me.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The way the links look in general I mean of course.

@ilinpv

ilinpv commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

Thanks @sivan-shani for the patch updates, named commits even without backlinks look good to me.

Replace ambiguous “see notes below” text with named RST footnote
references.
@sivan-shani

Copy link
Copy Markdown
Contributor Author

Redundant '@' removed, reviewers approve,
@smithp35 Could you please merge? Thank you.

@smithp35
smithp35 merged commit a5e86d3 into ARM-software:main Sep 23, 2026
1 check passed
@sivan-shani
sivan-shani deleted the table_links branch September 23, 2026 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

aaelf64 Issue affects ELF for the Arm Architecture

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants