title | teaching | exercises | questions | objectives | keypoints | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Exploring History |
25 |
0 |
|
|
|
As we saw in the previous lesson, we can refer to commits by their
identifiers. You can refer to the most recent commit of the working
directory by using the identifier HEAD
.
We've been adding one line at a time to mars.txt
, so it's easy to track our
progress by looking, so let's do that using our HEAD
s. Before we start,
let's make a change to mars.txt
.
$ nano mars.txt
$ cat mars.txt
{: .language-bash}
Cold and dry, but everything is my favorite color
The two moons may be a problem for Wolfman
But the Mummy will appreciate the lack of humidity
{: .output}
Now, let's see what we get.
$ git diff HEAD mars.txt
{: .language-bash}
diff --git a/mars.txt b/mars.txt
index b36abfd..0848c8d 100644
--- a/mars.txt
+++ b/mars.txt
@@ -1,3 +1,4 @@
Cold and dry, but everything is my favorite color
The two moons may be a problem for Wolfman
But the Mummy will appreciate the lack of humidity
{: .output}
which is the same as what you would get if you leave out HEAD
(try it). The
real goodness in all this is when you can refer to previous commits. We do
that by adding ~1
(where "~" is "tilde", pronounced [til-duh])
to refer to the commit one before HEAD
.
$ git diff HEAD~1 mars.txt
{: .language-bash}
If we want to see the differences between older commits we can use git diff
again, but with the notation HEAD~1
, HEAD~2
, and so on, to refer to them:
$ git diff HEAD~2 mars.txt
{: .language-bash}
diff --git a/mars.txt b/mars.txt
index df0654a..b36abfd 100644
--- a/mars.txt
+++ b/mars.txt
@@ -1 +1,4 @@
Cold and dry, but everything is my favorite color
+The two moons may be a problem for Wolfman
+But the Mummy will appreciate the lack of humidity
{: .output}
We could also use git show
which shows us what changes we made at an older commit as well as the commit message, rather than the differences between a commit and our working directory that we see by using git diff
.
$ git show HEAD~2 mars.txt
{: .language-bash}
commit 34961b159c27df3b475cfe4415d94a6d1fcd064d
Author: Vlad Dracula <[email protected]>
Date: Thu Aug 22 10:07:21 2013 -0400
Start notes on Mars as a base
diff --git a/mars.txt b/mars.txt
new file mode 100644
index 0000000..df0654a
--- /dev/null
+++ b/mars.txt
@@ -0,0 +1 @@
+Cold and dry, but everything is my favorite color
{: .output}
In this way,
we can build up a chain of commits.
The most recent end of the chain is referred to as HEAD
;
we can refer to previous commits using the ~
notation,
so HEAD~1
means "the previous commit",
while HEAD~123
goes back 123 commits from where we are now.
We can also refer to commits using
those long strings of digits and letters
that git log
displays.
These are unique IDs for the changes,
and "unique" really does mean unique:
every change to any set of files on any computer
has a unique 40-character identifier.
Our first commit was given the ID
f22b25e3233b4645dabd0d81e651fe074bd8e73b
,
so let's try this:
$ git diff f22b25e3233b4645dabd0d81e651fe074bd8e73b mars.txt
{: .language-bash}
diff --git a/mars.txt b/mars.txt
index df0654a..93a3e13 100644
--- a/mars.txt
+++ b/mars.txt
@@ -1 +1,4 @@
Cold and dry, but everything is my favorite color
+The two moons may be a problem for Wolfman
+But the Mummy will appreciate the lack of humidity
{: .output}
That's the right answer, but typing out random 40-character strings is annoying, so Git lets us use just the first few characters:
$ git diff f22b25e mars.txt
{: .language-bash}
diff --git a/mars.txt b/mars.txt
index df0654a..93a3e13 100644
--- a/mars.txt
+++ b/mars.txt
@@ -1 +1,4 @@
Cold and dry, but everything is my favorite color
+The two moons may be a problem for Wolfman
+But the Mummy will appreciate the lack of humidity
{: .output}
All right! So we can save changes to files and see what we've changed—now how can we restore older versions of things? Let's suppose we accidentally overwrite our file:
$ nano mars.txt
$ cat mars.txt
{: .language-bash}
We will need to manufacture our own oxygen
{: .output}
git status
now tells us that the file has been changed,
but those changes haven't been staged:
$ git status
{: .language-bash}
On branch master
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git checkout -- <file>..." to discard changes in working directory)
modified: mars.txt
no changes added to commit (use "git add" and/or "git commit -a")
{: .output}
We can put things back the way they were
by using git checkout
:
$ git checkout HEAD mars.txt
$ cat mars.txt
{: .language-bash}
Cold and dry, but everything is my favorite color
The two moons may be a problem for Wolfman
But the Mummy will appreciate the lack of humidity
{: .output}
As you might guess from its name,
git checkout
checks out (i.e., restores) an old version of a file.
In this case,
we're telling Git that we want to recover the version of the file recorded in HEAD
,
which is the last saved commit.
If we want to go back even further,
we can use a commit identifier instead:
$ git checkout f22b25e mars.txt
{: .language-bash}
$ cat mars.txt
{: .language-bash}
Cold and dry, but everything is my favorite color
{: .output}
$ git status
{: .language-bash}
# On branch master
Changes to be committed:
(use "git reset HEAD <file>..." to unstage)
# Changes not staged for commit:
# (use "git add <file>..." to update what will be committed)
# (use "git checkout -- <file>..." to discard changes in working directory)
#
# modified: mars.txt
#
no changes added to commit (use "git add" and/or "git commit -a")
{: .output}
Notice that the changes are on the staged area.
Again, we can put things back the way they were
by using git checkout
:
$ git checkout -f master mars.txt
{: .language-bash}
Above we used
$ git checkout f22b25e mars.txt
{: .language-bash}
to revert
mars.txt
to its state after the commitf22b25e
. But be careful! The commandcheckout
has other important functionalities and Git will misunderstand your intentions if you are not accurate with the typing. For example, if you forgetmars.txt
in the previous command. The "detached HEAD" is like "look, but don't touch" here, so you shouldn't make any changes in this state. After investigating your repo's past state, reattach yourHEAD
withgit checkout master
. {: .callout}
It's important to remember that
we must use the commit number that identifies the state of the repository
before the change we're trying to undo.
A common mistake is to use the number of
the commit in which we made the change we're trying to get rid of.
In the example below, we want to retrieve the state from before the most
recent commit (HEAD~1
), which is commit f22b25e
:
So, to put it all together, here's how Git works in cartoon form:
If you read the output of
git status
carefully, you'll see that it includes this hint:(use "git checkout -- <file>..." to discard changes in working directory)
{: .language-bash}
As it says,
git checkout
without a version identifier restores files to the state saved inHEAD
. The double dash--
is needed to separate the names of the files being recovered from the command itself: without it, Git would try to use the name of the file as the commit identifier. {: .callout}
The fact that files can be reverted one by one tends to change the way people organize their work. If everything is in one large document, it's hard (but not impossible) to undo changes to the introduction without also undoing changes made later to the conclusion. If the introduction and conclusion are stored in separate files, on the other hand, moving backward and forward in time becomes much easier.
Jennifer has made changes to the Python script that she has been working on for weeks, and the modifications she made this morning "broke" the script and it no longer runs. She has spent ~ 1hr trying to fix it, with no luck...
Luckily, she has been keeping track of her project's versions using Git! Which commands below will let her recover the last committed version of her Python script called
data_cruncher.py
?
$ git checkout HEAD
$ git checkout HEAD data_cruncher.py
$ git checkout HEAD~1 data_cruncher.py
$ git checkout <unique ID of last commit> data_cruncher.py
Both 2 and 4 {: .challenge}
Jennifer is collaborating on her Python script with her colleagues and realizes her last commit to the group repository is wrong and wants to undo it. Jennifer needs to undo correctly so everyone in the group repository gets the correct change.
git revert [wrong commit ID]
will make a new commit that undoes Jennifer's previous wrong commit. Thereforegit revert
is different thangit checkout [commit ID]
becausecheckout
is for local changes not committed to the group repository. Below are the right steps and explanations for Jennifer to usegit revert
, what is the missing command?
________ # Look at the git history of the project to find the commit ID
Copy the ID (the first few characters of the ID, e.g. 0b1d055).
git revert [commit ID]
Type in the new commit message.
Save and close {: .challenge}
What is the output of the last command in
$ cd planets $ echo "Venus is beautiful and full of love" > venus.txt $ git add venus.txt $ echo "Venus is too hot to be suitable as a base" >> venus.txt $ git commit -m "Comment on Venus as an unsuitable base" $ git checkout HEAD venus.txt $ cat venus.txt #this will print the contents of venus.txt to the screen
{: .language-bash}
Venus is too hot to be suitable as a base
{: .output}
Venus is beautiful and full of love
{: .output}
Venus is beautiful and full of love Venus is too hot to be suitable as a base
{: .output}
Error because you have changed venus.txt without committing the changes
{: .output}
The answer is 2 because
git add venus.txt
was used only before add the lineVenus is too hot to be suitable as a base
which was lost whengit checkout
was executed. Using the flag-a
withgit commit
would have prevented the lost. {: .solution} {: .challenge}
Consider this command:
git diff HEAD~3 mars.txt
. What do you predict this command will do if you execute it? What happens when you do execute it? Why?Try another command,
git diff [ID] mars.txt
, where [ID] is replaced with the unique identifier for your most recent commit. What do you think will happen, and what does happen? {: .challenge}
git checkout
can be used to restore a previous commit when unstaged changes have been made, but will it also work for changes that have been staged but not committed? Make a change tomars.txt
, add that change, and usegit checkout
to see if you can remove your change. {: .challenge}
Exploring history is an important part of git, often it is a challenge to find the right commit ID, especially if the commit is from several months ago.
Imagine the
planets
project has more than 50 files. You would like to find a commit with specific text inmars.txt
is modified. When you typegit log
, a very long list appeared, How can you narrow down the search?Recall that the
git diff
command allow us to explore one specific file, e.g.git diff mars.txt
. We can apply a similar idea here.$ git log mars.txt
{: .language-bash}
Unfortunately some of these commit messages are very ambiguous e.g.
update files
. How can you search through these files?Both
git diff
andgit log
are very useful and they summarize a different part of the history for you. Is it possible to combine both? Let's try the following:$ git log --patch mars.txt
{: .language-bash}
You should get a long list of output, and you should be able to see both commit messages and the difference between each commit.
Question: What does the following command do?
$ git log --patch HEAD~3 *.txt
{: .language-bash} {: .challenge}