Skip to content

[llvm-readelf] Update outdated URL #120498

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

Merged
merged 3 commits into from
Dec 20, 2024
Merged

[llvm-readelf] Update outdated URL #120498

merged 3 commits into from
Dec 20, 2024

Conversation

wenzhoumei
Copy link
Contributor

@wenzhoumei wenzhoumei commented Dec 18, 2024

This updates a comment pointing to the list of registered machine architectures in the ELF gABI as the URL in the old comment is no longer valid.

Copy link

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

@llvmbot
Copy link
Member

llvmbot commented Dec 18, 2024

@llvm/pr-subscribers-llvm-binary-utilities

Author: None (wenzhoumei)

Changes

This PR updates the URL in the ELF.h file comment to point to the correct GABI documentation (http://www.sco.com/developers/gabi/latest/ch4.eheader.html). The previous URL (http://www.uxsglobal.com/developers/gabi/latest/ch4.eheader.html) is outdated and no longer accessible.


Full diff: https://github.com/llvm/llvm-project/pull/120498.diff

1 Files Affected:

  • (modified) llvm/include/llvm/BinaryFormat/ELF.h (+1-1)
diff --git a/llvm/include/llvm/BinaryFormat/ELF.h b/llvm/include/llvm/BinaryFormat/ELF.h
index 5356843f8ecf1a..fc26cb331db2f9 100644
--- a/llvm/include/llvm/BinaryFormat/ELF.h
+++ b/llvm/include/llvm/BinaryFormat/ELF.h
@@ -129,7 +129,7 @@ enum { EV_NONE = 0, EV_CURRENT = 1 };
 
 // Machine architectures
 // See current registered ELF machine architectures at:
-//    http://www.uxsglobal.com/developers/gabi/latest/ch4.eheader.html
+//    http://www.sco.com/developers/gabi/latest/ch4.eheader.html
 enum {
   EM_NONE = 0,           // No machine
   EM_M32 = 1,            // AT&T WE 32100

Copy link
Collaborator

@jh7370 jh7370 left a comment

Choose a reason for hiding this comment

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

It's worth noting that this isn't actually the latest set of registered EM_* values, just the latest set documented on the sco website. Unfortunately, they don't actively maintain/publish revisions to the ELF gABI. Instead, updates can be found on the ELF generic-abi mailing list.

Specifically, at the time of writing, I believe the latest list can be found at https://groups.google.com/g/generic-abi/c/0kORSDcyhTE/m/ZRf_PvcHAAAJ. You'll note there are a number listed there which aren't in the latest published ABI.

@wenzhoumei
Copy link
Contributor Author

Hi @jh7370, thanks for the response! Would you recommend that I leave it as is or point to the general link of the mailing list instead (https://groups.google.com/g/generic-abi).

Also I'm very new to this so I'm not sure why tests are failing and what to do in this scenario. Will merging my branch on the latest version fix it?

@jh7370
Copy link
Collaborator

jh7370 commented Dec 19, 2024

Hi @jh7370, thanks for the response! Would you recommend that I leave it as is or point to the general link of the mailing list instead (https://groups.google.com/g/generic-abi).

As the point of the link is to provide people with a reference point for the registered machine constants, I'd be inclined to include both the link from my previous comment and the generic mailing list link, with some updates to the comment. Something along the lines that "At the time of writing, the list of registered machine architectures is at . Please refer to for any further updates."

Also I'm very new to this so I'm not sure why tests are failing and what to do in this scenario. Will merging my branch on the latest version fix it?

Taking a quick look at the failures shows that these tests aren't anything to do with your change (which was obvious anyway, since you've only touched a comment). This means you can safely ignore them. They'll be broken in main at the time you created your branch and will have either been fixed by the time this gets merged, or will be fixed in the future. Either way, you don't need to do anything special. If you're fussed, you could try making a merge commit from main into your branch and pushing that to see if the test is fixed.

@wenzhoumei wenzhoumei force-pushed the outdated-url branch 2 times, most recently from 4ed0162 to 38a630e Compare December 19, 2024 13:10
This updates a comment pointing to the list of registered machine
architectures in the ELF gABI as the URL in the old comment is no longer
valid.

[llvm-readelf] Update outdated URL

Update http://www.uxsglobal.com/developers/gabi/latest/ch4.eheader.html
to http://www.sco.com/developers/gabi/latest/ch4.eheader.html
Copy link
Collaborator

@jh7370 jh7370 left a comment

Choose a reason for hiding this comment

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

LGTM. Do you need me to merge this for you?

@wenzhoumei
Copy link
Contributor Author

LGTM. Do you need me to merge this for you?

Yes please

@jh7370
Copy link
Collaborator

jh7370 commented Dec 20, 2024

Hi @wenzhoumei, I went to merge this and I noticed that your email address is set to private in GitHub. The LLVM Developer Policy states the following:

The LLVM project uses email to communicate to contributors outside of the GitHub platform about their past contributions. Primarily, our buildbot infrastructure uses emails to contact contributors about build and test failures. Therefore, the LLVM community requires contributors to have a public email address associated with their GitHub commits, so please ensure that “Keep my email addresses private” is disabled in your account settings.

Please could you adjust the setting and let me know when you have, so that I can merge this change. Thanks!

@wenzhoumei
Copy link
Contributor Author

Oh sorry @jh7370 , it should be set to public now. Thanks for the help!

@jh7370 jh7370 merged commit 2405c5f into llvm:main Dec 20, 2024
5 of 8 checks passed
Copy link

@wenzhoumei Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!

@jh7370
Copy link
Collaborator

jh7370 commented Dec 20, 2024

Oh sorry @jh7370 , it should be set to public now. Thanks for the help!

No problem, it's easy to miss. All sorted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants