Skip to content

Commit c84380a

Browse files
committed
update scripts and docs
1 parent e427aea commit c84380a

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

build_package.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Build instructions
1313
====================
1414

1515
1. Be sure you have runned the following command at the root of your tree :
16-
``git submodule update --init``
16+
``git submodule update --init --recursive``
1717

1818
2. Commit or stash all your changes
1919
3. Tag the new release version

documentation/vagrant/vagrant.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ url = https://github.com/CanalTP/navitia-proto.git
122122
Update submodules:
123123
```sh
124124
cd navitia
125-
git submodule update --init
125+
git submodule update --init --recursive
126126
```
127127

128128

@@ -352,7 +352,7 @@ pip install -r requirements.txt
352352

353353
# ! change .gitmodules url if using http instead of ssh !
354354

355-
git submodule update --init
355+
git submodule update --init --recursive
356356
./setup.py build_pbf
357357
```
358358

install.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ We hope you got the source code from git.
4040

4141
#. Get the submodules: at the root of project :
4242

43-
``git submodule update --init``
43+
``git submodule update --init --recursive``
4444

4545
#. With CMake you can build in a repository different than the source directory.
4646

@@ -143,4 +143,4 @@ Testing
143143

144144
#. Grab a browser and open http://localhost:5000/v1/coverage/default_region
145145

146-
#. Any trouble running Jormungandr see https://github.com/CanalTP/navitia/blob/dev/source/jormungandr/readme.md
146+
#. Any trouble running Jormungandr see https://github.com/CanalTP/navitia/blob/dev/source/jormungandr/readme.md

readme_release.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ python ./script_release.py minor <canaltp_distant_repo_name>
1414
```
1515
Then follow the instructions given by the script, and also:
1616
* pay attention to the changelog, remove useless PR (small doc) and check that every important PR is there
17-
* don't forget to make `git submodule update` when necessary
17+
* don't forget to make `git submodule update --recursive` when necessary
1818
* check that `release` branch COMPILES and TESTS (unit, docker and tyr) before pushing it!
1919

2020
## Other releases

script_release.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ def __init__(self, release_type, remote_name="canalTP"):
8181
print(is_release_unmerged.group(0))
8282
print("ABORTING: {rem}/release branch was not merged in {rem}/dev".format(rem=remote_name))
8383
print("This is required before releasing. You may use (be careful):")
84-
print("git checkout dev; git submodule update")
84+
print("git checkout dev; git submodule update --recursive")
8585
print("git merge release")
8686

8787
exit(1)
@@ -142,7 +142,7 @@ def checkout_parent_branch(self):
142142
parent = "release"
143143

144144
self.git.checkout(parent)
145-
self.git.submodule('update')
145+
self.git.submodule('update', '--recursive')
146146

147147
print("current branch {}".format(self.repo.active_branch))
148148

@@ -293,7 +293,7 @@ def get_modified_changelog(self):
293293

294294
def publish_release(self, temp_branch):
295295
self.git.checkout("release")
296-
self.git.submodule('update')
296+
self.git.submodule('update', '--recursive')
297297
#merge with the release branch
298298
self.git.merge(temp_branch, "release", '--no-ff')
299299

@@ -315,7 +315,7 @@ def publish_release(self, temp_branch):
315315
print("publishing the release")
316316

317317
print("Check the release, you will probably want to merge release in dev:")
318-
print(" git checkout dev; git submodule update")
318+
print(" git checkout dev; git submodule update --recursive")
319319
print(" git merge release")
320320
print("And when you're happy do:")
321321
print(" git push {} release dev --tags".format(self.remote_name))

0 commit comments

Comments
 (0)