-
Notifications
You must be signed in to change notification settings - Fork 101
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
Fixed command line example #471
Conversation
docs/building-from-source.md
Outdated
mkdir repos | ||
git -C repos clone https://github.com/llvm/llvm-project.git | ||
git -C repos/llvm-project am -k "$PWD"/../patches/llvm-project/*.patch |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The path change was also done by #472, so this will need rebasing onto that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
mkdir repos | ||
git -C repos clone https://github.com/llvm/llvm-project.git |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For me, the point of specifying an alternate place for the repos is because I want to develop on the code base. And so I want to have the git history.
Otherwise you can just not specify it, and it will be downloaded for you without the history by CMake.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Readme file is called building-from-source, and it will be used more often only for build, rather than for developing. One who wants to develop is able to perform the same command manually, but without "--depth=1". After all, the development is much rarer than building
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with @stuij here, if someone just wants to build the toolchain then they will probably want to use the first set of commands, which does a --depth=1
checkout inside the cmake code. The second set of commands only differ in that they allow the user to manually manage the checkouts, and I'd imagine most users who want to do that also want a full checkout with history.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, I removed the "--depth=1"
the second set of commands has git commands, while the first one doesn't, so this is an important difference if you want to build it: you need to clone it properly, maintaining your disk space. Second: most of them who want just to build are not highly experienced users, they may not know about "--depth=1", they just want to compile firmware. They are 97% of all users I would say. Who wants to develop in this repo - with high probability is aware of what does "--depth=1" do, and can skip it without being afraid of broken something
…ronment for example build commands list
50a40d9
to
32b23f4
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks
No description provided.