Added Linux vs. Windows note, llvm-symbolizer tip, various other minor notes and clarifications #5
Conversation
This file contains hidden or 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
…r notes and clarifications
github-actions
bot
added
documentation
Rot127
reviewed
Jul 18, 2025
|
|
||
| ## Install | ||
|
|
||
| > ⚠️ |
There was a problem hiding this comment.
Please use the Github markdown highlighting for this:
https://github.com/orgs/community/discussions/16925
| - Always attempt to make the translated C file behave as closely as possible to the original C++ file! This greatly helps debugging and assures that Capstone behaves almost exactly the same as original LLVM. | ||
|
|
||
|
|
||
| > ⚠️ |
| ## Install | ||
|
|
||
| > ⚠️ | ||
| > Auto-Sync only runs on Linux, running on Windows is desirable but not a priority at the moment |
There was a problem hiding this comment.
Better just state it and link the issue: capstone-engine#2755.
So people have a place to check for updates and complain. Also below.
|
|
||
|
|
||
| > ⚠️ | ||
| > Refactoring an architecture to Auto-Sync is only possible on Linux, running on Windows is desirable but not a priority at the moment |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Your checklist for this pull request
Detailed description
I added a warning for both the README and the refactor guide that things only work on Linux, also added a tip about llvm-symbolizer to prettify the stacktraces that might result when you run commands that end up with LLVM tools crashing
Some miscellenous clarifications and additions were added, I expect I might update this PR so you might want to leave it unmerged for a couple of days to bundle all the changes together
Test plan
...
Closing issues
...