From cc67107923929107a93eb12789d0767d8f14b4a8 Mon Sep 17 00:00:00 2001 From: Marcello Lamonaca Date: Fri, 14 Oct 2022 22:32:25 +0200 Subject: [PATCH] git: remove "how to" section and add other comman details --- docs/git/git.md | 111 +++++++++++++++++------------------------------- 1 file changed, 38 insertions(+), 73 deletions(-) diff --git a/docs/git/git.md b/docs/git/git.md index aefc372..0eee7f2 100644 --- a/docs/git/git.md +++ b/docs/git/git.md @@ -81,17 +81,20 @@ def load_reference(name_or_id): ## Commands -`git help `: get help for a git command +`git -h`: get help for a git command +`git --help`: get man page for a git command +`git -C `: execute a git commend in the specified path +`git ^`: operate on commit *before* the provided commit hash ### Create Repository `git init []`: initialize a brand new Git repository and begins tracking -`.gitignore`: specify intentionally untracked files to ignore +`.gitignore`: specify intentionally untracked files to ignore ### Config `git config --global user.name ""`: set name attached to commits -`git config --global user.email ""`: set email attached to commits +`git config --global user.email ""`: set email attached to commits `git config --global color.ui auto`: enable colorization of command line output ### Making Changes @@ -100,18 +103,19 @@ def load_reference(name_or_id): `git add `: add files to the staging area `git add -p `: interactively stage chunks of a file -`git blame `: show who last edited which line +`git blame `: show who last edited which line `git commit`: save the snapshot to the project history `git commit -m "message"`: commit and provide a message `git commit -a`: automatically notice any modified (but not new) files and commit -`git commit -v|--verbose`: show unified diff between the HEAD commit and what would be committed +`git commit -v|--verbose`: show unified diff between the HEAD commit and what would be committed `git diff `: show difference since the last commit `git diff `: show differences in a file since a particular snapshot `git diff `: show differences in a file between two snapshots `git diff --cached`: show what is about to be committed `git diff ...`: show content diff between two branches +`git diff -w`: show diff ignoring whitespace differences `git bisect`: binary search history (e.g. for regressions) @@ -128,29 +132,29 @@ def load_reference(name_or_id): `git remote`: list remotes `git remote -v`: list remotes names and URLs -`git remote show `: inspect the remote +`git remote show `: inspect the remote `git remote add `: add a remote -`git branch --set-upstream-to=/`: set up correspondence between local and remote branch +`git branch --set-upstream-to=/`: set up correspondence between local and remote branch -`git push`: send objects to default remote on current branch +`git push`: send objects to default remote on current branch `git push `: send objects to remote -`git push :`: send objects to remote, and update remote reference +`git push :`: send objects to remote, and update remote reference -`git push --force`: overwrite remote with local version -`git push --force-with-lease`: overwrite remote with local version if remote has not been modified +`git push --force`: overwrite remote with local version +`git push --force-with-lease`: overwrite remote with local version if remote has not been modified `git fetch []`: retrieve objects/references from a remote `git pull`: update the local branch with updates from its remote counterpart, same as `git fetch; git merge` `git pull -ff`: when possible resolve the merge as a fast-forward (only update branch pointer, don't create merge commit). Otherwise create a merge commit. -`git fetch && git show /`: show incoming changes +`git fetch && git show /`: show incoming changes `git clone []`: download repository and repo history from remote -`git clone --shallow`: clone only repo files, not history of commits +`git clone --shallow`: clone only repo files, not history of commits `git remote remove `: remove the specified remote -`git remote rename `: rename a remote +`git remote rename `: rename a remote ### Viewing Project History @@ -161,7 +165,8 @@ def load_reference(name_or_id): `git log --all --graph --decorate`: visualizes history as a DAG `git log --oneline`: compact log -`git shortlog`: list commits by author +`git shortlog`: list commits by author +`git reflog`: show record of when the tips of branches and other references were updated in the local repository `git show `: output metadata and content changes of commit `git cat-file -p `: output commit metadata @@ -193,8 +198,10 @@ It's generally recommended creating annotated tags so it's possible to have all ### Branching And Merging +![branch](../img/git_branches.png "how branches work") + `git branch`: shows branches -`git branch -vv`: show branch + last commit + remote status +`git branch -vv`: show branch + last commit + remote status `git branch --merged [--remote]`: show branches (remote) that have been merged into current one (needs same history, merge squash/rebase break history) `git branch `: create new branch @@ -202,79 +209,37 @@ It's generally recommended creating annotated tags so it's possible to have all `git branch`: show list of all existing branches (* indicates current) `git checkout `: change current branch (update HEAD) and update working directory `git branch -d `: delete specified branch -`git branch -m `: rename a branch without affecting the branch's history +`git branch -m `: rename a branch without affecting the branch's history `git merge `: merges into current branch `git merge --continue`: continue previous merge after solving a merge conflict `git mergetool`: use a fancy tool to help resolve merge conflicts -`git rebase`: rebase set of patches onto a new base -`git rebase -i`: interactive rebasing +`git rebase `: rebase current branch commits onto another branch -`git cherry-pick `: bring in a commit from another branch -`git cherry-pick ^..`: bring in a range of commits from another branch (first included) -`git cherry-pick ..`: bring in a range of commits from another branch (first excluded) +`git cherry-pick `: bring in a commit from another branch +`git cherry-pick ^..`: bring in a range of commits from another branch (first included) +`git cherry-pick ..`: bring in a range of commits from another branch (first excluded) ### Undo & [Rewriting History](https://www.themoderncoder.com/rewriting-git-history/) -`git rm -r --cached `: remove a file from being tracked +`git rm -r --cached `: remove a file from being tracked `git commit --amend`: replace last commit by creating a new one (can add files or rewrite commit message) `git commit --amend -m "amended message"`: replace last commit by creating a new one (can add files or rewrite commit message) -`git commit --amend --no-edit`: replace last commit by creating a new one (can add files or rewrite commit message) +`git commit --amend --no-edit`: replace last commit by creating a new one (can add files or rewrite commit message) `git reset HEAD `: unstage a file -`git reset `: undo all commits after specified commit, preserving changes locally +`git reset `: undo all commits after specified commit, preserving changes locally `git reset --soft `: revert to specific commit but keep changes and staged files `git reset --hard `: discard all history and changes back to specified commit `git checkout `: discard changes `git checkout -- `: discard changes, no output to screen -`git restore .`: discard uncommitted changes -`git restore `: discard uncommitted changes to file -`git restore --source `: revert file to commit version -`git restore `: recover deleted file if previously committed +`git restore .`: discard uncommitted changes +`git restore `: discard uncommitted changes to file +`git restore --source `: revert file to commit version +`git restore `: recover deleted file if previously committed -`git rebase -i HEAD~`: modify (reword, edit, drop, squash, merge, ...) *n* commits -`git rebase -i `: modify (reword, edit, drop, squash, merge, ...) *from* commit to latest +`git rebase -i HEAD~`: modify (reword, edit, drop, squash, merge, ...) *n* commits +`git rebase -i `: modify (reword, edit, drop, squash, merge, ...) *from* commit to latest -**WARNING**: Changing history can have nasty side effects - ---- - -## How To - -### Rebase Branches - -```ps1 -git checkout -git pull # get up to date - -git checkout -git rebase # rebase commits on master (moves branch start point on last master commit) - -git checkout -git rebase # moves commits from the branch on top of master -``` - -![branch](../img/git_branches.png "how branches work") - -### Clone Branches - -```ps1 -git clone # clone the repo - -git branch -r # show remote branches -git checkout # checkout remote branch (omit /) - -git pull # clone branch -``` - -### [Sync Forks](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/syncing-a-fork) - -```ps1 -git fetch upstream # Fetch the branches and their respective commits from the upstream repository -git checkout main # checkout fork's main primary branch - -git merge upstream/main # Merge the changes from the upstream default branch into the local default branch - -git push # update fork on GitHub -``` +> **WARN**: Changing history can have nasty side effects