Skip to content
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

Merged
merged 1 commit into from Aug 16, 2020
Merged

Conversation

bdemers
Copy link
Contributor

@bdemers bdemers commented Aug 8, 2020

Adds git clone step to BUILD.md, to ensure that the submodule step is not missed

@bdemers
Copy link
Contributor Author

bdemers commented Aug 8, 2020

*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)

@auturgy
Copy link
Contributor

auturgy commented Aug 8, 2020 via email

Copy link
Contributor

@peterbarker peterbarker left a 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
@bdemers
Copy link
Contributor Author

bdemers commented Aug 9, 2020

@peterbarker done!

@Hwurzburg
Copy link
Collaborator

@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?

@peterbarker
Copy link
Contributor

peterbarker commented Aug 9, 2020 via email

@khancyr khancyr added the Docs label Aug 12, 2020
@peterbarker peterbarker merged commit adf40ae into ArduPilot:master Aug 16, 2020
@peterbarker
Copy link
Contributor

Merged, thanks!

@bdemers bdemers deleted the patch-1 branch August 16, 2020 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants