Eric's Notes

Clone

Copy remote repositories.

Shallow Clone

Don’t download all the history, just the most recent commit.

git clone --depth 1

Clone to Specific Tag or Branch

Instead of downloading all the history of a repository just clone the repository at a specific tag or branch.

git clone --branch [TAG|BRANCH] --depth 1 https://example.com/my/repo.git

Commit

Adding and manipulating changes.

Delete Unstaged Changes

Get rid of any changes that havent been committed or staged for a commit.

git checkout HEAD -- FILE

Unstage File

Undo git add.

git reset -- FILE

Squashing Commits

Combine multiple commits into one commit. If you want to squash the last 3 commits: 1. Start the rebase process: bash git rebase -i HEAD~3 2. Write pick next to the oldest commit 3. Write squash in front of the commits to 4. Save the commit file and close the editor 5. Your text editor will reopen. Rewrite the commit message if you want. 6. Save the commit message and close the editor.

Merge

Merging branches.

Three Way Merge

This is useful when when you want to merge two branches that have diverged. That is, both branches have a common ancestor commit, but each branch has one or more unique commits. For example, say you have a branch called feature on which development is complete and which is ready to be merged into main. However, since feature was branched, main has new commits. The following will commands will merge the main branch into feature. This will make the feature ready to submit to master as a Pull Request.

git checkout feature
git rebase main

Alternatively, you can use git merge:

git checkout feature
git merge master

Submodules

Russian nesting dolls, but for git.

Adding a New Submodule

git submodule add URL [PATH]

Cloning a Repository with Submodules

git clone --recursive [URL]

Changing a Submodule

Update submodule (commit changes)
cd PARENT_PATH
git add SUBMODULE_PATH
git commit -m 'MESSAGE'

Pinning Submodule to Commit

cd SUBMODULE
git checkout COMMIT_HASH
cd GIT_PARENT
git add SUBMODULE_DIR/
git commit

Updating a Submodule to Reflect the Latest Changes on Remote Branch

cd SUBMODULE_PATH
git checkout main
git pull
cd PROJECT_ROOT
git add SUBMODULE_PATH
git commit -m ...

Removing a Submodule

git rm PATH
rm -rf .git/modules/PATH where SUBMODULE is the path parameter in .gitmodules:

[submodule "NAME"]
    path = PATH
    url = ...

Notes on Computers

AWS · Bash · C · C++ · Cyber Security · Git · LaTeX · Linux · Networking · Python · Raspberry Pi · Tools · Vim

Notes on Math & Physics

Information Theory · Linear Algebra · Solid State Physics

Git Cheatsheet