-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME_EN.txt
88 lines (68 loc) · 2.91 KB
/
README_EN.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
* README_EN.txt
* 2025.01.07
* externals
1. DESCRIPTION
2. EXTERNALS
2.1. Git `.gitmodules` support
2.1.1. `git_gen_gitmodules.sh` usage examples
-------------------------------------------------------------------------------
1. DESCRIPTION
-------------------------------------------------------------------------------
Description of global external dependencies applicable to multiple projects and
not described in detail in those projects.
-------------------------------------------------------------------------------
2. EXTERNALS
-------------------------------------------------------------------------------
All project externals are declared in `.externals*` file(s).
To clone only required directories of externals, you must use `vcstool` python
module with the sparse checkout feature and `.externals*` file(s), otherwise
the `git clone --recurse-submodules` would use `.gitmodules` (if has any) and
checkout all modules recursively and completely, including all subdirectories
which is not required to checkout.
To use the sparse checkout feature (partial checkout) you must install from a
forked repository:
>
python -m pip install git+https://github.com/aaronplusone/vcstool@feature-sparse-checkouts
Or
>
python -m pip install git+https://github.com/plusone-robotics/vcstool@por_master
NOTE:
Original repository: https://github.com/dirk-thomas/vcstool
-------------------------------------------------------------------------------
2.1. Git `.gitmodules` support
-------------------------------------------------------------------------------
To convert `vcstool` repositories file to Git `.gitmodules` format you can use
these scripts:
https://github.com/andry81/gitcmd/tree/HEAD/scripts/vcstool/git_gen_gitmodules.sh
https://github.com/andry81/gituserbin/tree/HEAD/gen-vcstool-gitmodules.sh
-------------------------------------------------------------------------------
2.1.1. `git_gen_gitmodules.sh` usage examples
-------------------------------------------------------------------------------
1. Convert each `.externals*` file into exising single `.gitmodules*` file.
>
cd myrepo/path
git_gen_gitmodules.sh -f
>
find . -name '.gitmodules*' -type f
2. Convert and append `.externals-*` into existing `.gitmodules`.
>
cd myrepo/path
git_gen_gitmodules.sh -fa . '.externals-*'
>
find . -name '.gitmodules' -type f
3. Convert and overwrite `.externals` into existing `.gitmodules`, and append
the rest `.externals-*`.
>
cd myrepo/path
git_gen_gitmodules.sh -fat
>
find . -name '.gitmodules' -type f
3. Convert and overwrite `.externals` into existing `.gitmodules`, and append
the rest `.externals-*`.
Generate submodule names from the `url` field instead of `repositories` key
values.
>
cd myrepo/path
git_gen_gitmodules.sh -fat --gen-submodule-name-from-url
>
find . -name '.gitmodules' -type f