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
Add clone information to BUILD.md #15015
Conversation
*NOTE: There are a few locations that do point out the sub modules, but not all. For example coming into the project from the "build on a Mac" path there is no mention of cloning the repo. |
Thanks Brian: useful feedback.
Would it be better to find a way to define the entry point into the wiki a bit better for new devs, rather than increase duplication (for maintainability)?
Also, as you’ve likely observed build.md needs a bit of a general refresh :)
… On 9 Aug 2020, at 8:09 am, Brian Demers ***@***.***> wrote:
*NOTE: There are a few locations that do point out the sub modules, but not all. For example coming into the project from the "build on a Mac" path there is no mention of cloning the repo.
(This isn't necessarily bad, but missing submodule step may be a common issue for folks that don't typically deal with them)
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub, or unsubscribe.
|
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.
Looks like a reasonable change.
Commit message needs to be fixed to something like BUILD_MD: add instruction to clone repository as first step
to meet our guidelines.
Let me know if you'd like me to change that commit message for you; I don't think the github interface makes that bit easy.
Adds git clone step to BUILD.md, to ensure that the submodule step is not missed
@peterbarker done! |
@peterbarker why do we recommend repeatedly elsewhere to use git submodule update --init --recursive after a normal clone...instead of --recursive or --recurse-submodules during the clone? |
On Sun, 9 Aug 2020, Henry Wurzburg wrote:
@peterbarker why do we recommend repeatedly elsewhere to use git submodule update --init --recursive after a normal clone...instead of --recursive or
--recurse-submodules during the clone?
The only reason I can think of is that the separate operation is useful
after you've got a clone, when you're trying to bring everything
up-to-date. Perhaps a long-term sort of a hint.
|
Merged, thanks! |
Adds git clone step to BUILD.md, to ensure that the submodule step is not missed