Submodules vs subtrees comparison in Git - Quick Revision & Key Differences

Recall & Review

beginner

What is a Git submodule?

A Git submodule is a way to include one Git repository inside another as a separate folder. It keeps the external repo at a specific commit, allowing you to track it independently.

beginner

What is a Git subtree?

A Git subtree lets you merge another repository into a subdirectory of your repo. It copies the external repo's files and history, making it part of your main repo.

intermediate

How do submodules handle updates from the external repository?

Submodules require manual updating by running commands to fetch and checkout new commits in the submodule folder. They do not update automatically with the main repo.

intermediate

What is a key advantage of using Git subtrees over submodules?

Subtrees integrate the external repo fully into your main repo, so you don't need extra commands to clone or update. This makes it simpler for users who clone your repo.

intermediate

Name one challenge when using Git submodules.

One challenge is that submodules add complexity because users must remember to initialize and update them separately, which can cause confusion or errors if forgotten.

Which Git feature keeps an external repository as a separate folder linked to a specific commit?

A Subtree

B Submodule

C Branch

D Tag

Submodules link an external repo as a separate folder at a specific commit.

Which method fully integrates the external repository's files and history into your main repository?

A Submodule

B Fork

C Subtree

D Clone

Subtrees merge the external repo into your main repo, including its history.

What must you do after cloning a repository that uses submodules to get the submodule content?

A Nothing, submodules clone automatically

B Run 'git subtree pull'

C Run 'git fetch origin'

D Run 'git submodule update --init'

Submodules require manual initialization and update after cloning.

Which approach can cause confusion because it requires extra commands to keep external code updated?

A Submodule

B Branch

C Fork

D Subtree

Submodules need manual updates, which can confuse users.

Which Git feature is simpler for users cloning the repo because it does not require extra commands to get external code?

A Subtree

B Submodule

C Tag

D Branch

Subtrees include external code directly, so cloning gets everything at once.

Explain the main differences between Git submodules and Git subtrees.

Think about how each method handles external code and updates.

Describe a scenario where using Git submodules might be better than subtrees.

Consider control and separation of external code.

Practice

1. What is the main difference between Git submodules and Git subtrees?

easy

A. Submodules and subtrees are identical in how they manage external repositories.

B. Submodules copy external repositories; subtrees link them separately.

C. Submodules merge external repositories automatically; subtrees require manual merging.

D. Submodules link external repositories separately; subtrees copy them into your project.

Solution

1. Step 1: Understand submodules behavior

   Submodules keep external repositories linked but separate from the main project folder.

2. Step 2: Understand subtrees behavior

   Subtrees copy the external repository content directly into your project folder, making it part of your codebase.

3. Final Answer:

   Submodules link external repositories separately; subtrees copy them into your project. -> Option D

4. Quick Check:

   Submodules = separate links, Subtrees = copied content [OK]

Hint: Remember: submodules link, subtrees copy [OK]

Common Mistakes:

• Confusing which method copies code versus links it
• Thinking submodules merge code automatically
• Assuming subtrees keep repos separate

2. Which Git command correctly adds a submodule to your repository?

easy

A. git subtree add --prefix=folder_name repo_url branch

B. git submodule add repo_url folder_name

C. git add submodule repo_url folder_name

D. git clone --submodule repo_url folder_name

Solution

1. Step 1: Identify the correct syntax for adding a submodule

   The correct command is 'git submodule add' followed by the repository URL and the folder name.

2. Step 2: Verify other options

   git subtree add --prefix=folder_name repo_url branch is for subtrees, not submodules. git add submodule repo_url folder_name and git clone --submodule repo_url folder_name are invalid Git commands for adding submodules.

3. Final Answer:

   git submodule add repo_url folder_name -> Option B

4. Quick Check:

   Submodule add uses 'git submodule add' [OK]

Hint: Submodule add always starts with 'git submodule add' [OK]

Common Mistakes:

• Using 'git subtree add' for submodules
• Trying to add submodules with 'git add'
• Confusing clone options with submodule commands

3. Given the commands below, what will be the result after cloning a repository with a submodule?

git clone https://example.com/main-repo.git
cd main-repo
git submodule update --init --recursive

medium

A. Only the main repository is cloned; submodules remain empty folders.

B. The submodules are cloned but not initialized.

C. The main repository and all submodules are cloned and initialized.

D. The clone fails because submodules require separate cloning.

Solution

1. Step 1: Understand cloning with submodules

   Cloning the main repo alone does not fetch submodule content; submodules are empty initially.

2. Step 2: Use 'git submodule update --init --recursive'

   This command fetches and initializes all submodules recursively, filling their folders with content.

3. Final Answer:

   The main repository and all submodules are cloned and initialized. -> Option C

4. Quick Check:

   Submodule update with init fetches submodules [OK]

Hint: Run 'git submodule update --init --recursive' after clone [OK]

Common Mistakes:

• Assuming submodules clone automatically with main repo
• Skipping the submodule update command
• Confusing initialization with cloning

4. You added a subtree with git subtree add --prefix=lib https://example.com/lib.git main but later changes in the subtree are not reflected in your main repo. What is the likely cause?

medium

A. You forgot to pull subtree updates with git subtree pull.

B. Subtrees automatically sync changes; no action needed.

C. You must use git submodule update to sync subtrees.

D. Subtrees cannot be updated once added.

Solution

1. Step 1: Understand subtree update process

   Subtrees copy code but do not auto-sync; you must manually pull updates.

2. Step 2: Identify correct command to update subtree

   The command 'git subtree pull' fetches and merges changes from the external repo into your subtree folder.

3. Final Answer:

   You forgot to pull subtree updates with git subtree pull. -> Option A

4. Quick Check:

   Subtrees require manual pull to update [OK]

Hint: Use 'git subtree pull' to update subtree changes [OK]

Common Mistakes:

• Expecting automatic subtree sync
• Using submodule commands for subtrees
• Thinking subtrees are read-only

5. You want to include a third-party library in your project. You want to keep it separate for easy updates but also want your team to clone the project with one command without extra steps. Which approach is best?

hard

A. Use Git subtrees to copy the library into your project for simpler cloning.

B. Use Git submodules and instruct the team to run extra commands after cloning.

C. Manually copy the library files without Git integration.

D. Use Git submodules but disable recursive cloning.

Solution

1. Step 1: Analyze submodules pros and cons

   Submodules keep code separate but require extra commands after cloning to initialize submodules.

2. Step 2: Analyze subtrees pros and cons

   Subtrees copy the library into the project, so cloning is simple with one command and no extra steps.

3. Final Answer:

   Use Git subtrees to copy the library into your project for simpler cloning. -> Option A

4. Quick Check:

   Subtrees simplify cloning by embedding code [OK]

Hint: Subtrees = easy clone; submodules = extra steps [OK]

Common Mistakes:

• Choosing submodules despite extra clone steps
• Ignoring subtree benefits for team convenience
• Thinking manual copy is better than Git methods