-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Update Cutter Building Documentation #2238
Conversation
Before adding this to the dependency list I would like the need for it to be evaluated. |
From what I could find curl is only used for downloading capstone when building r2 using .configure/Makefile approach. It can also use wget instead of curl. Meson based r2 build which is also what CUTTER_USE_BUNDLED_RADARE2 seems to use GIT for getting it. It is also possible to build r2 using system capstone which avoids downloading it completely. I propose organizing the dependency list into 3 parts:
|
@karliss KSyntaxHighlighter & graphviz seems like a case that may need separate mention but for me difficult to avoid kinda sounds the same as the main dependencies. Usually, all build instruction pages show required and recommended dependencies together for the convenience (of setting up env with one command). |
You can call them recommended dependencies if you think that it's less confusing. My reasoning is that they aren't strictly required and removing them doesn't take away from functionality of Cutter. It just makes a process a bit more complicated and you have to understand what you are doing. Adding an additional separator especially if there is one already for optional dependencies isn't hard. There are different needs for different people. Most end users probably don't care how and what the the build system does. But people preparing a package for distros or just someone trying to do offline do care at least a little bit and probably don't want build system to curl random source code during build. |
a87eca9
to
79d246e
Compare
@karliss @ITAYC0HEN The |
* add linux dependencies to the list * make a common git clone section
* add linux dependencies to the list * make a common git clone section
Your checklist for this pull request
Detailed description
This PR is to update Cutter docs. Starting with adding missing dependencies to dev docs and will slowly move towards user docs. Relates to #744
Test plan (required)
Build and run docs.
Closing issues