From 916114dd2820b0fda8636d9f50d57e1ae6fed4e3 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Mon, 18 Apr 2016 20:23:11 -0700 Subject: [PATCH] :memo: keeping submodules up to date --- .../source-code-directory-structure.md | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/docs/development/source-code-directory-structure.md b/docs/development/source-code-directory-structure.md index 998280a37054..1c9e8c2b7749 100644 --- a/docs/development/source-code-directory-structure.md +++ b/docs/development/source-code-directory-structure.md @@ -62,3 +62,30 @@ Electron when creating a distribution. * **external_binaries** - Downloaded binaries of third-party frameworks which do not support building with `gyp`. + +## Keeping Git Submodules Up to Date + +The Electron repository has a few vendored dependencies, found in the +[/vendor](/vendor) directory. Occasionally you might see a message like this +when running `git status`: + +```sh +$ git status + + modified: vendor/brightray (new commits) + modified: vendor/node (new commits) +``` + +To update these vendored dependencies, run the following command: + +```sh +git submodule update --init --recursive +``` + +If you find yourself running this command often, you can create an alias for it +in your `~/.gitconfig` file: + +``` +[alias] + su = git submodule update --init --recursive +```