Git - Submodules - Revision history

Pszlachta1 at 10:23, 3 June 2025

2025-06-03T10:23:11Z

← Older revision		Revision as of 10:23, 3 June 2025
Line 15:		Line 15:

	== Making 4 repos ==		== Making 4 repos ==
	<~~source~~ lang="bash">		<syntaxhighlight lang="bash">
	cd		cd
	mkdir g		mkdir g
Line 29:		Line 29:
	cd ..		cd ..
	done		done
	</~~source~~>		</syntaxhighlight>

	== Create superproject and add all the submodules ==		== Create superproject and add all the submodules ==
	<~~source~~ lang="bash">		<syntaxhighlight lang="bash">
	# necessary setup for file protocol		# necessary setup for file protocol
	git config --global protocol.file.allow always		git config --global protocol.file.allow always
Line 46:		Line 46:
	done		done
	git commit -m "Add submodules a, b, c and d."		git commit -m "Add submodules a, b, c and d."
	</~~source~~>		</syntaxhighlight>

	== Git submodule ==		== Git submodule ==
Line 55:		Line 55:

	== Cloning repos with submodules ==		== Cloning repos with submodules ==
	<~~source~~ lang="bash">		<syntaxhighlight lang="bash">
	git clone super cloned		git clone super cloned
	cd cloned		cd cloned
Line 66:		Line 66:
	ls -a a		ls -a a
	git submodule status		git submodule status
	</~~source~~>		</syntaxhighlight>

	Shorter way		Shorter way
	<~~source~~ lang="bash">		<syntaxhighlight lang="bash">
	git clone --recurse-submodules super clonedShorter		git clone --recurse-submodules super clonedShorter
	</~~source~~>		</syntaxhighlight>

	== Updating Submodules ==		== Updating Submodules ==
Line 77:		Line 77:

	=== Pulling ===		=== Pulling ===
	<~~source~~ lang="bash">		<syntaxhighlight lang="bash">
	# commit new changes to the subproject		# commit new changes to the subproject
	cd ~/g/a		cd ~/g/a
Line 96:		Line 96:
	git commit -am "upd a"		git commit -am "upd a"
	git log -p --submodule		git log -p --submodule
	</~~source~~>		</syntaxhighlight>

	Shorter way, for all submodules		Shorter way, for all submodules

Lsokolowski1: /* Create superproject and add all the submodules */

2023-08-29T19:21:29Z

Create superproject and add all the submodules

← Older revision		Revision as of 19:21, 29 August 2023
Line 33:		Line 33:
	== Create superproject and add all the submodules ==		== Create superproject and add all the submodules ==
	<source lang="bash">		<source lang="bash">
			# necessary setup for file protocol
			git config --global protocol.file.allow always
			#
	cd		cd
	mkdir super		mkdir super

Lsokolowski1: /* Submodule */

2023-08-29T18:54:10Z

Submodule

← Older revision		Revision as of 18:54, 29 August 2023
Line 2:		Line 2:

	== Submodule ==		== Submodule ==
	* Git does not allow partial checkouts		* Git does not allow partial checkouts by default (needs a special setup and treatment: git-scm.com/docs/partial-clone)
	* Copying libraries to git is one option, but in big projects it is impossible due to the size of the code		* Copying libraries to git is one option, but in big projects it is impossible due to the size of the code
	* Git's submodule support allows a repository to contain, as a subdirectory, a checkout of an external project.		* Git's submodule support allows a repository to contain, as a subdirectory, a checkout of an external project.

Łukasz Sokołowski: /* Tweaking the submodule */

2018-02-07T02:31:47Z

Tweaking the submodule

New page

[[Category:Git|090]]

== Submodule ==
* Git does not allow partial checkouts
* Copying libraries to git is one option, but in big projects it is impossible due to the size of the code
* Git's submodule support allows a repository to contain, as a subdirectory, a checkout of an external project.
* Submodules maintain their own identity; the submodule support just stores the submodule repository location and commit ID
* ("superproject") can easily clone all the submodules at the same revision
* Partial checkouts of the superproject are possible: you can tell Git to clone none, some or all of the submodules.

[[File:Git-s.png|200PX]]

== Examples ==
* We will create four repositories a,b,c,d in a /g folder

== Making 4 repos ==
<source lang="bash">
cd
mkdir g
cd g
for i in a b c d
do
mkdir $i
cd $i
git init
echo "module $i" > $i.txt
git add $i.txt
git commit -m "Initial commit, submodule $i"
cd ..
done
</source>

== Create superproject and add all the submodules ==
<source lang="bash">
cd
mkdir super
cd super
git init

for i in a b c d
do
git submodule add ~/g/$i $i
done
git commit -m "Add submodules a, b, c and d."
</source>

== Git submodule ==
* clones the submodule under the current directory and by default checks out the master branch.
* adds the submodule's clone path to the .gitmodules file and adds this file to the index, ready to be committed.
* adds the submodule's current commit ID to the index, ready to be committed.

== Cloning repos with submodules ==
<source lang="bash">
git clone super cloned
cd cloned
git submodule status
ls -a a

git submodule init # add the submodules repos URL to .git/config
git submodule update # clone submodule repos and check them out

ls -a a
git submodule status
</source>

Shorter way
<source lang="bash">
git clone --recurse-submodules super clonedShorter
</source>

== Updating Submodules ==
When the submodule will have updates

=== Pulling ===
<source lang="bash">
# commit new changes to the subproject
cd ~/g/a
echo something > newfile.txt
git add newfile.txt
git commit -m "new file"

# check it out in the superproject
cd ~/super/a
git pull

# look at it
cd ..
git diff
git diff --submodule

# save it and search it
git commit -am "upd a"
git log -p --submodule
</source>

Shorter way, for all submodules
<source lang="bash">
# commit new changes to the subproject b
cd ~/g/b
echo something >> b.txt
git commit -am "upd b"

# commit new changes to the subproject c
cd ~/g/c
echo something >> c.txt
git commit -am "upd b"

# pull in all subm
cd ~/super
git submodule update --remote

# look at it
git diff
git diff --submodule

# save it and search it
git commit -am "upd b and c"
git log -p --submodule
</source>

Updating the cloned one
<source lang="bash">
cd ~/cloned
git submodule update --remote
git diff --submodule
git pull
git log -p --submodule
</source>

=== Tweaking the submodule ===
Preparing the setup
<source lang="bash">
cd ~/g
git clone --bare a a.git
cd ~/g/a/
git remote add origin ~\g\a.git\
git push --set-upstream origin master

# Edit file '~/super/.gitmodules'
## [submodule "a"]
## path = a
## url = C:/Users/Lenovo/g/a.git
cd ~/super
git status
git commit -am "tweaking submodule setup"

cd ~
git clone --bare super super.git
cd ~/super
git remote add origin ~\super.git\
git push --set-upstream origin master

cd ~/super/a
git remote rm origin
git remote add origin ~\g\a.git\
git push --set-upstream origin master
</source>

Within subproject
<source lang="bash">
cd ~/g/a
echo "change in the upstream" >> a.txt
git commit -am "not dodgy hack"
git push
</source>

Within our super project submodule
<source lang="bash">
cd ~/super/a
echo "change a" >> a.txt
git commit -am "dodgy hack"
</source>

Finally in the super project
<source lang="bash">
cd ~/super
git submodule update --remote --merge
git status
git submodule status

cd ~/super/a
git checkout --theirs a.txt
git add .
git commit -m "the upstream better"

cd ~/super
git diff
git diff --submodule
git commit -am "main line"
git push --recurse-submodules=on-demand
</source>