diff --git a/_sync_state/book-fa.sha b/_sync_state/book-fa.sha
new file mode 100644
index 0000000000..3d2786bad4
--- /dev/null
+++ b/_sync_state/book-fa.sha
@@ -0,0 +1 @@
+79caeb435d3429fff55e4aaf5f21d7e7030dc153
diff --git a/content/book/fa/_index.html b/content/book/fa/_index.html
new file mode 100644
index 0000000000..8520111885
--- /dev/null
+++ b/content/book/fa/_index.html
@@ -0,0 +1,3 @@
+---
+redirect_to: "book/fa/v2"
+---
diff --git a/content/book/fa/v2/Customizing-Git-An-Example-Git-Enforced-Policy.html b/content/book/fa/v2/Customizing-Git-An-Example-Git-Enforced-Policy.html
new file mode 100644
index 0000000000..b69647a75b
--- /dev/null
+++ b/content/book/fa/v2/Customizing-Git-An-Example-Git-Enforced-Policy.html
@@ -0,0 +1,522 @@
+---
+category: book
+section: documentation
+subsection: book
+sidebar: book
+book:
+ language_code: fa
+ chapter:
+ title: Customizing Git
+ number: 8
+ section:
+ title: An Example Git-Enforced Policy
+ number: 4
+ cs_number: '8.4'
+ previous: book/fa/v2/Customizing-Git-Git-Hooks
+ next: book/fa/v2/Customizing-Git-Summary
+title: Git - An Example Git-Enforced Policy
+
+---
+An Example Git-Enforced Policy
+
+
+In this section, you’ll use what you’ve learned to establish a Git workflow that checks for a custom commit message format, and allows only certain users to modify certain subdirectories in a project.
+You’ll build client scripts that help the developer know if their push will be rejected and server scripts that actually enforce the policies.
+
+
The scripts we’ll show are written in Ruby; partly because of our intellectual inertia, but also because Ruby is easy to read, even if you can’t necessarily write it.
+However, any language will work – all the sample hook scripts distributed with Git are in either Perl or Bash, so you can also see plenty of examples of hooks in those languages by looking at the samples.
+
+
Server-Side Hook
+
+
All the server-side work will go into the update file in your hooks directory.
+The update hook runs once per branch being pushed and takes three arguments:
+
+
+
+-
+
The name of the reference being pushed to
+
+-
+
The old revision where that branch was
+
+-
+
The new revision being pushed
+
+
+
+
+
You also have access to the user doing the pushing if the push is being run over SSH.
+If you’ve allowed everyone to connect with a single user (like “git”) via public-key authentication, you may have to give that user a shell wrapper that determines which user is connecting based on the public key, and set an environment variable accordingly.
+Here we’ll assume the connecting user is in the $USER environment variable, so your update script begins by gathering all the information you need:
+
+
+
+
#!/usr/bin/env ruby
+
+$refname = ARGV[0]
+$oldrev = ARGV[1]
+$newrev = ARGV[2]
+$user = ENV['USER']
+
+puts "Enforcing Policies..."
+puts "(#{$refname}) (#{$oldrev[0,6]}) (#{$newrev[0,6]})"
+
+
+
+
Yes, those are global variables.
+Don’t judge – it’s easier to demonstrate this way.
+
+
+
+
+
Your first challenge is to enforce that each commit message adheres to a particular format.
+Just to have a target, assume that each message has to include a string that looks like “ref: 1234” because you want each commit to link to a work item in your ticketing system.
+You must look at each commit being pushed up, see if that string is in the commit message, and, if the string is absent from any of the commits, exit non-zero so the push is rejected.
+
+
+
You can get a list of the SHA-1 values of all the commits that are being pushed by taking the $newrev and $oldrev values and passing them to a Git plumbing command called git rev-list.
+This is basically the git log command, but by default it prints out only the SHA-1 values and no other information.
+So, to get a list of all the commit SHA-1s introduced between one commit SHA-1 and another, you can run something like this:
+
+
+
+
$ git rev-list 538c33..d14fc7
+d14fc7c847ab946ec39590d87783c69b031bdfb7
+9f585da4401b0a3999e84113824d15245c13f0be
+234071a1be950e2a8d078e6141f5cd20c1e61ad3
+dfa04c9ef3d5197182f13fb5b9b1fb7717d2222a
+17716ec0f1ff5c77eff40b7fe912f9f6cfd0e475
+
+
+
+
You can take that output, loop through each of those commit SHA-1s, grab the message for it, and test that message against a regular expression that looks for a pattern.
+
+
+
You have to figure out how to get the commit message from each of these commits to test.
+To get the raw commit data, you can use another plumbing command called git cat-file.
+We’ll go over all these plumbing commands in detail in Git Internals; but for now, here’s what that command gives you:
+
+
+
+
$ git cat-file commit ca82a6
+tree cfda3bf379e4f8dba8717dee55aab78aef7f4daf
+parent 085bb3bcb608e1e8451d4b2432f8ecbe6306e7e7
+author Scott Chacon <schacon@gmail.com> 1205815931 -0700
+committer Scott Chacon <schacon@gmail.com> 1240030591 -0700
+
+Change the version number
+
+
+
+
A simple way to get the commit message from a commit when you have the SHA-1 value is to go to the first blank line and take everything after that.
+You can do so with the sed command on Unix systems:
+
+
+
+
$ git cat-file commit ca82a6 | sed '1,/^$/d'
+Change the version number
+
+
+
+
You can use that incantation to grab the commit message from each commit that is trying to be pushed and exit if you see anything that doesn’t match.
+To exit the script and reject the push, exit non-zero.
+The whole method looks like this:
+
+
+
+
$regex = /\[ref: (\d+)\]/
+
+# enforced custom commit message format
+def check_message_format
+ missed_revs = `git rev-list #{$oldrev}..#{$newrev}`.split("\n")
+ missed_revs.each do |rev|
+ message = `git cat-file commit #{rev} | sed '1,/^$/d'`
+ if !$regex.match(message)
+ puts "[POLICY] Your message is not formatted correctly"
+ exit 1
+ end
+ end
+end
+check_message_format
+
+
+
+
Putting that in your update script will reject updates that contain commits that have messages that don’t adhere to your rule.
+
+
+
+
Enforcing a User-Based ACL System
+
+
Suppose you want to add a mechanism that uses an access control list (ACL) that specifies which users are allowed to push changes to which parts of your projects.
+Some people have full access, and others can only push changes to certain subdirectories or specific files.
+To enforce this, you’ll write those rules to a file named acl that lives in your bare Git repository on the server.
+You’ll have the update hook look at those rules, see what files are being introduced for all the commits being pushed, and determine whether the user doing the push has access to update all those files.
+
+
+
The first thing you’ll do is write your ACL.
+Here you’ll use a format very much like the CVS ACL mechanism: it uses a series of lines, where the first field is avail or unavail, the next field is a comma-delimited list of the users to which the rule applies, and the last field is the path to which the rule applies (blank meaning open access).
+All of these fields are delimited by a pipe (|) character.
+
+
+
In this case, you have a couple of administrators, some documentation writers with access to the doc directory, and one developer who only has access to the lib and tests directories, and your ACL file looks like this:
+
+
+
+
avail|nickh,pjhyett,defunkt,tpw
+avail|usinclair,cdickens,ebronte|doc
+avail|schacon|lib
+avail|schacon|tests
+
+
+
+
You begin by reading this data into a structure that you can use.
+In this case, to keep the example simple, you’ll only enforce the avail directives.
+Here is a method that gives you an associative array where the key is the user name and the value is an array of paths to which the user has write access:
+
+
+
+
def get_acl_access_data(acl_file)
+ # read in ACL data
+ acl_file = File.read(acl_file).split("\n").reject { |line| line == '' }
+ access = {}
+ acl_file.each do |line|
+ avail, users, path = line.split('|')
+ next unless avail == 'avail'
+ users.split(',').each do |user|
+ access[user] ||= []
+ access[user] << path
+ end
+ end
+ access
+end
+
+
+
+
On the ACL file you looked at earlier, this get_acl_access_data method returns a data structure that looks like this:
+
+
+
+
{"defunkt"=>[nil],
+ "tpw"=>[nil],
+ "nickh"=>[nil],
+ "pjhyett"=>[nil],
+ "schacon"=>["lib", "tests"],
+ "cdickens"=>["doc"],
+ "usinclair"=>["doc"],
+ "ebronte"=>["doc"]}
+
+
+
+
Now that you have the permissions sorted out, you need to determine what paths the commits being pushed have modified, so you can make sure the user who’s pushing has access to all of them.
+
+
+
You can pretty easily see what files have been modified in a single commit with the --name-only option to the git log command (mentioned briefly in مقدمات گیت):
+
+
+
+
$ git log -1 --name-only --pretty=format:'' 9f585d
+
+README
+lib/test.rb
+
+
+
+
If you use the ACL structure returned from the get_acl_access_data method and check it against the listed files in each of the commits, you can determine whether the user has access to push all of their commits:
+
+
+
+
# only allows certain users to modify certain subdirectories in a project
+def check_directory_perms
+ access = get_acl_access_data('acl')
+
+ # see if anyone is trying to push something they can't
+ new_commits = `git rev-list #{$oldrev}..#{$newrev}`.split("\n")
+ new_commits.each do |rev|
+ files_modified = `git log -1 --name-only --pretty=format:'' #{rev}`.split("\n")
+ files_modified.each do |path|
+ next if path.size == 0
+ has_file_access = false
+ access[$user].each do |access_path|
+ if !access_path # user has access to everything
+ || (path.start_with? access_path) # access to this path
+ has_file_access = true
+ end
+ end
+ if !has_file_access
+ puts "[POLICY] You do not have access to push to #{path}"
+ exit 1
+ end
+ end
+ end
+end
+
+check_directory_perms
+
+
+
+
You get a list of new commits being pushed to your server with git rev-list.
+Then, for each of those commits, you find which files are modified and make sure the user who’s pushing has access to all the paths being modified.
+
+
+
Now your users can’t push any commits with badly formed messages or with modified files outside of their designated paths.
+
+
+
+
Testing It Out
+
+
If you run chmod u+x .git/hooks/update, which is the file into which you should have put all this code, and then try to push a commit with a non-compliant message, you get something like this:
+
+
+
+
$ git push -f origin master
+Counting objects: 5, done.
+Compressing objects: 100% (3/3), done.
+Writing objects: 100% (3/3), 323 bytes, done.
+Total 3 (delta 1), reused 0 (delta 0)
+Unpacking objects: 100% (3/3), done.
+Enforcing Policies...
+(refs/heads/master) (8338c5) (c5b616)
+[POLICY] Your message is not formatted correctly
+error: hooks/update exited with error code 1
+error: hook declined to update refs/heads/master
+To git@gitserver:project.git
+ ! [remote rejected] master -> master (hook declined)
+error: failed to push some refs to 'git@gitserver:project.git'
+
+
+
+
There are a couple of interesting things here.
+First, you see this where the hook starts running.
+
+
+
+
Enforcing Policies...
+(refs/heads/master) (fb8c72) (c56860)
+
+
+
+
Remember that you printed that out at the very beginning of your update script.
+Anything your script echoes to stdout will be transferred to the client.
+
+
+
The next thing you’ll notice is the error message.
+
+
+
+
[POLICY] Your message is not formatted correctly
+error: hooks/update exited with error code 1
+error: hook declined to update refs/heads/master
+
+
+
+
The first line was printed out by you, the other two were Git telling you that the update script exited non-zero and that is what is declining your push.
+Lastly, you have this:
+
+
+
+
To git@gitserver:project.git
+ ! [remote rejected] master -> master (hook declined)
+error: failed to push some refs to 'git@gitserver:project.git'
+
+
+
+
You’ll see a remote rejected message for each reference that your hook declined, and it tells you that it was declined specifically because of a hook failure.
+
+
+
Furthermore, if someone tries to edit a file they don’t have access to and push a commit containing it, they will see something similar.
+For instance, if a documentation author tries to push a commit modifying something in the lib directory, they see
+
+
+
+
[POLICY] You do not have access to push to lib/test.rb
+
+
+
+
From now on, as long as that update script is there and executable, your repository will never have a commit message without your pattern in it, and your users will be sandboxed.
+
+
+
+
Client-Side Hooks
+
+
The downside to this approach is the whining that will inevitably result when your users' commit pushes are rejected.
+Having their carefully crafted work rejected at the last minute can be extremely frustrating and confusing; and furthermore, they will have to edit their history to correct it, which isn’t always for the faint of heart.
+
+
+
The answer to this dilemma is to provide some client-side hooks that users can run to notify them when they’re doing something that the server is likely to reject.
+That way, they can correct any problems before committing and before those issues become more difficult to fix.
+Because hooks aren’t transferred with a clone of a project, you must distribute these scripts some other way and then have your users copy them to their .git/hooks directory and make them executable.
+You can distribute these hooks within the project or in a separate project, but Git won’t set them up automatically.
+
+
+
To begin, you should check your commit message just before each commit is recorded, so you know the server won’t reject your changes due to badly formatted commit messages.
+To do this, you can add the commit-msg hook.
+If you have it read the message from the file passed as the first argument and compare that to the pattern, you can force Git to abort the commit if there is no match:
+
+
+
+
#!/usr/bin/env ruby
+message_file = ARGV[0]
+message = File.read(message_file)
+
+$regex = /\[ref: (\d+)\]/
+
+if !$regex.match(message)
+ puts "[POLICY] Your message is not formatted correctly"
+ exit 1
+end
+
+
+
+
If that script is in place (in .git/hooks/commit-msg) and executable, and you commit with a message that isn’t properly formatted, you see this:
+
+
+
+
$ git commit -am 'Test'
+[POLICY] Your message is not formatted correctly
+
+
+
+
No commit was completed in that instance.
+However, if your message contains the proper pattern, Git allows you to commit:
+
+
+
+
$ git commit -am 'Test [ref: 132]'
+[master e05c914] Test [ref: 132]
+ 1 file changed, 1 insertions(+), 0 deletions(-)
+
+
+
+
Next, you want to make sure you aren’t modifying files that are outside your ACL scope.
+If your project’s .git directory contains a copy of the ACL file you used previously, then the following pre-commit script will enforce those constraints for you:
+
+
+
+
#!/usr/bin/env ruby
+
+$user = ENV['USER']
+
+# [ insert acl_access_data method from above ]
+
+# only allows certain users to modify certain subdirectories in a project
+def check_directory_perms
+ access = get_acl_access_data('.git/acl')
+
+ files_modified = `git diff-index --cached --name-only HEAD`.split("\n")
+ files_modified.each do |path|
+ next if path.size == 0
+ has_file_access = false
+ access[$user].each do |access_path|
+ if !access_path || (path.index(access_path) == 0)
+ has_file_access = true
+ end
+ if !has_file_access
+ puts "[POLICY] You do not have access to push to #{path}"
+ exit 1
+ end
+ end
+end
+
+check_directory_perms
+
+
+
+
This is roughly the same script as the server-side part, but with two important differences.
+First, the ACL file is in a different place, because this script runs from your working directory, not from your .git directory.
+You have to change the path to the ACL file from this
+
+
+
+
access = get_acl_access_data('acl')
+
+
+
+
+
+
access = get_acl_access_data('.git/acl')
+
+
+
+
The other important difference is the way you get a listing of the files that have been changed.
+Because the server-side method looks at the log of commits, and, at this point, the commit hasn’t been recorded yet, you must get your file listing from the staging area instead.
+Instead of
+
+
+
+
files_modified = `git log -1 --name-only --pretty=format:'' #{ref}`
+
+
+
+
+
+
files_modified = `git diff-index --cached --name-only HEAD`
+
+
+
+
But those are the only two differences – otherwise, the script works the same way.
+One caveat is that it expects you to be running locally as the same user you push as to the remote machine.
+If that is different, you must set the $user variable manually.
+
+
+
One other thing we can do here is make sure the user doesn’t push non-fast-forwarded references.
+To get a reference that isn’t a fast-forward, you either have to rebase past a commit you’ve already pushed up or try pushing a different local branch up to the same remote branch.
+
+
+
Presumably, the server is already configured with receive.denyDeletes and receive.denyNonFastForwards to enforce this policy, so the only accidental thing you can try to catch is rebasing commits that have already been pushed.
+
+
+
Here is an example pre-rebase script that checks for that.
+It gets a list of all the commits you’re about to rewrite and checks whether they exist in any of your remote references.
+If it sees one that is reachable from one of your remote references, it aborts the rebase.
+
+
+
+
#!/usr/bin/env ruby
+
+base_branch = ARGV[0]
+if ARGV[1]
+ topic_branch = ARGV[1]
+else
+ topic_branch = "HEAD"
+end
+
+target_shas = `git rev-list #{base_branch}..#{topic_branch}`.split("\n")
+remote_refs = `git branch -r`.split("\n").map { |r| r.strip }
+
+target_shas.each do |sha|
+ remote_refs.each do |remote_ref|
+ shas_pushed = `git rev-list ^#{sha}^@ refs/remotes/#{remote_ref}`
+ if shas_pushed.split("\n").include?(sha)
+ puts "[POLICY] Commit #{sha} has already been pushed to #{remote_ref}"
+ exit 1
+ end
+ end
+end
+
+
+
+
This script uses a syntax that wasn’t covered in Revision Selection.
+You get a list of commits that have already been pushed up by running this:
+
+
+
+
`git rev-list ^#{sha}^@ refs/remotes/#{remote_ref}`
+
+
+
+
The SHA^@ syntax resolves to all the parents of that commit.
+You’re looking for any commit that is reachable from the last commit on the remote and that isn’t reachable from any parent of any of the SHA-1s you’re trying to push up – meaning it’s a fast-forward.
+
+
+
The main drawback to this approach is that it can be very slow and is often unnecessary – if you don’t try to force the push with -f, the server will warn you and not accept the push.
+However, it’s an interesting exercise and can in theory help you avoid a rebase that you might later have to go back and fix.
+
+
Git Attributes
+
+
+Some of these settings can also be specified for a path, so that Git applies those settings only for a subdirectory or subset of files.
+These path-specific settings are called Git attributes and are set either in a .gitattributes file in one of your directories (normally the root of your project) or in the .git/info/attributes file if you don’t want the attributes file committed with your project.
+
+
Using attributes, you can do things like specify separate merge strategies for individual files or directories in your project, tell Git how to diff non-text files, or have Git filter content before you check it into or out of Git.
+In this section, you’ll learn about some of the attributes you can set on your paths in your Git project and see a few examples of using this feature in practice.
+
+
Binary Files
+
+
+One cool trick for which you can use Git attributes is telling Git which files are binary (in cases it otherwise may not be able to figure out) and giving Git special instructions about how to handle those files.
+For instance, some text files may be machine generated and not diffable, whereas some binary files can be diffed.
+You’ll see how to tell Git which is which.
+
+
+
Identifying Binary Files
+
+
Some files look like text files but for all intents and purposes are to be treated as binary data.
+For instance, Xcode projects on macOS contain a file that ends in .pbxproj, which is basically a JSON (plain-text JavaScript data format) dataset written out to disk by the IDE, which records your build settings and so on.
+Although it’s technically a text file (because it’s all UTF-8), you don’t want to treat it as such because it’s really a lightweight database – you can’t merge the contents if two people change it, and diffs generally aren’t helpful.
+The file is meant to be consumed by a machine.
+In essence, you want to treat it like a binary file.
+
+
+
To tell Git to treat all pbxproj files as binary data, add the following line to your .gitattributes file:
+
+
+
+
Now, Git won’t try to convert or fix CRLF issues; nor will it try to compute or print a diff for changes in this file when you run git show or git diff on your project.
+
+
+
+
Diffing Binary Files
+
+
You can also use the Git attributes functionality to effectively diff binary files.
+You do this by telling Git how to convert your binary data to a text format that can be compared via the normal diff.
+
+
+
First, you’ll use this technique to solve one of the most annoying problems known to humanity: version-controlling Microsoft Word documents.
+Everyone knows that Word is the most horrific editor around, but oddly, everyone still uses it.
+If you want to version-control Word documents, you can stick them in a Git repository and commit every once in a while; but what good does that do?
+If you run git diff normally, you only see something like this:
+
+
+
+
$ git diff
+diff --git a/chapter1.docx b/chapter1.docx
+index 88839c4..4afcb7c 100644
+Binary files a/chapter1.docx and b/chapter1.docx differ
+
+
+
+
You can’t directly compare two versions unless you check them out and scan them manually, right?
+It turns out you can do this fairly well using Git attributes.
+Put the following line in your .gitattributes file:
+
+
+
+
This tells Git that any file that matches this pattern (.docx) should use the “word” filter when you try to view a diff that contains changes.
+What is the “word” filter?
+You have to set it up.
+Here you’ll configure Git to use the docx2txt program to convert Word documents into readable text files, which it will then diff properly.
+
+
+
First, you’ll need to install docx2txt; you can download it from https://sourceforge.net/projects/docx2txt.
+Follow the instructions in the INSTALL file to put it somewhere your shell can find it.
+Next, you’ll write a wrapper script to convert output to the format Git expects.
+Create a file that’s somewhere in your path called docx2txt, and add these contents:
+
+
+
+
#!/bin/bash
+docx2txt.pl "$1" -
+
+
+
+
Don’t forget to chmod a+x that file.
+Finally, you can configure Git to use this script:
+
+
+
+
$ git config diff.word.textconv docx2txt
+
+
+
+
Now Git knows that if it tries to do a diff between two snapshots, and any of the files end in .docx, it should run those files through the “word” filter, which is defined as the docx2txt program.
+This effectively makes nice text-based versions of your Word files before attempting to diff them.
+
+
+
Here’s an example: Chapter 1 of this book was converted to Word format and committed in a Git repository.
+Then a new paragraph was added.
+Here’s what git diff shows:
+
+
+
+
$ git diff
+diff --git a/chapter1.docx b/chapter1.docx
+index 0b013ca..ba25db5 100644
+--- a/chapter1.docx
++++ b/chapter1.docx
+@@ -2,6 +2,7 @@
+ This chapter will be about getting started with Git. We will begin at the beginning by explaining some background on version control tools, then move on to how to get Git running on your system and finally how to get it setup to start working with. At the end of this chapter you should understand why Git is around, why you should use it and you should be all setup to do so.
+ 1.1. About Version Control
+ What is "version control", and why should you care? Version control is a system that records changes to a file or set of files over time so that you can recall specific versions later. For the examples in this book you will use software source code as the files being version controlled, though in reality you can do this with nearly any type of file on a computer.
++Testing: 1, 2, 3.
+ If you are a graphic or web designer and want to keep every version of an image or layout (which you would most certainly want to), a Version Control System (VCS) is a very wise thing to use. It allows you to revert files back to a previous state, revert the entire project back to a previous state, compare changes over time, see who last modified something that might be causing a problem, who introduced an issue and when, and more. Using a VCS also generally means that if you screw things up or lose files, you can easily recover. In addition, you get all this for very little overhead.
+ 1.1.1. Local Version Control Systems
+ Many people's version-control method of choice is to copy files into another directory (perhaps a time-stamped directory, if they're clever). This approach is very common because it is so simple, but it is also incredibly error prone. It is easy to forget which directory you're in and accidentally write to the wrong file or copy over files you don't mean to.
+
+
+
+
Git successfully and succinctly tells us that we added the string “Testing: 1, 2, 3.”, which is correct.
+It’s not perfect – formatting changes wouldn’t show up here – but it certainly works.
+
+
+
Another interesting problem you can solve this way involves diffing image files.
+One way to do this is to run image files through a filter that extracts their EXIF information – metadata that is recorded with most image formats.
+If you download and install the exiftool program, you can use it to convert your images into text about the metadata, so at least the diff will show you a textual representation of any changes that happened.
+Put the following line in your .gitattributes file:
+
+
+
+
Configure Git to use this tool:
+
+
+
+
$ git config diff.exif.textconv exiftool
+
+
+
+
If you replace an image in your project and run git diff, you see something like this:
+
+
+
+
diff --git a/image.png b/image.png
+index 88839c4..4afcb7c 100644
+--- a/image.png
++++ b/image.png
+@@ -1,12 +1,12 @@
+ ExifTool Version Number : 7.74
+-File Size : 70 kB
+-File Modification Date/Time : 2009:04:21 07:02:45-07:00
++File Size : 94 kB
++File Modification Date/Time : 2009:04:21 07:02:43-07:00
+ File Type : PNG
+ MIME Type : image/png
+-Image Width : 1058
+-Image Height : 889
++Image Width : 1056
++Image Height : 827
+ Bit Depth : 8
+ Color Type : RGB with Alpha
+
+
+
+
You can easily see that the file size and image dimensions have both changed.
+
+
+
+
Keyword Expansion
+
+
+SVN- or CVS-style keyword expansion is often requested by developers used to those systems.
+The main problem with this in Git is that you can’t modify a file with information about the commit after you’ve committed, because Git checksums the file first.
+However, you can inject text into a file when it’s checked out and remove it again before it’s added to a commit.
+Git attributes offers you two ways to do this.
+
+
+
First, you can inject the SHA-1 checksum of a blob into an $Id$ field in the file automatically.
+If you set this attribute on a file or set of files, then the next time you check out that branch, Git will replace that field with the SHA-1 of the blob.
+It’s important to notice that it isn’t the SHA-1 of the commit, but of the blob itself.
+Put the following line in your .gitattributes file:
+
+
+
+
Add an $Id$ reference to a test file:
+
+
+
+
$ echo '$Id$' > test.txt
+
+
+
+
The next time you check out this file, Git injects the SHA-1 of the blob:
+
+
+
+
$ rm test.txt
+$ git checkout -- test.txt
+$ cat test.txt
+$Id: 42812b7653c7b88933f8a9d6cad0ca16714b9bb3 $
+
+
+
+
However, that result is of limited use.
+If you’ve used keyword substitution in CVS or Subversion, you can include a datestamp – the SHA-1 isn’t all that helpful, because it’s fairly random and you can’t tell if one SHA-1 is older or newer than another just by looking at them.
+
+
+
It turns out that you can write your own filters for doing substitutions in files on commit/checkout.
+These are called “clean” and “smudge” filters.
+In the .gitattributes file, you can set a filter for particular paths and then set up scripts that will process files just before they’re checked out (“smudge”, see The “smudge” filter is run on checkout.) and just before they’re staged (“clean”, see The “clean” filter is run when files are staged.).
+These filters can be set to do all sorts of fun things.
+
+
+
+
}}" alt="The ``smudge'' filter is run on checkout.">
+
+
نمودار 144. The “smudge” filter is run on checkout.
+
+
+
+
}}" alt="The ``clean'' filter is run when files are staged.">
+
+
نمودار 145. The “clean” filter is run when files are staged.
+
+
+
The original commit message for this feature gives a simple example of running all your C source code through the indent program before committing.
+You can set it up by setting the filter attribute in your .gitattributes file to filter *.c files with the “indent” filter:
+
+
+
+
Then, tell Git what the “indent” filter does on smudge and clean:
+
+
+
+
$ git config --global filter.indent.clean indent
+$ git config --global filter.indent.smudge cat
+
+
+
+
In this case, when you commit files that match *.c, Git will run them through the indent program before it stages them and then run them through the cat program before it checks them back out onto disk.
+The cat program does essentially nothing: it spits out the same data that it comes in.
+This combination effectively filters all C source code files through indent before committing.
+
+
+
Another interesting example gets $Date$ keyword expansion, RCS style.
+To do this properly, you need a small script that takes a filename, figures out the last commit date for this project, and inserts the date into the file.
+Here is a small Ruby script that does that:
+
+
+
+
#! /usr/bin/env ruby
+data = STDIN.read
+last_date = `git log --pretty=format:"%ad" -1`
+puts data.gsub('$Date$', '$Date: ' + last_date.to_s + '$')
+
+
+
+
All the script does is get the latest commit date from the git log command, stick that into any $Date$ strings it sees in stdin, and print the results – it should be simple to do in whatever language you’re most comfortable in.
+You can name this file expand_date and put it in your path.
+Now, you need to set up a filter in Git (call it dater) and tell it to use your expand_date filter to smudge the files on checkout.
+You’ll use a Perl expression to clean that up on commit:
+
+
+
+
$ git config filter.dater.smudge expand_date
+$ git config filter.dater.clean 'perl -pe "s/\\\$Date[^\\\$]*\\\$/\\\$Date\\\$/"'
+
+
+
+
This Perl snippet strips out anything it sees in a $Date$ string, to get back to where you started.
+Now that your filter is ready, you can test it by setting up a Git attribute for that file that engages the new filter and creating a file with your $Date$ keyword:
+
+
+
+
date*.txt filter=dater
+
+
+
+
+
$ echo '# $Date$' > date_test.txt
+
+
+
+
If you commit those changes and check out the file again, you see the keyword properly substituted:
+
+
+
+
$ git add date_test.txt .gitattributes
+$ git commit -m "Test date expansion in Git"
+$ rm date_test.txt
+$ git checkout date_test.txt
+$ cat date_test.txt
+# $Date: Tue Apr 21 07:26:52 2009 -0700$
+
+
+
+
You can see how powerful this technique can be for customized applications.
+You have to be careful, though, because the .gitattributes file is committed and passed around with the project, but the driver (in this case, dater) isn’t, so it won’t work everywhere.
+When you design these filters, they should be able to fail gracefully and have the project still work properly.
+
+
+
Exporting Your Repository
+
+
+Git attribute data also allows you to do some interesting things when exporting an archive of your project.
+
+
+
export-ignore
+
+
You can tell Git not to export certain files or directories when generating an archive.
+If there is a subdirectory or file that you don’t want to include in your archive file but that you do want checked into your project, you can determine those files via the export-ignore attribute.
+
+
+
For example, say you have some test files in a test/ subdirectory, and it doesn’t make sense to include them in the tarball export of your project.
+You can add the following line to your Git attributes file:
+
+
+
+
Now, when you run git archive to create a tarball of your project, that directory won’t be included in the archive.
+
+
+
+
export-subst
+
+
When exporting files for deployment you can apply git log's formatting and keyword-expansion processing to selected portions of files marked with the export-subst attribute.
+
+
+
For instance, if you want to include a file named LAST_COMMIT in your project, and have metadata about the last commit automatically injected into it when git archive runs, you can for example set up your .gitattributes and LAST_COMMIT files like this:
+
+
+
+
LAST_COMMIT export-subst
+
+
+
+
+
$ echo 'Last commit date: $Format:%cd by %aN$' > LAST_COMMIT
+$ git add LAST_COMMIT .gitattributes
+$ git commit -am 'adding LAST_COMMIT file for archives'
+
+
+
+
When you run git archive, the contents of the archived file will look like this:
+
+
+
+
$ git archive HEAD | tar xCf ../deployment-testing -
+$ cat ../deployment-testing/LAST_COMMIT
+Last commit date: Tue Apr 21 08:38:48 2009 -0700 by Scott Chacon
+
+
+
+
The substitutions can include for example the commit message and any git notes, and git log can do simple word wrapping:
+
+
+
+
$ echo '$Format:Last commit: %h by %aN at %cd%n%+w(76,6,9)%B$' > LAST_COMMIT
+$ git commit -am 'export-subst uses git log'\''s custom formatter
+
+git archive uses git log'\''s `pretty=format:` processor
+directly, and strips the surrounding `$Format:` and `$`
+markup from the output.
+'
+$ git archive @ | tar xfO - LAST_COMMIT
+Last commit: 312ccc8 by Jim Hill at Fri May 8 09:14:04 2015 -0700
+ export-subst uses git log's custom formatter
+
+ git archive uses git log's `pretty=format:` processor directly, and
+ strips the surrounding `$Format:` and `$` markup from the output.
+
+
+
+
The resulting archive is suitable for deployment work, but like any exported archive it isn’t suitable for further development work.
+
+
+
+
Merge Strategies
+
+
+You can also use Git attributes to tell Git to use different merge strategies for specific files in your project.
+One very useful option is to tell Git to not try to merge specific files when they have conflicts, but rather to use your side of the merge over someone else’s.
+
+
+
This is helpful if a branch in your project has diverged or is specialized, but you want to be able to merge changes back in from it, and you want to ignore certain files.
+Say you have a database settings file called database.xml that is different in two branches, and you want to merge in your other branch without messing up the database file.
+You can set up an attribute like this:
+
+
+
+
database.xml merge=ours
+
+
+
+
And then define a dummy ours merge strategy with:
+
+
+
+
$ git config --global merge.ours.driver true
+
+
+
+
If you merge in the other branch, instead of having merge conflicts with the database.xml file, you see something like this:
+
+
+
+
$ git merge topic
+Auto-merging database.xml
+Merge made by recursive.
+
+
+
+
In this case, database.xml stays at whatever version you originally had.
+
+
So far, we’ve covered the basics of how Git works and how to use it, and we’ve introduced a number of tools that Git provides to help you use it easily and efficiently.
+In this chapter, we’ll see how you can make Git operate in a more customized fashion, by introducing several important configuration settings and the hooks system.
+With these tools, it’s easy to get Git to work exactly the way you, your company, or your group needs it to.
+Git Configuration
+
+
+As you read briefly in شروع به کار, you can specify Git configuration settings with the git config command.
+One of the first things you did was set up your name and email address:
+
+
+
$ git config --global user.name "John Doe"
+$ git config --global user.email johndoe@example.com
+
+
+
Now you’ll learn a few of the more interesting options that you can set in this manner to customize your Git usage.
+
+
First, a quick review: Git uses a series of configuration files to determine non-default behavior that you may want.
+The first place Git looks for these values is in the system-wide /etc/gitconfig file, which contains settings that are applied to every user on the system and all of their repositories.
+If you pass the option --system to git config, it reads and writes from this file specifically.
+
+
The next place Git looks is the ~/.gitconfig (or ~/.config/git/config) file, which is specific to each user.
+You can make Git read and write to this file by passing the --global option.
+
+
Finally, Git looks for configuration values in the configuration file in the Git directory (.git/config) of whatever repository you’re currently using.
+These values are specific to that single repository, and represent passing the --local option to git config.
+(If you don’t specify which level you want to work with, this is the default.)
+
+
Each of these “levels” (system, global, local) overwrites values in the previous level, so values in .git/config trump those in /etc/gitconfig, for instance.
+
+
+
+|
+ یادداشت
+ |
+
+
+ Git’s configuration files are plain-text, so you can also set these values by manually editing the file and inserting the correct syntax.
+It’s generally easier to run the git config command, though.
+ |
+
+
+
+
Basic Client Configuration
+
+
The configuration options recognized by Git fall into two categories: client-side and server-side.
+The majority of the options are client-side — configuring your personal working preferences.
+Many, many configuration options are supported, but a large fraction of them are useful only in certain edge cases; we’ll cover just the most common and useful options here.
+If you want to see a list of all the options your version of Git recognizes, you can run
+
+
+
+
+
core.editor
+
+
+By default, Git uses whatever you’ve set as your default text editor via one of the shell environment variables VISUAL or EDITOR, or else falls back to the vi editor to create and edit your commit and tag messages.
+To change that default to something else, you can use the core.editor setting:
+
+
+
+
$ git config --global core.editor emacs
+
+
+
+
Now, no matter what is set as your default shell editor, Git will fire up Emacs to edit messages.
+
+
+
+
commit.template
+
+
+If you set this to the path of a file on your system, Git will use that file as the default initial message when you commit.
+The value in creating a custom commit template is that you can use it to remind yourself (or others) of the proper format and style when creating a commit message.
+
+
+
For instance, consider a template file at ~/.gitmessage.txt that looks like this:
+
+
+
+
Subject line (try to keep under 50 characters)
+
+Multi-line description of commit,
+feel free to be detailed.
+
+[Ticket: X]
+
+
+
+
Note how this commit template reminds the committer to keep the subject line short (for the sake of git log --oneline output), to add further detail under that, and to refer to an issue or bug tracker ticket number if one exists.
+
+
+
To tell Git to use it as the default message that appears in your editor when you run git commit, set the commit.template configuration value:
+
+
+
+
$ git config --global commit.template ~/.gitmessage.txt
+$ git commit
+
+
+
+
Then, your editor will open to something like this for your placeholder commit message when you commit:
+
+
+
+
Subject line (try to keep under 50 characters)
+
+Multi-line description of commit,
+feel free to be detailed.
+
+[Ticket: X]
+# Please enter the commit message for your changes. Lines starting
+# with '#' will be ignored, and an empty message aborts the commit.
+# On branch master
+# Changes to be committed:
+# (use "git reset HEAD <file>..." to unstage)
+#
+# modified: lib/test.rb
+#
+~
+~
+".git/COMMIT_EDITMSG" 14L, 297C
+
+
+
+
If your team has a commit-message policy, then putting a template for that policy on your system and configuring Git to use it by default can help increase the chance of that policy being followed regularly.
+
+
+
+
+
+
+This setting determines which pager is used when Git pages output such as log and diff.
+You can set it to more or to your favorite pager (by default, it’s less), or you can turn it off by setting it to a blank string:
+
+
+
+
$ git config --global core.pager ''
+
+
+
+
If you run that, Git will page the entire output of all commands, no matter how long they are.
+
+
+
+
user.signingkey
+
+
+If you’re making signed annotated tags (as discussed in Signing Your Work), setting your GPG signing key as a configuration setting makes things easier.
+Set your key ID like so:
+
+
+
+
$ git config --global user.signingkey <gpg-key-id>
+
+
+
+
Now, you can sign tags without having to specify your key every time with the git tag command:
+
+
+
+
$ git tag -s <tag-name>
+
+
+
+
+
core.excludesfile
+
+
+You can put patterns in your project’s .gitignore file to have Git not see them as untracked files or try to stage them when you run git add on them, as discussed in نادیده گرفتن فایلها.
+
+
+
But sometimes you want to ignore certain files for all repositories that you work with.
+If your computer is running macOS, you’re probably familiar with .DS_Store files.
+If your preferred editor is Emacs or Vim, you know about filenames that end with a ~ or .swp.
+
+
+
This setting lets you write a kind of global .gitignore file.
+If you create a ~/.gitignore_global file with these contents:
+
+
+
+
…and you run git config --global core.excludesfile ~/.gitignore_global, Git will never again bother you about those files.
+
+
+
+
help.autocorrect
+
+
+If you mistype a command, it shows you something like this:
+
+
+
+
$ git chekcout master
+git: 'chekcout' is not a git command. See 'git --help'.
+
+Did you mean this?
+ checkout
+
+
+
+
Git helpfully tries to figure out what you meant, but it still refuses to do it.
+If you set help.autocorrect to 1, Git will actually run this command for you:
+
+
+
+
$ git chekcout master
+WARNING: You called a Git command named 'chekcout', which does not exist.
+Continuing under the assumption that you meant 'checkout'
+in 0.1 seconds automatically...
+
+
+
+
Note that “0.1 seconds” business.
+help.autocorrect is actually an integer which represents tenths of a second.
+So if you set it to 50, Git will give you 5 seconds to change your mind before executing the autocorrected command.
+
+
+
+
Colors in Git
+
+
+Git fully supports colored terminal output, which greatly aids in visually parsing command output quickly and easily.
+A number of options can help you set the coloring to your preference.
+
+
+
color.ui
+
+
Git automatically colors most of its output, but there’s a master switch if you don’t like this behavior.
+To turn off all Git’s colored terminal output, do this:
+
+
+
+
$ git config --global color.ui false
+
+
+
+
The default setting is auto, which colors output when it’s going straight to a terminal, but omits the color-control codes when the output is redirected to a pipe or a file.
+
+
+
You can also set it to always to ignore the difference between terminals and pipes.
+You’ll rarely want this; in most scenarios, if you want color codes in your redirected output, you can instead pass a --color flag to the Git command to force it to use color codes.
+The default setting is almost always what you’ll want.
+
+
+
+
color.*
+
+
If you want to be more specific about which commands are colored and how, Git provides verb-specific coloring settings.
+Each of these can be set to true, false, or always:
+
+
+
+
color.branch
+color.diff
+color.interactive
+color.status
+
+
+
+
In addition, each of these has subsettings you can use to set specific colors for parts of the output, if you want to override each color.
+For example, to set the meta information in your diff output to blue foreground, black background, and bold text, you can run
+
+
+
+
$ git config --global color.diff.meta "blue black bold"
+
+
+
+
You can set the color to any of the following values: normal, black, red, green, yellow, blue, magenta, cyan, or white.
+If you want an attribute like bold in the previous example, you can choose from bold, dim, ul (underline), blink, and reverse (swap foreground and background).
+
+
+
+
+
+
+Although Git has an internal implementation of diff, which is what we’ve been showing in this book, you can set up an external tool instead.
+You can also set up a graphical merge-conflict-resolution tool instead of having to resolve conflicts manually.
+We’ll demonstrate setting up the Perforce Visual Merge Tool (P4Merge) to do your diffs and merge resolutions, because it’s a nice graphical tool and it’s free.
+
+
+
If you want to try this out, P4Merge works on all major platforms, so you should be able to do so.
+We’ll use path names in the examples that work on macOS and Linux systems; for Windows, you’ll have to change /usr/local/bin to an executable path in your environment.
+
+
+
To begin, download P4Merge from Perforce.
+Next, you’ll set up external wrapper scripts to run your commands.
+We’ll use the macOS path for the executable; in other systems, it will be where your p4merge binary is installed.
+Set up a merge wrapper script named extMerge that calls your binary with all the arguments provided:
+
+
+
+
$ cat /usr/local/bin/extMerge
+#!/bin/sh
+/Applications/p4merge.app/Contents/MacOS/p4merge $*
+
+
+
+
The diff wrapper checks to make sure seven arguments are provided and passes two of them to your merge script.
+By default, Git passes the following arguments to the diff program:
+
+
+
+
path old-file old-hex old-mode new-file new-hex new-mode
+
+
+
+
Because you only want the old-file and new-file arguments, you use the wrapper script to pass the ones you need.
+
+
+
+
$ cat /usr/local/bin/extDiff
+#!/bin/sh
+[ $# -eq 7 ] && /usr/local/bin/extMerge "$2" "$5"
+
+
+
+
You also need to make sure these tools are executable:
+
+
+
+
$ sudo chmod +x /usr/local/bin/extMerge
+$ sudo chmod +x /usr/local/bin/extDiff
+
+
+
+
Now you can set up your config file to use your custom merge resolution and diff tools.
+This takes a number of custom settings: merge.tool to tell Git what strategy to use, mergetool.<tool>.cmd to specify how to run the command, mergetool.<tool>.trustExitCode to tell Git if the exit code of that program indicates a successful merge resolution or not, and diff.external to tell Git what command to run for diffs.
+So, you can either run four config commands
+
+
+
+
$ git config --global merge.tool extMerge
+$ git config --global mergetool.extMerge.cmd \
+ 'extMerge "$BASE" "$LOCAL" "$REMOTE" "$MERGED"'
+$ git config --global mergetool.extMerge.trustExitCode false
+$ git config --global diff.external extDiff
+
+
+
+
or you can edit your ~/.gitconfig file to add these lines:
+
+
+
+
[merge]
+ tool = extMerge
+[mergetool "extMerge"]
+ cmd = extMerge "$BASE" "$LOCAL" "$REMOTE" "$MERGED"
+ trustExitCode = false
+[diff]
+ external = extDiff
+
+
+
+
After all this is set, if you run diff commands such as this:
+
+
+
+
$ git diff 32d1776b1^ 32d1776b1
+
+
+
+
Instead of getting the diff output on the command line, Git fires up P4Merge, which looks something like this:
+
+
+
+
}}" alt="P4Merge.">
+
+
نمودار 143. P4Merge.
+
+
+
If you try to merge two branches and subsequently have merge conflicts, you can run the command git mergetool; it starts P4Merge to let you resolve the conflicts through that GUI tool.
+
+
+
The nice thing about this wrapper setup is that you can change your diff and merge tools easily.
+For example, to change your extDiff and extMerge tools to run the KDiff3 tool instead, all you have to do is edit your extMerge file:
+
+
+
+
$ cat /usr/local/bin/extMerge
+#!/bin/sh
+/Applications/kdiff3.app/Contents/MacOS/kdiff3 $*
+
+
+
+
Now, Git will use the KDiff3 tool for diff viewing and merge conflict resolution.
+
+
+
Git comes preset to use a number of other merge-resolution tools without your having to set up the cmd configuration.
+To see a list of the tools it supports, try this:
+
+
+
+
$ git mergetool --tool-help
+'git mergetool --tool=<tool>' may be set to one of the following:
+ emerge
+ gvimdiff
+ gvimdiff2
+ opendiff
+ p4merge
+ vimdiff
+ vimdiff2
+
+The following tools are valid, but not currently available:
+ araxis
+ bc3
+ codecompare
+ deltawalker
+ diffmerge
+ diffuse
+ ecmerge
+ kdiff3
+ meld
+ tkdiff
+ tortoisemerge
+ xxdiff
+
+Some of the tools listed above only work in a windowed
+environment. If run in a terminal-only session, they will fail.
+
+
+
+
If you’re not interested in using KDiff3 for diff but rather want to use it just for merge resolution, and the kdiff3 command is in your path, then you can run
+
+
+
+
$ git config --global merge.tool kdiff3
+
+
+
+
If you run this instead of setting up the extMerge and extDiff files, Git will use KDiff3 for merge resolution and the normal Git diff tool for diffs.
+
+
+
+
+
+Formatting and whitespace issues are some of the more frustrating and subtle problems that many developers encounter when collaborating, especially cross-platform.
+It’s very easy for patches or other collaborated work to introduce subtle whitespace changes because editors silently introduce them, and if your files ever touch a Windows system, their line endings might be replaced.
+Git has a few configuration options to help with these issues.
+
+
+
core.autocrlf
+
+
+If you’re programming on Windows and working with people who are not (or vice-versa), you’ll probably run into line-ending issues at some point.
+This is because Windows uses both a carriage-return character and a linefeed character for newlines in its files, whereas macOS and Linux systems use only the linefeed character.
+This is a subtle but incredibly annoying fact of cross-platform work; many editors on Windows silently replace existing LF-style line endings with CRLF, or insert both line-ending characters when the user hits the enter key.
+
+
+
Git can handle this by auto-converting CRLF line endings into LF when you add a file to the index, and vice versa when it checks out code onto your filesystem.
+You can turn on this functionality with the core.autocrlf setting.
+If you’re on a Windows machine, set it to true — this converts LF endings into CRLF when you check out code:
+
+
+
+
$ git config --global core.autocrlf true
+
+
+
+
If you’re on a Linux or macOS system that uses LF line endings, then you don’t want Git to automatically convert them when you check out files; however, if a file with CRLF endings accidentally gets introduced, then you may want Git to fix it.
+You can tell Git to convert CRLF to LF on commit but not the other way around by setting core.autocrlf to input:
+
+
+
+
$ git config --global core.autocrlf input
+
+
+
+
This setup should leave you with CRLF endings in Windows checkouts, but LF endings on macOS and Linux systems and in the repository.
+
+
+
If you’re a Windows programmer doing a Windows-only project, then you can turn off this functionality, recording the carriage returns in the repository by setting the config value to false:
+
+
+
+
$ git config --global core.autocrlf false
+
+
+
+
+
core.whitespace
+
+
Git comes preset to detect and fix some whitespace issues.
+It can look for six primary whitespace issues — three are enabled by default and can be turned off, and three are disabled by default but can be activated.
+
+
+
The three that are turned on by default are blank-at-eol, which looks for spaces at the end of a line; blank-at-eof, which notices blank lines at the end of a file; and space-before-tab, which looks for spaces before tabs at the beginning of a line.
+
+
+
The three that are disabled by default but can be turned on are indent-with-non-tab, which looks for lines that begin with spaces instead of tabs (and is controlled by the tabwidth option); tab-in-indent, which watches for tabs in the indentation portion of a line; and cr-at-eol, which tells Git that carriage returns at the end of lines are OK.
+
+
+
You can tell Git which of these you want enabled by setting core.whitespace to the values you want on or off, separated by commas.
+You can disable an option by prepending a - in front of its name, or use the default value by leaving it out of the setting string entirely.
+For example, if you want all but space-before-tab to be set, you can do this (with trailing-space being a short-hand to cover both blank-at-eol and blank-at-eof):
+
+
+
+
$ git config --global core.whitespace \
+ trailing-space,-space-before-tab,indent-with-non-tab,tab-in-indent,cr-at-eol
+
+
+
+
Or you can specify the customizing part only:
+
+
+
+
$ git config --global core.whitespace \
+ -space-before-tab,indent-with-non-tab,tab-in-indent,cr-at-eol
+
+
+
+
Git will detect these issues when you run a git diff command and try to color them so you can possibly fix them before you commit.
+It will also use these values to help you when you apply patches with git apply.
+When you’re applying patches, you can ask Git to warn you if it’s applying patches with the specified whitespace issues:
+
+
+
+
$ git apply --whitespace=warn <patch>
+
+
+
+
Or you can have Git try to automatically fix the issue before applying the patch:
+
+
+
+
$ git apply --whitespace=fix <patch>
+
+
+
+
These options apply to the git rebase command as well.
+If you’ve committed whitespace issues but haven’t yet pushed upstream, you can run git rebase --whitespace=fix to have Git automatically fix whitespace issues as it’s rewriting the patches.
+
+
+
+
Server Configuration
+
+
Not nearly as many configuration options are available for the server side of Git, but there are a few interesting ones you may want to take note of.
+
+
+
receive.fsckObjects
+
+
Git is capable of making sure every object received during a push still matches its SHA-1 checksum and points to valid objects.
+However, it doesn’t do this by default; it’s a fairly expensive operation, and might slow down the operation, especially on large repositories or pushes.
+If you want Git to check object consistency on every push, you can force it to do so by setting receive.fsckObjects to true:
+
+
+
+
$ git config --system receive.fsckObjects true
+
+
+
+
Now, Git will check the integrity of your repository before each push is accepted to make sure faulty (or malicious) clients aren’t introducing corrupt data.
+
+
+
+
receive.denyNonFastForwards
+
+
If you rebase commits that you’ve already pushed and then try to push again, or otherwise try to push a commit to a remote branch that doesn’t contain the commit that the remote branch currently points to, you’ll be denied.
+This is generally good policy; but in the case of the rebase, you may determine that you know what you’re doing and can force-update the remote branch with a -f flag to your push command.
+
+
+
To tell Git to refuse force-pushes, set receive.denyNonFastForwards:
+
+
+
+
$ git config --system receive.denyNonFastForwards true
+
+
+
+
The other way you can do this is via server-side receive hooks, which we’ll cover in a bit.
+That approach lets you do more complex things like deny non-fast-forwards to a certain subset of users.
+
+
+
+
receive.denyDeletes
+
+
One of the workarounds to the denyNonFastForwards policy is for the user to delete the branch and then push it back up with the new reference.
+To avoid this, set receive.denyDeletes to true:
+
+
+
+
$ git config --system receive.denyDeletes true
+
+
+
+
This denies any deletion of branches or tags — no user can do it.
+To remove remote branches, you must remove the ref files from the server manually.
+There are also more interesting ways to do this on a per-user basis via ACLs, as you’ll learn in An Example Git-Enforced Policy.
+
+
+
Git Hooks
+
+
+Like many other Version Control Systems, Git has a way to fire off custom scripts when certain important actions occur.
+There are two groups of these hooks: client-side and server-side.
+Client-side hooks are triggered by operations such as committing and merging, while server-side hooks run on network operations such as receiving pushed commits.
+You can use these hooks for all sorts of reasons.
+
+
Installing a Hook
+
+
The hooks are all stored in the hooks subdirectory of the Git directory.
+In most projects, that’s .git/hooks.
+When you initialize a new repository with git init, Git populates the hooks directory with a bunch of example scripts, many of which are useful by themselves; but they also document the input values of each script.
+All the examples are written as shell scripts, with some Perl thrown in, but any properly named executable scripts will work fine – you can write them in Ruby or Python or whatever language you are familiar with.
+If you want to use the bundled hook scripts, you’ll have to rename them; their file names all end with .sample.
+
+
+
To enable a hook script, put a file in the hooks subdirectory of your .git directory that is named appropriately (without any extension) and is executable.
+From that point forward, it should be called.
+We’ll cover most of the major hook filenames here.
+
+
+
Client-Side Hooks
+
+
There are a lot of client-side hooks.
+This section splits them into committing-workflow hooks, email-workflow scripts, and everything else.
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ It’s important to note that client-side hooks are not copied when you clone a repository.
+If your intent with these scripts is to enforce a policy, you’ll probably want to do that on the server side; see the example in An Example Git-Enforced Policy.
+ |
+
+
+
+
+
Committing-Workflow Hooks
+
+
The first four hooks have to do with the committing process.
+
+
+
The pre-commit hook is run first, before you even type in a commit message.
+It’s used to inspect the snapshot that’s about to be committed, to see if you’ve forgotten something, to make sure tests run, or to examine whatever you need to inspect in the code.
+Exiting non-zero from this hook aborts the commit, although you can bypass it with git commit --no-verify.
+You can do things like check for code style (run lint or something equivalent), check for trailing whitespace (the default hook does exactly this), or check for appropriate documentation on new methods.
+
+
+
The prepare-commit-msg hook is run before the commit message editor is fired up but after the default message is created.
+It lets you edit the default message before the commit author sees it.
+This hook takes a few parameters: the path to the file that holds the commit message so far, the type of commit, and the commit SHA-1 if this is an amended commit.
+This hook generally isn’t useful for normal commits; rather, it’s good for commits where the default message is auto-generated, such as templated commit messages, merge commits, squashed commits, and amended commits.
+You may use it in conjunction with a commit template to programmatically insert information.
+
+
+
The commit-msg hook takes one parameter, which again is the path to a temporary file that contains the commit message written by the developer.
+If this script exits non-zero, Git aborts the commit process, so you can use it to validate your project state or commit message before allowing a commit to go through.
+In the last section of this chapter, we’ll demonstrate using this hook to check that your commit message is conformant to a required pattern.
+
+
+
After the entire commit process is completed, the post-commit hook runs.
+It doesn’t take any parameters, but you can easily get the last commit by running git log -1 HEAD.
+Generally, this script is used for notification or something similar.
+
+
+
+
Email Workflow Hooks
+
+
You can set up three client-side hooks for an email-based workflow.
+They’re all invoked by the git am command, so if you aren’t using that command in your workflow, you can safely skip to the next section.
+If you’re taking patches over email prepared by git format-patch, then some of these may be helpful to you.
+
+
+
The first hook that is run is applypatch-msg.
+It takes a single argument: the name of the temporary file that contains the proposed commit message.
+Git aborts the patch if this script exits non-zero.
+You can use this to make sure a commit message is properly formatted, or to normalize the message by having the script edit it in place.
+
+
+
The next hook to run when applying patches via git am is pre-applypatch.
+Somewhat confusingly, it is run after the patch is applied but before a commit is made, so you can use it to inspect the snapshot before making the commit.
+You can run tests or otherwise inspect the working tree with this script.
+If something is missing or the tests don’t pass, exiting non-zero aborts the git am script without committing the patch.
+
+
+
The last hook to run during a git am operation is post-applypatch, which runs after the commit is made.
+You can use it to notify a group or the author of the patch you pulled in that you’ve done so.
+You can’t stop the patching process with this script.
+
+
+
+
Other Client Hooks
+
+
The pre-rebase hook runs before you rebase anything and can halt the process by exiting non-zero.
+You can use this hook to disallow rebasing any commits that have already been pushed.
+The example pre-rebase hook that Git installs does this, although it makes some assumptions that may not match with your workflow.
+
+
+
The post-rewrite hook is run by commands that replace commits, such as git commit --amend and git rebase (though not by git filter-branch).
+Its single argument is which command triggered the rewrite, and it receives a list of rewrites on stdin.
+This hook has many of the same uses as the post-checkout and post-merge hooks.
+
+
+
After you run a successful git checkout, the post-checkout hook runs; you can use it to set up your working directory properly for your project environment.
+This may mean moving in large binary files that you don’t want source controlled, auto-generating documentation, or something along those lines.
+
+
+
The post-merge hook runs after a successful merge command.
+You can use it to restore data in the working tree that Git can’t track, such as permissions data.
+This hook can likewise validate the presence of files external to Git control that you may want copied in when the working tree changes.
+
+
+
The pre-push hook runs during git push, after the remote refs have been updated but before any objects have been transferred.
+It receives the name and location of the remote as parameters, and a list of to-be-updated refs through stdin.
+You can use it to validate a set of ref updates before a push occurs (a non-zero exit code will abort the push).
+
+
+
Git occasionally does garbage collection as part of its normal operation, by invoking git gc --auto.
+The pre-auto-gc hook is invoked just before the garbage collection takes place, and can be used to notify you that this is happening, or to abort the collection if now isn’t a good time.
+
+
+
+
Server-Side Hooks
+
+
In addition to the client-side hooks, you can use a couple of important server-side hooks as a system administrator to enforce nearly any kind of policy for your project.
+These scripts run before and after pushes to the server.
+The pre hooks can exit non-zero at any time to reject the push as well as print an error message back to the client; you can set up a push policy that’s as complex as you wish.
+
+
+
pre-receive
+
+
The first script to run when handling a push from a client is pre-receive.
+It takes a list of references that are being pushed from stdin; if it exits non-zero, none of them are accepted.
+You can use this hook to do things like make sure none of the updated references are non-fast-forwards, or to do access control for all the refs and files they’re modifying with the push.
+
+
+
+
update
+
+
The update script is very similar to the pre-receive script, except that it’s run once for each branch the pusher is trying to update.
+If the pusher is trying to push to multiple branches, pre-receive runs only once, whereas update runs once per branch they’re pushing to.
+Instead of reading from stdin, this script takes three arguments: the name of the reference (branch), the SHA-1 that reference pointed to before the push, and the SHA-1 the user is trying to push.
+If the update script exits non-zero, only that reference is rejected; other references can still be updated.
+
+
+
+
post-receive
+
+
The post-receive hook runs after the entire process is completed and can be used to update other services or notify users.
+It takes the same stdin data as the pre-receive hook.
+Examples include emailing a list, notifying a continuous integration server, or updating a ticket-tracking system – you can even parse the commit messages to see if any tickets need to be opened, modified, or closed.
+This script can’t stop the push process, but the client doesn’t disconnect until it has completed, so be careful if you try to do anything that may take a long time.
+
+
+
Summary
+
+
We’ve covered most of the major ways that you can customize your Git client and server to best fit your workflow and projects.
+You’ve learned about all sorts of configuration settings, file-based attributes, and event hooks, and you’ve built an example policy-enforcing server.
+You should now be able to make Git fit nearly any workflow you can dream up.
+
Environment Variables
+
+
Git always runs inside a bash shell, and uses a number of shell environment variables to determine how it behaves.
+Occasionally, it comes in handy to know what these are, and how they can be used to make Git behave the way you want it to.
+This isn’t an exhaustive list of all the environment variables Git pays attention to, but we’ll cover the most useful.
+
+
Global Behavior
+
+
Some of Git’s general behavior as a computer program depends on environment variables.
+
+
+
GIT_EXEC_PATH determines where Git looks for its sub-programs (like git-commit, git-diff, and others).
+ You can check the current setting by running git --exec-path.
+
+
+
HOME isn’t usually considered customizable (too many other things depend on it), but it’s where Git looks for the global configuration file.
+ If you want a truly portable Git installation, complete with global configuration, you can override HOME in the portable Git’s shell profile.
+
+
+
PREFIX is similar, but for the system-wide configuration.
+ Git looks for this file at $PREFIX/etc/gitconfig.
+
+
+
GIT_CONFIG_NOSYSTEM, if set, disables the use of the system-wide configuration file.
+ This is useful if your system config is interfering with your commands, but you don’t have access to change or remove it.
+
+
+
GIT_PAGER controls the program used to display multi-page output on the command line.
+If this is unset, PAGER will be used as a fallback.
+
+
+
GIT_EDITOR is the editor Git will launch when the user needs to edit some text (a commit message, for example).
+If unset, EDITOR will be used.
+
+
+
Repository Locations
+
+
Git uses several environment variables to determine how it interfaces with the current repository.
+
+
+
GIT_DIR is the location of the .git folder.
+If this isn’t specified, Git walks up the directory tree until it gets to ~ or /, looking for a .git directory at every step.
+
+
+
GIT_CEILING_DIRECTORIES controls the behavior of searching for a .git directory.
+If you access directories that are slow to load (such as those on a tape drive, or across a slow network connection), you may want to have Git stop trying earlier than it might otherwise, especially if Git is invoked when building your shell prompt.
+
+
+
GIT_WORK_TREE is the location of the root of the working directory for a non-bare repository.
+If --git-dir or GIT_DIR is specified but none of --work-tree, GIT_WORK_TREE or core.worktree is specified, the current working directory is regarded as the top level of your working tree.
+
+
+
GIT_INDEX_FILE is the path to the index file (non-bare repositories only).
+
+
+
GIT_OBJECT_DIRECTORY can be used to specify the location of the directory that usually resides at .git/objects.
+
+
+
GIT_ALTERNATE_OBJECT_DIRECTORIES is a colon-separated list (formatted like /dir/one:/dir/two:…) which tells Git where to check for objects if they aren’t in GIT_OBJECT_DIRECTORY.
+If you happen to have a lot of projects with large files that have the exact same contents, this can be used to avoid storing too many copies of them.
+
+
+
Pathspecs
+
+
A “pathspec” refers to how you specify paths to things in Git, including the use of wildcards.
+These are used in the .gitignore file, but also on the command-line (git add *.c).
+
+
+
GIT_GLOB_PATHSPECS and GIT_NOGLOB_PATHSPECS control the default behavior of wildcards in pathspecs.
+If GIT_GLOB_PATHSPECS is set to 1, wildcard characters act as wildcards (which is the default); if GIT_NOGLOB_PATHSPECS is set to 1, wildcard characters only match themselves, meaning something like *.c would only match a file named “*.c”, rather than any file whose name ends with .c.
+You can override this in individual cases by starting the pathspec with :(glob) or :(literal), as in :(glob)*.c.
+
+
+
GIT_LITERAL_PATHSPECS disables both of the above behaviors; no wildcard characters will work, and the override prefixes are disabled as well.
+
+
+
GIT_ICASE_PATHSPECS sets all pathspecs to work in a case-insensitive manner.
+
+
+
Committing
+
+
The final creation of a Git commit object is usually done by git-commit-tree, which uses these environment variables as its primary source of information, falling back to configuration values only if these aren’t present.
+
+
+
GIT_AUTHOR_NAME is the human-readable name in the “author” field.
+
+
+
GIT_AUTHOR_EMAIL is the email for the “author” field.
+
+
+
GIT_AUTHOR_DATE is the timestamp used for the “author” field.
+
+
+
GIT_COMMITTER_NAME sets the human name for the “committer” field.
+
+
+
GIT_COMMITTER_EMAIL is the email address for the “committer” field.
+
+
+
GIT_COMMITTER_DATE is used for the timestamp in the “committer” field.
+
+
+
EMAIL is the fallback email address in case the user.email configuration value isn’t set.
+If this isn’t set, Git falls back to the system user and host names.
+
+
+
Networking
+
+
Git uses the curl library to do network operations over HTTP, so GIT_CURL_VERBOSE tells Git to emit all the messages generated by that library.
+This is similar to doing curl -v on the command line.
+
+
+
GIT_SSL_NO_VERIFY tells Git not to verify SSL certificates.
+This can sometimes be necessary if you’re using a self-signed certificate to serve Git repositories over HTTPS, or you’re in the middle of setting up a Git server but haven’t installed a full certificate yet.
+
+
+
If the data rate of an HTTP operation is lower than GIT_HTTP_LOW_SPEED_LIMIT bytes per second for longer than GIT_HTTP_LOW_SPEED_TIME seconds, Git will abort that operation.
+These values override the http.lowSpeedLimit and http.lowSpeedTime configuration values.
+
+
+
GIT_HTTP_USER_AGENT sets the user-agent string used by Git when communicating over HTTP.
+The default is a value like git/2.0.0.
+
+
+
Diffing and Merging
+
+
GIT_DIFF_OPTS is a bit of a misnomer.
+The only valid values are -u<n> or --unified=<n>, which controls the number of context lines shown in a git diff command.
+
+
+
GIT_EXTERNAL_DIFF is used as an override for the diff.external configuration value.
+If it’s set, Git will invoke this program when git diff is invoked.
+
+
+
GIT_DIFF_PATH_COUNTER and GIT_DIFF_PATH_TOTAL are useful from inside the program specified by GIT_EXTERNAL_DIFF or diff.external.
+The former represents which file in a series is being diffed (starting with 1), and the latter is the total number of files in the batch.
+
+
+
GIT_MERGE_VERBOSITY controls the output for the recursive merge strategy.
+The allowed values are as follows:
+
+
+
+-
+
0 outputs nothing, except possibly a single error message.
+
+-
+
1 shows only conflicts.
+
+-
+
2 also shows file changes.
+
+-
+
3 shows when files are skipped because they haven’t changed.
+
+-
+
4 shows all paths as they are processed.
+
+-
+
5 and above show detailed debugging information.
+
+
+
+
+
The default value is 2.
+
+
+
Debugging
+
+
Want to really know what Git is up to?
+Git has a fairly complete set of traces embedded, and all you need to do is turn them on.
+The possible values of these variables are as follows:
+
+
+
+-
+
“true”, “1”, or “2” – the trace category is written to stderr.
+
+-
+
An absolute path starting with / – the trace output will be written to that file.
+
+
+
+
+
GIT_TRACE controls general traces, which don’t fit into any specific category.
+This includes the expansion of aliases, and delegation to other sub-programs.
+
+
+
+
$ GIT_TRACE=true git lga
+20:12:49.877982 git.c:554 trace: exec: 'git-lga'
+20:12:49.878369 run-command.c:341 trace: run_command: 'git-lga'
+20:12:49.879529 git.c:282 trace: alias expansion: lga => 'log' '--graph' '--pretty=oneline' '--abbrev-commit' '--decorate' '--all'
+20:12:49.879885 git.c:349 trace: built-in: git 'log' '--graph' '--pretty=oneline' '--abbrev-commit' '--decorate' '--all'
+20:12:49.899217 run-command.c:341 trace: run_command: 'less'
+20:12:49.899675 run-command.c:192 trace: exec: 'less'
+
+
+
+
GIT_TRACE_PACK_ACCESS controls tracing of packfile access.
+The first field is the packfile being accessed, the second is the offset within that file:
+
+
+
+
$ GIT_TRACE_PACK_ACCESS=true git status
+20:10:12.081397 sha1_file.c:2088 .git/objects/pack/pack-c3fa...291e.pack 12
+20:10:12.081886 sha1_file.c:2088 .git/objects/pack/pack-c3fa...291e.pack 34662
+20:10:12.082115 sha1_file.c:2088 .git/objects/pack/pack-c3fa...291e.pack 35175
+# […]
+20:10:12.087398 sha1_file.c:2088 .git/objects/pack/pack-e80e...e3d2.pack 56914983
+20:10:12.087419 sha1_file.c:2088 .git/objects/pack/pack-e80e...e3d2.pack 14303666
+On branch master
+Your branch is up-to-date with 'origin/master'.
+nothing to commit, working directory clean
+
+
+
+
GIT_TRACE_PACKET enables packet-level tracing for network operations.
+
+
+
+
$ GIT_TRACE_PACKET=true git ls-remote origin
+20:15:14.867043 pkt-line.c:46 packet: git< # service=git-upload-pack
+20:15:14.867071 pkt-line.c:46 packet: git< 0000
+20:15:14.867079 pkt-line.c:46 packet: git< 97b8860c071898d9e162678ea1035a8ced2f8b1f HEAD\0multi_ack thin-pack side-band side-band-64k ofs-delta shallow no-progress include-tag multi_ack_detailed no-done symref=HEAD:refs/heads/master agent=git/2.0.4
+20:15:14.867088 pkt-line.c:46 packet: git< 0f20ae29889d61f2e93ae00fd34f1cdb53285702 refs/heads/ab/add-interactive-show-diff-func-name
+20:15:14.867094 pkt-line.c:46 packet: git< 36dc827bc9d17f80ed4f326de21247a5d1341fbc refs/heads/ah/doc-gitk-config
+# […]
+
+
+
+
GIT_TRACE_PERFORMANCE controls logging of performance data.
+The output shows how long each particular git invocation takes.
+
+
+
+
$ GIT_TRACE_PERFORMANCE=true git gc
+20:18:19.499676 trace.c:414 performance: 0.374835000 s: git command: 'git' 'pack-refs' '--all' '--prune'
+20:18:19.845585 trace.c:414 performance: 0.343020000 s: git command: 'git' 'reflog' 'expire' '--all'
+Counting objects: 170994, done.
+Delta compression using up to 8 threads.
+Compressing objects: 100% (43413/43413), done.
+Writing objects: 100% (170994/170994), done.
+Total 170994 (delta 126176), reused 170524 (delta 125706)
+20:18:23.567927 trace.c:414 performance: 3.715349000 s: git command: 'git' 'pack-objects' '--keep-true-parents' '--honor-pack-keep' '--non-empty' '--all' '--reflog' '--unpack-unreachable=2.weeks.ago' '--local' '--delta-base-offset' '.git/objects/pack/.tmp-49190-pack'
+20:18:23.584728 trace.c:414 performance: 0.000910000 s: git command: 'git' 'prune-packed'
+20:18:23.605218 trace.c:414 performance: 0.017972000 s: git command: 'git' 'update-server-info'
+20:18:23.606342 trace.c:414 performance: 3.756312000 s: git command: 'git' 'repack' '-d' '-l' '-A' '--unpack-unreachable=2.weeks.ago'
+Checking connectivity: 170994, done.
+20:18:25.225424 trace.c:414 performance: 1.616423000 s: git command: 'git' 'prune' '--expire' '2.weeks.ago'
+20:18:25.232403 trace.c:414 performance: 0.001051000 s: git command: 'git' 'rerere' 'gc'
+20:18:25.233159 trace.c:414 performance: 6.112217000 s: git command: 'git' 'gc'
+
+
+
+
GIT_TRACE_SETUP shows information about what Git is discovering about the repository and environment it’s interacting with.
+
+
+
+
$ GIT_TRACE_SETUP=true git status
+20:19:47.086765 trace.c:315 setup: git_dir: .git
+20:19:47.087184 trace.c:316 setup: worktree: /Users/ben/src/git
+20:19:47.087191 trace.c:317 setup: cwd: /Users/ben/src/git
+20:19:47.087194 trace.c:318 setup: prefix: (null)
+On branch master
+Your branch is up-to-date with 'origin/master'.
+nothing to commit, working directory clean
+
+
+
+
Miscellaneous
+
+
GIT_SSH, if specified, is a program that is invoked instead of ssh when Git tries to connect to an SSH host.
+It is invoked like $GIT_SSH [username@]host [-p <port>] <command>.
+Note that this isn’t the easiest way to customize how ssh is invoked; it won’t support extra command-line parameters, so you’d have to write a wrapper script and set GIT_SSH to point to it.
+It’s probably easier just to use the ~/.ssh/config file for that.
+
+
+
GIT_ASKPASS is an override for the core.askpass configuration value.
+This is the program invoked whenever Git needs to ask the user for credentials, which can expect a text prompt as a command-line argument, and should return the answer on stdout.
+(See Credential Storage for more on this subsystem.)
+
+
+
GIT_NAMESPACE controls access to namespaced refs, and is equivalent to the --namespace flag.
+This is mostly useful on the server side, where you may want to store multiple forks of a single repository in one repository, only keeping the refs separate.
+
+
+
GIT_FLUSH can be used to force Git to use non-buffered I/O when writing incrementally to stdout.
+A value of 1 causes Git to flush more often, a value of 0 causes all output to be buffered.
+The default value (if this variable is not set) is to choose an appropriate buffering scheme depending on the activity and the output mode.
+
+
+
GIT_REFLOG_ACTION lets you specify the descriptive text written to the reflog.
+Here’s an example:
+
+
+
+
$ GIT_REFLOG_ACTION="my action" git commit --allow-empty -m 'My message'
+[master 9e3d55a] My message
+$ git reflog -1
+9e3d55a HEAD@{0}: my action: My message
+
+
+
Git Objects
+
+
Git is a content-addressable filesystem.
+Great.
+What does that mean?
+It means that at the core of Git is a simple key-value data store.
+What this means is that you can insert any kind of content into a Git repository, for which Git will hand you back a unique key you can use later to retrieve that content.
+
+
As a demonstration, let’s look at the plumbing command git hash-object, which takes some data, stores it in your .git/objects directory (the object database), and gives you back the unique key that now refers to that data object.
+
+
First, you initialize a new Git repository and verify that there is (predictably) nothing in the objects directory:
+
+
+
$ git init test
+Initialized empty Git repository in /tmp/test/.git/
+$ cd test
+$ find .git/objects
+.git/objects
+.git/objects/info
+.git/objects/pack
+$ find .git/objects -type f
+
+
+
Git has initialized the objects directory and created pack and info subdirectories in it, but there are no regular files.
+Now, let’s use git hash-object to create a new data object and manually store it in your new Git database:
+
+
+
$ echo 'test content' | git hash-object -w --stdin
+d670460b4b4aece5915caf5c68d12f560a9fe3e4
+
+
+
In its simplest form, git hash-object would take the content you handed to it and merely return the unique key that would be used to store it in your Git database.
+The -w option then tells the command to not simply return the key, but to write that object to the database.
+Finally, the --stdin option tells git hash-object to get the content to be processed from stdin; otherwise, the command would expect a filename argument at the end of the command containing the content to be used.
+
+
The output from the above command is a 40-character checksum hash.
+This is the SHA-1 hash — a checksum of the content you’re storing plus a header, which you’ll learn about in a bit.
+Now you can see how Git has stored your data:
+
+
+
$ find .git/objects -type f
+.git/objects/d6/70460b4b4aece5915caf5c68d12f560a9fe3e4
+
+
+
If you again examine your objects directory, you can see that it now contains a file for that new content.
+This is how Git stores the content initially — as a single file per piece of content, named with the SHA-1 checksum of the content and its header.
+The subdirectory is named with the first 2 characters of the SHA-1, and the filename is the remaining 38 characters.
+
+
Once you have content in your object database, you can examine that content with the git cat-file command.
+This command is sort of a Swiss army knife for inspecting Git objects.
+Passing -p to cat-file instructs the command to first figure out the type of content, then display it appropriately:
+
+
+
$ git cat-file -p d670460b4b4aece5915caf5c68d12f560a9fe3e4
+test content
+
+
+
Now, you can add content to Git and pull it back out again.
+You can also do this with content in files.
+For example, you can do some simple version control on a file.
+First, create a new file and save its contents in your database:
+
+
+
$ echo 'version 1' > test.txt
+$ git hash-object -w test.txt
+83baae61804e65cc73a7201a7252750c76066a30
+
+
+
Then, write some new content to the file, and save it again:
+
+
+
$ echo 'version 2' > test.txt
+$ git hash-object -w test.txt
+1f7a7a472abf3dd9643fd615f6da379c4acb3e3a
+
+
+
Your object database now contains both versions of this new file (as well as the first content you stored there):
+
+
+
$ find .git/objects -type f
+.git/objects/1f/7a7a472abf3dd9643fd615f6da379c4acb3e3a
+.git/objects/83/baae61804e65cc73a7201a7252750c76066a30
+.git/objects/d6/70460b4b4aece5915caf5c68d12f560a9fe3e4
+
+
+
At this point, you can delete your local copy of that test.txt file, then use Git to retrieve, from the object database, either the first version you saved:
+
+
+
$ git cat-file -p 83baae61804e65cc73a7201a7252750c76066a30 > test.txt
+$ cat test.txt
+version 1
+
+
+
or the second version:
+
+
+
$ git cat-file -p 1f7a7a472abf3dd9643fd615f6da379c4acb3e3a > test.txt
+$ cat test.txt
+version 2
+
+
+
But remembering the SHA-1 key for each version of your file isn’t practical; plus, you aren’t storing the filename in your system — just the content.
+This object type is called a blob.
+You can have Git tell you the object type of any object in Git, given its SHA-1 key, with git cat-file -t:
+
+
+
$ git cat-file -t 1f7a7a472abf3dd9643fd615f6da379c4acb3e3a
+blob
+
+
+
Tree Objects
+
+
The next type of Git object we’ll examine is the tree, which solves the problem of storing the filename and also allows you to store a group of files together.
+Git stores content in a manner similar to a UNIX filesystem, but a bit simplified.
+All the content is stored as tree and blob objects, with trees corresponding to UNIX directory entries and blobs corresponding more or less to inodes or file contents.
+A single tree object contains one or more entries, each of which is the SHA-1 hash of a blob or subtree with its associated mode, type, and filename.
+For example, the most recent tree in a project may look something like this:
+
+
+
+
$ git cat-file -p master^{tree}
+100644 blob a906cb2a4a904a152e80877d4088654daad0c859 README
+100644 blob 8f94139338f9404f26296befa88755fc2598c289 Rakefile
+040000 tree 99f1a6d12cb4b6f19c8655fca46c3ecf317074e0 lib
+
+
+
+
The master^{tree} syntax specifies the tree object that is pointed to by the last commit on your master branch.
+Notice that the lib subdirectory isn’t a blob but a pointer to another tree:
+
+
+
+
$ git cat-file -p 99f1a6d12cb4b6f19c8655fca46c3ecf317074e0
+100644 blob 47c6340d6459e05787f644c2447d2595f5d3a54b simplegit.rb
+
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ Depending on what shell you use, you may encounter errors when using the master^{tree} syntax.
+
+ In CMD on Windows, the ^ character is used for escaping, so you have to double it to avoid this: git cat-file -p master^^{tree}.
+When using PowerShell, parameters using {} characters have to be quoted to avoid the parameter being parsed incorrectly: git cat-file -p 'master^{tree}'.
+
+ If you’re using ZSH, the ^ character is used for globbing, so you have to enclose the whole expression in quotes: git cat-file -p "master^{tree}".
+ |
+
+
+
+
+
Conceptually, the data that Git is storing looks something like this:
+
+
+
+
}}" alt="Simple version of the Git data model.">
+
+
نمودار 149. Simple version of the Git data model.
+
+
+
You can fairly easily create your own tree.
+Git normally creates a tree by taking the state of your staging area or index and writing a series of tree objects from it.
+So, to create a tree object, you first have to set up an index by staging some files.
+To create an index with a single entry — the first version of your test.txt file — you can use the plumbing command git update-index.
+You use this command to artificially add the earlier version of the test.txt file to a new staging area.
+You must pass it the --add option because the file doesn’t yet exist in your staging area (you don’t even have a staging area set up yet) and --cacheinfo because the file you’re adding isn’t in your directory but is in your database.
+Then, you specify the mode, SHA-1, and filename:
+
+
+
+
$ git update-index --add --cacheinfo 100644 \
+ 83baae61804e65cc73a7201a7252750c76066a30 test.txt
+
+
+
+
In this case, you’re specifying a mode of 100644, which means it’s a normal file.
+Other options are 100755, which means it’s an executable file; and 120000, which specifies a symbolic link.
+The mode is taken from normal UNIX modes but is much less flexible — these three modes are the only ones that are valid for files (blobs) in Git (although other modes are used for directories and submodules).
+
+
+
Now, you can use git write-tree to write the staging area out to a tree object.
+No -w option is needed — calling this command automatically creates a tree object from the state of the index if that tree doesn’t yet exist:
+
+
+
+
$ git write-tree
+d8329fc1cc938780ffdd9f94e0d364e0ea74f579
+$ git cat-file -p d8329fc1cc938780ffdd9f94e0d364e0ea74f579
+100644 blob 83baae61804e65cc73a7201a7252750c76066a30 test.txt
+
+
+
+
You can also verify that this is a tree object using the same git cat-file command you saw earlier:
+
+
+
+
$ git cat-file -t d8329fc1cc938780ffdd9f94e0d364e0ea74f579
+tree
+
+
+
+
You’ll now create a new tree with the second version of test.txt and a new file as well:
+
+
+
+
$ echo 'new file' > new.txt
+$ git update-index --add --cacheinfo 100644 \
+ 1f7a7a472abf3dd9643fd615f6da379c4acb3e3a test.txt
+$ git update-index --add new.txt
+
+
+
+
Your staging area now has the new version of test.txt as well as the new file new.txt.
+Write out that tree (recording the state of the staging area or index to a tree object) and see what it looks like:
+
+
+
+
$ git write-tree
+0155eb4229851634a0f03eb265b69f5a2d56f341
+$ git cat-file -p 0155eb4229851634a0f03eb265b69f5a2d56f341
+100644 blob fa49b077972391ad58037050f2a75f74e3671e92 new.txt
+100644 blob 1f7a7a472abf3dd9643fd615f6da379c4acb3e3a test.txt
+
+
+
+
Notice that this tree has both file entries and also that the test.txt SHA-1 is the “version 2” SHA-1 from earlier (1f7a7a).
+Just for fun, you’ll add the first tree as a subdirectory into this one.
+You can read trees into your staging area by calling git read-tree.
+In this case, you can read an existing tree into your staging area as a subtree by using the --prefix option with this command:
+
+
+
+
$ git read-tree --prefix=bak d8329fc1cc938780ffdd9f94e0d364e0ea74f579
+$ git write-tree
+3c4e9cd789d88d8d89c1073707c3585e41b0e614
+$ git cat-file -p 3c4e9cd789d88d8d89c1073707c3585e41b0e614
+040000 tree d8329fc1cc938780ffdd9f94e0d364e0ea74f579 bak
+100644 blob fa49b077972391ad58037050f2a75f74e3671e92 new.txt
+100644 blob 1f7a7a472abf3dd9643fd615f6da379c4acb3e3a test.txt
+
+
+
+
If you created a working directory from the new tree you just wrote, you would get the two files in the top level of the working directory and a subdirectory named bak that contained the first version of the test.txt file.
+You can think of the data that Git contains for these structures as being like this:
+
+
+
+
}}" alt="The content structure of your current Git data.">
+
+
نمودار 150. The content structure of your current Git data.
+
+
+
Commit Objects
+
+
If you’ve done all of the above, you now have three trees that represent the different snapshots of your project that you want to track, but the earlier problem remains: you must remember all three SHA-1 values in order to recall the snapshots.
+You also don’t have any information about who saved the snapshots, when they were saved, or why they were saved.
+This is the basic information that the commit object stores for you.
+
+
+
To create a commit object, you call commit-tree and specify a single tree SHA-1 and which commit objects, if any, directly preceded it.
+Start with the first tree you wrote:
+
+
+
+
$ echo 'First commit' | git commit-tree d8329f
+fdf4fc3344e67ab068f836878b6c4951e3b15f3d
+
+
+
+
You will get a different hash value because of different creation time and author data.
+Replace commit and tag hashes with your own checksums further in this chapter.
+Now you can look at your new commit object with git cat-file:
+
+
+
+
$ git cat-file -p fdf4fc3
+tree d8329fc1cc938780ffdd9f94e0d364e0ea74f579
+author Scott Chacon <schacon@gmail.com> 1243040974 -0700
+committer Scott Chacon <schacon@gmail.com> 1243040974 -0700
+
+First commit
+
+
+
+
The format for a commit object is simple: it specifies the top-level tree for the snapshot of the project at that point; the parent commits if any (the commit object described above does not have any parents); the author/committer information (which uses your user.name and user.email configuration settings and a timestamp); a blank line, and then the commit message.
+
+
+
Next, you’ll write the other two commit objects, each referencing the commit that came directly before it:
+
+
+
+
$ echo 'Second commit' | git commit-tree 0155eb -p fdf4fc3
+cac0cab538b970a37ea1e769cbbde608743bc96d
+$ echo 'Third commit' | git commit-tree 3c4e9c -p cac0cab
+1a410efbd13591db07496601ebc7a059dd55cfe9
+
+
+
+
Each of the three commit objects points to one of the three snapshot trees you created.
+Oddly enough, you have a real Git history now that you can view with the git log command, if you run it on the last commit SHA-1:
+
+
+
+
$ git log --stat 1a410e
+commit 1a410efbd13591db07496601ebc7a059dd55cfe9
+Author: Scott Chacon <schacon@gmail.com>
+Date: Fri May 22 18:15:24 2009 -0700
+
+ Third commit
+
+ bak/test.txt | 1 +
+ 1 file changed, 1 insertion(+)
+
+commit cac0cab538b970a37ea1e769cbbde608743bc96d
+Author: Scott Chacon <schacon@gmail.com>
+Date: Fri May 22 18:14:29 2009 -0700
+
+ Second commit
+
+ new.txt | 1 +
+ test.txt | 2 +-
+ 2 files changed, 2 insertions(+), 1 deletion(-)
+
+commit fdf4fc3344e67ab068f836878b6c4951e3b15f3d
+Author: Scott Chacon <schacon@gmail.com>
+Date: Fri May 22 18:09:34 2009 -0700
+
+ First commit
+
+ test.txt | 1 +
+ 1 file changed, 1 insertion(+)
+
+
+
+
Amazing.
+You’ve just done the low-level operations to build up a Git history without using any of the front end commands.
+This is essentially what Git does when you run the git add and git commit commands — it stores blobs for the files that have changed, updates the index, writes out trees, and writes commit objects that reference the top-level trees and the commits that came immediately before them.
+These three main Git objects — the blob, the tree, and the commit — are initially stored as separate files in your .git/objects directory.
+Here are all the objects in the example directory now, commented with what they store:
+
+
+
+
$ find .git/objects -type f
+.git/objects/01/55eb4229851634a0f03eb265b69f5a2d56f341 # tree 2
+.git/objects/1a/410efbd13591db07496601ebc7a059dd55cfe9 # commit 3
+.git/objects/1f/7a7a472abf3dd9643fd615f6da379c4acb3e3a # test.txt v2
+.git/objects/3c/4e9cd789d88d8d89c1073707c3585e41b0e614 # tree 3
+.git/objects/83/baae61804e65cc73a7201a7252750c76066a30 # test.txt v1
+.git/objects/ca/c0cab538b970a37ea1e769cbbde608743bc96d # commit 2
+.git/objects/d6/70460b4b4aece5915caf5c68d12f560a9fe3e4 # 'test content'
+.git/objects/d8/329fc1cc938780ffdd9f94e0d364e0ea74f579 # tree 1
+.git/objects/fa/49b077972391ad58037050f2a75f74e3671e92 # new.txt
+.git/objects/fd/f4fc3344e67ab068f836878b6c4951e3b15f3d # commit 1
+
+
+
+
If you follow all the internal pointers, you get an object graph something like this:
+
+
+
+
}}" alt="All the reachable objects in your Git directory.">
+
+
نمودار 151. All the reachable objects in your Git directory.
+
+
+
Object Storage
+
+
We mentioned earlier that there is a header stored with every object you commit to your Git object database.
+Let’s take a minute to see how Git stores its objects.
+You’ll see how to store a blob object — in this case, the string “what is up, doc?” — interactively in the Ruby scripting language.
+
+
+
You can start up interactive Ruby mode with the irb command:
+
+
+
+
$ irb
+>> content = "what is up, doc?"
+=> "what is up, doc?"
+
+
+
+
Git first constructs a header which starts by identifying the type of object — in this case, a blob.
+To that first part of the header, Git adds a space followed by the size in bytes of the content, and adding a final null byte:
+
+
+
+
>> header = "blob #{content.length}\0"
+=> "blob 16\u0000"
+
+
+
+
Git concatenates the header and the original content and then calculates the SHA-1 checksum of that new content.
+You can calculate the SHA-1 value of a string in Ruby by including the SHA1 digest library with the require command and then calling Digest::SHA1.hexdigest() with the string:
+
+
+
+
>> store = header + content
+=> "blob 16\u0000what is up, doc?"
+>> require 'digest/sha1'
+=> true
+>> sha1 = Digest::SHA1.hexdigest(store)
+=> "bd9dbf5aae1a3862dd1526723246b20206e5fc37"
+
+
+
+
Let’s compare that to the output of git hash-object.
+Here we use echo -n to prevent adding a newline to the input.
+
+
+
+
$ echo -n "what is up, doc?" | git hash-object --stdin
+bd9dbf5aae1a3862dd1526723246b20206e5fc37
+
+
+
+
Git compresses the new content with zlib, which you can do in Ruby with the zlib library.
+First, you need to require the library and then run Zlib::Deflate.deflate() on the content:
+
+
+
+
>> require 'zlib'
+=> true
+>> zlib_content = Zlib::Deflate.deflate(store)
+=> "x\x9CK\xCA\xC9OR04c(\xCFH,Q\xC8,V(-\xD0QH\xC9O\xB6\a\x00_\x1C\a\x9D"
+
+
+
+
Finally, you’ll write your zlib-deflated content to an object on disk.
+You’ll determine the path of the object you want to write out (the first two characters of the SHA-1 value being the subdirectory name, and the last 38 characters being the filename within that directory).
+In Ruby, you can use the FileUtils.mkdir_p() function to create the subdirectory if it doesn’t exist.
+Then, open the file with File.open() and write out the previously zlib-compressed content to the file with a write() call on the resulting file handle:
+
+
+
+
>> path = '.git/objects/' + sha1[0,2] + '/' + sha1[2,38]
+=> ".git/objects/bd/9dbf5aae1a3862dd1526723246b20206e5fc37"
+>> require 'fileutils'
+=> true
+>> FileUtils.mkdir_p(File.dirname(path))
+=> ".git/objects/bd"
+>> File.open(path, 'w') { |f| f.write zlib_content }
+=> 32
+
+
+
+
Let’s check the content of the object using git cat-file:
+
+
+
+
---
+$ git cat-file -p bd9dbf5aae1a3862dd1526723246b20206e5fc37
+what is up, doc?
+---
+
+
+
+
That’s it – you’ve created a valid Git blob object.
+
+
+
All Git objects are stored the same way, just with different types – instead of the string blob, the header will begin with commit or tree.
+Also, although the blob content can be nearly anything, the commit and tree content are very specifically formatted.
+
+
Git References
+
+
If you were interested in seeing the history of your repository reachable from commit, say, 1a410e, you could run something like git log 1a410e to display that history, but you would still have to remember that 1a410e is the commit you want to use as the starting point for that history.
+Instead, it would be easier if you had a file in which you could store that SHA-1 value under a simple name so you could use that simple name rather than the raw SHA-1 value.
+
+
In Git, these simple names are called “references” or “refs”; you can find the files that contain those SHA-1 values in the .git/refs directory.
+In the current project, this directory contains no files, but it does contain a simple structure:
+
+
+
$ find .git/refs
+.git/refs
+.git/refs/heads
+.git/refs/tags
+$ find .git/refs -type f
+
+
+
To create a new reference that will help you remember where your latest commit is, you can technically do something as simple as this:
+
+
+
$ echo 1a410efbd13591db07496601ebc7a059dd55cfe9 > .git/refs/heads/master
+
+
+
Now, you can use the head reference you just created instead of the SHA-1 value in your Git commands:
+
+
+
$ git log --pretty=oneline master
+1a410efbd13591db07496601ebc7a059dd55cfe9 Third commit
+cac0cab538b970a37ea1e769cbbde608743bc96d Second commit
+fdf4fc3344e67ab068f836878b6c4951e3b15f3d First commit
+
+
+
You aren’t encouraged to directly edit the reference files; instead, Git provides the safer command git update-ref to do this if you want to update a reference:
+
+
+
$ git update-ref refs/heads/master 1a410efbd13591db07496601ebc7a059dd55cfe9
+
+
+
That’s basically what a branch in Git is: a simple pointer or reference to the head of a line of work.
+To create a branch back at the second commit, you can do this:
+
+
+
$ git update-ref refs/heads/test cac0ca
+
+
+
Your branch will contain only work from that commit down:
+
+
+
$ git log --pretty=oneline test
+cac0cab538b970a37ea1e769cbbde608743bc96d Second commit
+fdf4fc3344e67ab068f836878b6c4951e3b15f3d First commit
+
+
+
Now, your Git database conceptually looks something like this:
+
+
+
}}" alt="Git directory objects with branch head references included.">
+
+
نمودار 152. Git directory objects with branch head references included.
+
+
When you run commands like git branch <branch>, Git basically runs that update-ref command to add the SHA-1 of the last commit of the branch you’re on into whatever new reference you want to create.
+
+
The HEAD
+
+
The question now is, when you run git branch <branch>, how does Git know the SHA-1 of the last commit?
+The answer is the HEAD file.
+
+
+
Usually the HEAD file is a symbolic reference to the branch you’re currently on.
+By symbolic reference, we mean that unlike a normal reference, it contains a pointer to another reference.
+
+
+
However in some rare cases the HEAD file may contain the SHA-1 value of a git object.
+This happens when you checkout a tag, commit, or remote branch, which puts your repository in "detached HEAD" state.
+
+
+
If you look at the file, you’ll normally see something like this:
+
+
+
+
$ cat .git/HEAD
+ref: refs/heads/master
+
+
+
+
If you run git checkout test, Git updates the file to look like this:
+
+
+
+
$ cat .git/HEAD
+ref: refs/heads/test
+
+
+
+
When you run git commit, it creates the commit object, specifying the parent of that commit object to be whatever SHA-1 value the reference in HEAD points to.
+
+
+
You can also manually edit this file, but again a safer command exists to do so: git symbolic-ref.
+You can read the value of your HEAD via this command:
+
+
+
+
$ git symbolic-ref HEAD
+refs/heads/master
+
+
+
+
You can also set the value of HEAD using the same command:
+
+
+
+
$ git symbolic-ref HEAD refs/heads/test
+$ cat .git/HEAD
+ref: refs/heads/test
+
+
+
+
You can’t set a symbolic reference outside of the refs style:
+
+
+
+
$ git symbolic-ref HEAD test
+fatal: Refusing to point HEAD outside of refs/
+
+
+
+
+
+
We just finished discussing Git’s three main object types (blobs, trees and commits), but there is a fourth.
+The tag object is very much like a commit object — it contains a tagger, a date, a message, and a pointer.
+The main difference is that a tag object generally points to a commit rather than a tree.
+It’s like a branch reference, but it never moves — it always points to the same commit but gives it a friendlier name.
+
+
+
As discussed in مقدمات گیت, there are two types of tags: annotated and lightweight.
+You can make a lightweight tag by running something like this:
+
+
+
+
$ git update-ref refs/tags/v1.0 cac0cab538b970a37ea1e769cbbde608743bc96d
+
+
+
+
That is all a lightweight tag is — a reference that never moves.
+An annotated tag is more complex, however.
+If you create an annotated tag, Git creates a tag object and then writes a reference to point to it rather than directly to the commit.
+You can see this by creating an annotated tag (using the -a option):
+
+
+
+
$ git tag -a v1.1 1a410efbd13591db07496601ebc7a059dd55cfe9 -m 'Test tag'
+
+
+
+
Here’s the object SHA-1 value it created:
+
+
+
+
$ cat .git/refs/tags/v1.1
+9585191f37f7b0fb9444f35a9bf50de191beadc2
+
+
+
+
Now, run git cat-file -p on that SHA-1 value:
+
+
+
+
$ git cat-file -p 9585191f37f7b0fb9444f35a9bf50de191beadc2
+object 1a410efbd13591db07496601ebc7a059dd55cfe9
+type commit
+tag v1.1
+tagger Scott Chacon <schacon@gmail.com> Sat May 23 16:48:58 2009 -0700
+
+Test tag
+
+
+
+
Notice that the object entry points to the commit SHA-1 value that you tagged.
+Also notice that it doesn’t need to point to a commit; you can tag any Git object.
+In the Git source code, for example, the maintainer has added their GPG public key as a blob object and then tagged it.
+You can view the public key by running this in a clone of the Git repository:
+
+
+
+
$ git cat-file blob junio-gpg-pub
+
+
+
+
The Linux kernel repository also has a non-commit-pointing tag object — the first tag created points to the initial tree of the import of the source code.
+
+
+
Remotes
+
+
The third type of reference that you’ll see is a remote reference.
+If you add a remote and push to it, Git stores the value you last pushed to that remote for each branch in the refs/remotes directory.
+For instance, you can add a remote called origin and push your master branch to it:
+
+
+
+
$ git remote add origin git@github.com:schacon/simplegit-progit.git
+$ git push origin master
+Counting objects: 11, done.
+Compressing objects: 100% (5/5), done.
+Writing objects: 100% (7/7), 716 bytes, done.
+Total 7 (delta 2), reused 4 (delta 1)
+To git@github.com:schacon/simplegit-progit.git
+ a11bef0..ca82a6d master -> master
+
+
+
+
Then, you can see what the master branch on the origin remote was the last time you communicated with the server, by checking the refs/remotes/origin/master file:
+
+
+
+
$ cat .git/refs/remotes/origin/master
+ca82a6dff817ec66f44342007202690a93763949
+
+
+
+
Remote references differ from branches (refs/heads references) mainly in that they’re considered read-only.
+You can git checkout to one, but Git won’t point HEAD at one, so you’ll never update it with a commit command.
+Git manages them as bookmarks to the last known state of where those branches were on those servers.
+
+
Maintenance and Data Recovery
+
+
Occasionally, you may have to do some cleanup – make a repository more compact, clean up an imported repository, or recover lost work.
+This section will cover some of these scenarios.
+
+
Maintenance
+
+
Occasionally, Git automatically runs a command called “auto gc”.
+Most of the time, this command does nothing.
+However, if there are too many loose objects (objects not in a packfile) or too many packfiles, Git launches a full-fledged git gc command.
+The “gc” stands for garbage collect, and the command does a number of things: it gathers up all the loose objects and places them in packfiles, it consolidates packfiles into one big packfile, and it removes objects that aren’t reachable from any commit and are a few months old.
+
+
+
You can run auto gc manually as follows:
+
+
+
+
Again, this generally does nothing.
+You must have around 7,000 loose objects or more than 50 packfiles for Git to fire up a real gc command.
+You can modify these limits with the gc.auto and gc.autopacklimit config settings, respectively.
+
+
+
The other thing gc will do is pack up your references into a single file.
+Suppose your repository contains the following branches and tags:
+
+
+
+
$ find .git/refs -type f
+.git/refs/heads/experiment
+.git/refs/heads/master
+.git/refs/tags/v1.0
+.git/refs/tags/v1.1
+
+
+
+
If you run git gc, you’ll no longer have these files in the refs directory.
+Git will move them for the sake of efficiency into a file named .git/packed-refs that looks like this:
+
+
+
+
$ cat .git/packed-refs
+# pack-refs with: peeled fully-peeled
+cac0cab538b970a37ea1e769cbbde608743bc96d refs/heads/experiment
+ab1afef80fac8e34258ff41fc1b867c702daa24b refs/heads/master
+cac0cab538b970a37ea1e769cbbde608743bc96d refs/tags/v1.0
+9585191f37f7b0fb9444f35a9bf50de191beadc2 refs/tags/v1.1
+^1a410efbd13591db07496601ebc7a059dd55cfe9
+
+
+
+
If you update a reference, Git doesn’t edit this file but instead writes a new file to refs/heads.
+To get the appropriate SHA-1 for a given reference, Git checks for that reference in the refs directory and then checks the packed-refs file as a fallback.
+However, if you can’t find a reference in the refs directory, it’s probably in your packed-refs file.
+
+
+
Notice the last line of the file, which begins with a ^.
+This means the tag directly above is an annotated tag and that line is the commit that the annotated tag points to.
+
+
+
Data Recovery
+
+
At some point in your Git journey, you may accidentally lose a commit.
+Generally, this happens because you force-delete a branch that had work on it, and it turns out you wanted the branch after all; or you hard-reset a branch, thus abandoning commits that you wanted something from.
+Assuming this happens, how can you get your commits back?
+
+
+
Here’s an example that hard-resets the master branch in your test repository to an older commit and then recovers the lost commits.
+First, let’s review where your repository is at this point:
+
+
+
+
$ git log --pretty=oneline
+ab1afef80fac8e34258ff41fc1b867c702daa24b Modify repo a bit
+484a59275031909e19aadb7c92262719cfcdf19a Create repo.rb
+1a410efbd13591db07496601ebc7a059dd55cfe9 Third commit
+cac0cab538b970a37ea1e769cbbde608743bc96d Second commit
+fdf4fc3344e67ab068f836878b6c4951e3b15f3d First commit
+
+
+
+
Now, move the master branch back to the middle commit:
+
+
+
+
$ git reset --hard 1a410efbd13591db07496601ebc7a059dd55cfe9
+HEAD is now at 1a410ef Third commit
+$ git log --pretty=oneline
+1a410efbd13591db07496601ebc7a059dd55cfe9 Third commit
+cac0cab538b970a37ea1e769cbbde608743bc96d Second commit
+fdf4fc3344e67ab068f836878b6c4951e3b15f3d First commit
+
+
+
+
You’ve effectively lost the top two commits – you have no branch from which those commits are reachable.
+You need to find the latest commit SHA-1 and then add a branch that points to it.
+The trick is finding that latest commit SHA-1 – it’s not like you’ve memorized it, right?
+
+
+
Often, the quickest way is to use a tool called git reflog.
+As you’re working, Git silently records what your HEAD is every time you change it.
+Each time you commit or change branches, the reflog is updated.
+The reflog is also updated by the git update-ref command, which is another reason to use it instead of just writing the SHA-1 value to your ref files, as we covered in Git References.
+You can see where you’ve been at any time by running git reflog:
+
+
+
+
$ git reflog
+1a410ef HEAD@{0}: reset: moving to 1a410ef
+ab1afef HEAD@{1}: commit: Modify repo.rb a bit
+484a592 HEAD@{2}: commit: Create repo.rb
+
+
+
+
Here we can see the two commits that we have had checked out, however there is not much information here.
+To see the same information in a much more useful way, we can run git log -g, which will give you a normal log output for your reflog.
+
+
+
+
$ git log -g
+commit 1a410efbd13591db07496601ebc7a059dd55cfe9
+Reflog: HEAD@{0} (Scott Chacon <schacon@gmail.com>)
+Reflog message: updating HEAD
+Author: Scott Chacon <schacon@gmail.com>
+Date: Fri May 22 18:22:37 2009 -0700
+
+ Third commit
+
+commit ab1afef80fac8e34258ff41fc1b867c702daa24b
+Reflog: HEAD@{1} (Scott Chacon <schacon@gmail.com>)
+Reflog message: updating HEAD
+Author: Scott Chacon <schacon@gmail.com>
+Date: Fri May 22 18:15:24 2009 -0700
+
+ Modify repo.rb a bit
+
+
+
+
It looks like the bottom commit is the one you lost, so you can recover it by creating a new branch at that commit.
+For example, you can start a branch named recover-branch at that commit (ab1afef):
+
+
+
+
$ git branch recover-branch ab1afef
+$ git log --pretty=oneline recover-branch
+ab1afef80fac8e34258ff41fc1b867c702daa24b Modify repo.rb a bit
+484a59275031909e19aadb7c92262719cfcdf19a Create repo.rb
+1a410efbd13591db07496601ebc7a059dd55cfe9 Third commit
+cac0cab538b970a37ea1e769cbbde608743bc96d Second commit
+fdf4fc3344e67ab068f836878b6c4951e3b15f3d First commit
+
+
+
+
Cool – now you have a branch named recover-branch that is where your master branch used to be, making the first two commits reachable again.
+Next, suppose your loss was for some reason not in the reflog – you can simulate that by removing recover-branch and deleting the reflog.
+Now the first two commits aren’t reachable by anything:
+
+
+
+
$ git branch -D recover-branch
+$ rm -Rf .git/logs/
+
+
+
+
Because the reflog data is kept in the .git/logs/ directory, you effectively have no reflog.
+How can you recover that commit at this point?
+One way is to use the git fsck utility, which checks your database for integrity.
+If you run it with the --full option, it shows you all objects that aren’t pointed to by another object:
+
+
+
+
$ git fsck --full
+Checking object directories: 100% (256/256), done.
+Checking objects: 100% (18/18), done.
+dangling blob d670460b4b4aece5915caf5c68d12f560a9fe3e4
+dangling commit ab1afef80fac8e34258ff41fc1b867c702daa24b
+dangling tree aea790b9a58f6cf6f2804eeac9f0abbe9631e4c9
+dangling blob 7108f7ecb345ee9d0084193f147cdad4d2998293
+
+
+
+
In this case, you can see your missing commit after the string “dangling commit”.
+You can recover it the same way, by adding a branch that points to that SHA-1.
+
+
+
Removing Objects
+
+
There are a lot of great things about Git, but one feature that can cause issues is the fact that a git clone downloads the entire history of the project, including every version of every file.
+This is fine if the whole thing is source code, because Git is highly optimized to compress that data efficiently.
+However, if someone at any point in the history of your project added a single huge file, every clone for all time will be forced to download that large file, even if it was removed from the project in the very next commit.
+Because it’s reachable from the history, it will always be there.
+
+
+
This can be a huge problem when you’re converting Subversion or Perforce repositories into Git.
+Because you don’t download the whole history in those systems, this type of addition carries few consequences.
+If you did an import from another system or otherwise find that your repository is much larger than it should be, here is how you can find and remove large objects.
+
+
+
Be warned: this technique is destructive to your commit history.
+It rewrites every commit object since the earliest tree you have to modify to remove a large file reference.
+If you do this immediately after an import, before anyone has started to base work on the commit, you’re fine – otherwise, you have to notify all contributors that they must rebase their work onto your new commits.
+
+
+
To demonstrate, you’ll add a large file into your test repository, remove it in the next commit, find it, and remove it permanently from the repository.
+First, add a large object to your history:
+
+
+
+
$ curl https://www.kernel.org/pub/software/scm/git/git-2.1.0.tar.gz > git.tgz
+$ git add git.tgz
+$ git commit -m 'Add git tarball'
+[master 7b30847] Add git tarball
+ 1 file changed, 0 insertions(+), 0 deletions(-)
+ create mode 100644 git.tgz
+
+
+
+
Oops – you didn’t want to add a huge tarball to your project.
+Better get rid of it:
+
+
+
+
$ git rm git.tgz
+rm 'git.tgz'
+$ git commit -m 'Oops - remove large tarball'
+[master dadf725] Oops - remove large tarball
+ 1 file changed, 0 insertions(+), 0 deletions(-)
+ delete mode 100644 git.tgz
+
+
+
+
Now, gc your database and see how much space you’re using:
+
+
+
+
$ git gc
+Counting objects: 17, done.
+Delta compression using up to 8 threads.
+Compressing objects: 100% (13/13), done.
+Writing objects: 100% (17/17), done.
+Total 17 (delta 1), reused 10 (delta 0)
+
+
+
+
You can run the count-objects command to quickly see how much space you’re using:
+
+
+
+
$ git count-objects -v
+count: 7
+size: 32
+in-pack: 17
+packs: 1
+size-pack: 4868
+prune-packable: 0
+garbage: 0
+size-garbage: 0
+
+
+
+
The size-pack entry is the size of your packfiles in kilobytes, so you’re using almost 5MB.
+Before the last commit, you were using closer to 2K – clearly, removing the file from the previous commit didn’t remove it from your history.
+Every time anyone clones this repository, they will have to clone all 5MB just to get this tiny project, because you accidentally added a big file.
+Let’s get rid of it.
+
+
+
First you have to find it.
+In this case, you already know what file it is.
+But suppose you didn’t; how would you identify what file or files were taking up so much space?
+If you run git gc, all the objects are in a packfile; you can identify the big objects by running another plumbing command called git verify-pack and sorting on the third field in the output, which is file size.
+You can also pipe it through the tail command because you’re only interested in the last few largest files:
+
+
+
+
$ git verify-pack -v .git/objects/pack/pack-29…69.idx \
+ | sort -k 3 -n \
+ | tail -3
+dadf7258d699da2c8d89b09ef6670edb7d5f91b4 commit 229 159 12
+033b4468fa6b2a9547a70d88d1bbe8bf3f9ed0d5 blob 22044 5792 4977696
+82c99a3e86bb1267b236a4b6eff7868d97489af1 blob 4975916 4976258 1438
+
+
+
+
The big object is at the bottom: 5MB.
+To find out what file it is, you’ll use the rev-list command, which you used briefly in Enforcing a Specific Commit-Message Format.
+If you pass --objects to rev-list, it lists all the commit SHA-1s and also the blob SHA-1s with the file paths associated with them.
+You can use this to find your blob’s name:
+
+
+
+
$ git rev-list --objects --all | grep 82c99a3
+82c99a3e86bb1267b236a4b6eff7868d97489af1 git.tgz
+
+
+
+
Now, you need to remove this file from all trees in your past.
+You can easily see what commits modified this file:
+
+
+
+
$ git log --oneline --branches -- git.tgz
+dadf725 Oops - remove large tarball
+7b30847 Add git tarball
+
+
+
+
You must rewrite all the commits downstream from 7b30847 to fully remove this file from your Git history.
+To do so, you use filter-branch, which you used in Rewriting History:
+
+
+
+
$ git filter-branch --index-filter \
+ 'git rm --ignore-unmatch --cached git.tgz' -- 7b30847^..
+Rewrite 7b30847d080183a1ab7d18fb202473b3096e9f34 (1/2)rm 'git.tgz'
+Rewrite dadf7258d699da2c8d89b09ef6670edb7d5f91b4 (2/2)
+Ref 'refs/heads/master' was rewritten
+
+
+
+
The --index-filter option is similar to the --tree-filter option used in Rewriting History, except that instead of passing a command that modifies files checked out on disk, you’re modifying your staging area or index each time.
+
+
+
Rather than remove a specific file with something like rm file, you have to remove it with git rm --cached – you must remove it from the index, not from disk.
+The reason to do it this way is speed – because Git doesn’t have to check out each revision to disk before running your filter, the process can be much, much faster.
+You can accomplish the same task with --tree-filter if you want.
+The --ignore-unmatch option to git rm tells it not to error out if the pattern you’re trying to remove isn’t there.
+Finally, you ask filter-branch to rewrite your history only from the 7b30847 commit up, because you know that is where this problem started.
+Otherwise, it will start from the beginning and will unnecessarily take longer.
+
+
+
Your history no longer contains a reference to that file.
+However, your reflog and a new set of refs that Git added when you did the filter-branch under .git/refs/original still do, so you have to remove them and then repack the database.
+You need to get rid of anything that has a pointer to those old commits before you repack:
+
+
+
+
$ rm -Rf .git/refs/original
+$ rm -Rf .git/logs/
+$ git gc
+Counting objects: 15, done.
+Delta compression using up to 8 threads.
+Compressing objects: 100% (11/11), done.
+Writing objects: 100% (15/15), done.
+Total 15 (delta 1), reused 12 (delta 0)
+
+
+
+
Let’s see how much space you saved.
+
+
+
+
$ git count-objects -v
+count: 11
+size: 4904
+in-pack: 15
+packs: 1
+size-pack: 8
+prune-packable: 0
+garbage: 0
+size-garbage: 0
+
+
+
+
The packed repository size is down to 8K, which is much better than 5MB.
+You can see from the size value that the big object is still in your loose objects, so it’s not gone; but it won’t be transferred on a push or subsequent clone, which is what is important.
+If you really wanted to, you could remove the object completely by running git prune with the --expire option:
+
+
+
+
$ git prune --expire now
+$ git count-objects -v
+count: 0
+size: 0
+in-pack: 15
+packs: 1
+size-pack: 8
+prune-packable: 0
+garbage: 0
+size-garbage: 0
+
+
+
Packfiles
+
+
If you followed all of the instructions in the example from the previous section, you should now have a test Git repository with 11 objects — four blobs, three trees, three commits, and one tag:
+
+
+
$ find .git/objects -type f
+.git/objects/01/55eb4229851634a0f03eb265b69f5a2d56f341 # tree 2
+.git/objects/1a/410efbd13591db07496601ebc7a059dd55cfe9 # commit 3
+.git/objects/1f/7a7a472abf3dd9643fd615f6da379c4acb3e3a # test.txt v2
+.git/objects/3c/4e9cd789d88d8d89c1073707c3585e41b0e614 # tree 3
+.git/objects/83/baae61804e65cc73a7201a7252750c76066a30 # test.txt v1
+.git/objects/95/85191f37f7b0fb9444f35a9bf50de191beadc2 # tag
+.git/objects/ca/c0cab538b970a37ea1e769cbbde608743bc96d # commit 2
+.git/objects/d6/70460b4b4aece5915caf5c68d12f560a9fe3e4 # 'test content'
+.git/objects/d8/329fc1cc938780ffdd9f94e0d364e0ea74f579 # tree 1
+.git/objects/fa/49b077972391ad58037050f2a75f74e3671e92 # new.txt
+.git/objects/fd/f4fc3344e67ab068f836878b6c4951e3b15f3d # commit 1
+
+
+
Git compresses the contents of these files with zlib, and you’re not storing much, so all these files collectively take up only 925 bytes.
+Now you’ll add some more sizable content to the repository to demonstrate an interesting feature of Git.
+To demonstrate, we’ll add the repo.rb file from the Grit library — this is about a 22K source code file:
+
+
+
$ curl https://raw.githubusercontent.com/mojombo/grit/master/lib/grit/repo.rb > repo.rb
+$ git checkout master
+$ git add repo.rb
+$ git commit -m 'Create repo.rb'
+[master 484a592] Create repo.rb
+ 3 files changed, 709 insertions(+), 2 deletions(-)
+ delete mode 100644 bak/test.txt
+ create mode 100644 repo.rb
+ rewrite test.txt (100%)
+
+
+
If you look at the resulting tree, you can see the SHA-1 value that was calculated for your new repo.rb blob object:
+
+
+
$ git cat-file -p master^{tree}
+100644 blob fa49b077972391ad58037050f2a75f74e3671e92 new.txt
+100644 blob 033b4468fa6b2a9547a70d88d1bbe8bf3f9ed0d5 repo.rb
+100644 blob e3f094f522629ae358806b17daf78246c27c007b test.txt
+
+
+
You can then use git cat-file to see how large that object is:
+
+
+
$ git cat-file -s 033b4468fa6b2a9547a70d88d1bbe8bf3f9ed0d5
+22044
+
+
+
At this point, modify that file a little, and see what happens:
+
+
+
$ echo '# testing' >> repo.rb
+$ git commit -am 'Modify repo.rb a bit'
+[master 2431da6] Modify repo.rb a bit
+ 1 file changed, 1 insertion(+)
+
+
+
Check the tree created by that last commit, and you see something interesting:
+
+
+
$ git cat-file -p master^{tree}
+100644 blob fa49b077972391ad58037050f2a75f74e3671e92 new.txt
+100644 blob b042a60ef7dff760008df33cee372b945b6e884e repo.rb
+100644 blob e3f094f522629ae358806b17daf78246c27c007b test.txt
+
+
+
The blob is now a different blob, which means that although you added only a single line to the end of a 400-line file, Git stored that new content as a completely new object:
+
+
+
$ git cat-file -s b042a60ef7dff760008df33cee372b945b6e884e
+22054
+
+
+
You have two nearly identical 22K objects on your disk (each compressed to approximately 7K).
+Wouldn’t it be nice if Git could store one of them in full but then the second object only as the delta between it and the first?
+
+
It turns out that it can.
+The initial format in which Git saves objects on disk is called a “loose” object format.
+However, occasionally Git packs up several of these objects into a single binary file called a “packfile” in order to save space and be more efficient.
+Git does this if you have too many loose objects around, if you run the git gc command manually, or if you push to a remote server.
+To see what happens, you can manually ask Git to pack up the objects by calling the git gc command:
+
+
+
$ git gc
+Counting objects: 18, done.
+Delta compression using up to 8 threads.
+Compressing objects: 100% (14/14), done.
+Writing objects: 100% (18/18), done.
+Total 18 (delta 3), reused 0 (delta 0)
+
+
+
If you look in your objects directory, you’ll find that most of your objects are gone, and a new pair of files has appeared:
+
+
+
$ find .git/objects -type f
+.git/objects/bd/9dbf5aae1a3862dd1526723246b20206e5fc37
+.git/objects/d6/70460b4b4aece5915caf5c68d12f560a9fe3e4
+.git/objects/info/packs
+.git/objects/pack/pack-978e03944f5c581011e6998cd0e9e30000905586.idx
+.git/objects/pack/pack-978e03944f5c581011e6998cd0e9e30000905586.pack
+
+
+
The objects that remain are the blobs that aren’t pointed to by any commit — in this case, the “what is up, doc?” example and the “test content” example blobs you created earlier.
+Because you never added them to any commits, they’re considered dangling and aren’t packed up in your new packfile.
+
+
The other files are your new packfile and an index.
+The packfile is a single file containing the contents of all the objects that were removed from your filesystem.
+The index is a file that contains offsets into that packfile so you can quickly seek to a specific object.
+What is cool is that although the objects on disk before you ran the gc command were collectively about 15K in size, the new packfile is only 7K.
+You’ve cut your disk usage by half by packing your objects.
+
+
How does Git do this?
+When Git packs objects, it looks for files that are named and sized similarly, and stores just the deltas from one version of the file to the next.
+You can look into the packfile and see what Git did to save space.
+The git verify-pack plumbing command allows you to see what was packed up:
+
+
+
$ git verify-pack -v .git/objects/pack/pack-978e03944f5c581011e6998cd0e9e30000905586.idx
+2431da676938450a4d72e260db3bf7b0f587bbc1 commit 223 155 12
+69bcdaff5328278ab1c0812ce0e07fa7d26a96d7 commit 214 152 167
+80d02664cb23ed55b226516648c7ad5d0a3deb90 commit 214 145 319
+43168a18b7613d1281e5560855a83eb8fde3d687 commit 213 146 464
+092917823486a802e94d727c820a9024e14a1fc2 commit 214 146 610
+702470739ce72005e2edff522fde85d52a65df9b commit 165 118 756
+d368d0ac0678cbe6cce505be58126d3526706e54 tag 130 122 874
+fe879577cb8cffcdf25441725141e310dd7d239b tree 136 136 996
+d8329fc1cc938780ffdd9f94e0d364e0ea74f579 tree 36 46 1132
+deef2e1b793907545e50a2ea2ddb5ba6c58c4506 tree 136 136 1178
+d982c7cb2c2a972ee391a85da481fc1f9127a01d tree 6 17 1314 1 \
+ deef2e1b793907545e50a2ea2ddb5ba6c58c4506
+3c4e9cd789d88d8d89c1073707c3585e41b0e614 tree 8 19 1331 1 \
+ deef2e1b793907545e50a2ea2ddb5ba6c58c4506
+0155eb4229851634a0f03eb265b69f5a2d56f341 tree 71 76 1350
+83baae61804e65cc73a7201a7252750c76066a30 blob 10 19 1426
+fa49b077972391ad58037050f2a75f74e3671e92 blob 9 18 1445
+b042a60ef7dff760008df33cee372b945b6e884e blob 22054 5799 1463
+033b4468fa6b2a9547a70d88d1bbe8bf3f9ed0d5 blob 9 20 7262 1 \
+ b042a60ef7dff760008df33cee372b945b6e884e
+1f7a7a472abf3dd9643fd615f6da379c4acb3e3a blob 10 19 7282
+non delta: 15 objects
+chain length = 1: 3 objects
+.git/objects/pack/pack-978e03944f5c581011e6998cd0e9e30000905586.pack: ok
+
+
+
Here, the 033b4 blob, which if you remember was the first version of your repo.rb file, is referencing the b042a blob, which was the second version of the file.
+The third column in the output is the size of the object in the pack, so you can see that b042a takes up 22K of the file, but that 033b4 only takes up 9 bytes.
+What is also interesting is that the second version of the file is the one that is stored intact, whereas the original version is stored as a delta — this is because you’re most likely to need faster access to the most recent version of the file.
+
+
The really nice thing about this is that it can be repacked at any time.
+Git will occasionally repack your database automatically, always trying to save more space, but you can also manually repack at any time by running git gc by hand.
+
You may have skipped to this chapter from a much earlier chapter, or you may have gotten here after sequentially reading the entire book up to this point — in either case, this is where we’ll go over the inner workings and implementation of Git.
+We found that understanding this information was fundamentally important to appreciating how useful and powerful Git is, but others have argued to us that it can be confusing and unnecessarily complex for beginners.
+Thus, we’ve made this discussion the last chapter in the book so you could read it early or later in your learning process.
+We leave it up to you to decide.
Now that you’re here, let’s get started.
+First, if it isn’t yet clear, Git is fundamentally a content-addressable filesystem with a VCS user interface written on top of it.
+You’ll learn more about what this means in a bit.
In the early days of Git (mostly pre 1.5), the user interface was much more complex because it emphasized this filesystem rather than a polished VCS.
+In the last few years, the UI has been refined until it’s as clean and easy to use as any system out there; however, the stereotype lingers about the early Git UI that was complex and difficult to learn.
The content-addressable filesystem layer is amazingly cool, so we’ll cover that first in this chapter; then, you’ll learn about the transport mechanisms and the repository maintenance tasks that you may eventually have to deal with.
+Plumbing and Porcelain
+
+
This book covers primarily how to use Git with 30 or so subcommands such as checkout, branch, remote, and so on.
+But because Git was initially a toolkit for a version control system rather than a full user-friendly VCS, it has a number of subcommands that do low-level work and were designed to be chained together UNIX-style or called from scripts.
+These commands are generally referred to as Git’s “plumbing” commands, while the more user-friendly commands are called “porcelain” commands.
+
+
As you will have noticed by now, this book’s first nine chapters deal almost exclusively with porcelain commands.
+But in this chapter, you’ll be dealing mostly with the lower-level plumbing commands, because they give you access to the inner workings of Git, and help demonstrate how and why Git does what it does.
+Many of these commands aren’t meant to be used manually on the command line, but rather to be used as building blocks for new tools and custom scripts.
+
+
When you run git init in a new or existing directory, Git creates the .git directory, which is where almost everything that Git stores and manipulates is located.
+If you want to back up or clone your repository, copying this single directory elsewhere gives you nearly everything you need.
+This entire chapter basically deals with what you can see in this directory.
+Here’s what a newly-initialized .git directory typically looks like:
+
+
+
$ ls -F1
+config
+description
+HEAD
+hooks/
+info/
+objects/
+refs/
+
+
+
Depending on your version of Git, you may see some additional content there, but this is a fresh git init repository — it’s what you see by default.
+The description file is used only by the GitWeb program, so don’t worry about it.
+The config file contains your project-specific configuration options, and the info directory keeps a global exclude file for ignored patterns that you don’t want to track in a .gitignore file.
+The hooks directory contains your client- or server-side hook scripts, which are discussed in detail in Git Hooks.
+
+
This leaves four important entries: the HEAD and (yet to be created) index files, and the objects and refs directories.
+These are the core parts of Git.
+The objects directory stores all the content for your database, the refs directory stores pointers into commit objects in that data (branches, tags, remotes and more), the HEAD file points to the branch you currently have checked out, and the index file is where Git stores your staging area information.
+You’ll now look at each of these sections in detail to see how Git operates.
+
Summary
+
+
At this point, you should have a pretty good understanding of what Git does in the background and, to some degree, how it’s implemented.
+This chapter has covered a number of plumbing commands — commands that are lower level and simpler than the porcelain commands you’ve learned about in the rest of the book.
+Understanding how Git works at a lower level should make it easier to understand why it’s doing what it’s doing and also to write your own tools and helper scripts to make your specific workflow work for you.
+
+
Git as a content-addressable filesystem is a very powerful tool that you can easily use as more than just a VCS.
+We hope you can use your newfound knowledge of Git internals to implement your own cool application of this technology and feel more comfortable using Git in more advanced ways.
+
The Refspec
+
+
Throughout this book, we’ve used simple mappings from remote branches to local references, but they can be more complex.
+Suppose you were following along with the last couple sections and had created a small local Git repository, and now wanted to add a remote to it:
+
+
+
$ git remote add origin https://github.com/schacon/simplegit-progit
+
+
+
Running the command above adds a section to your repository’s .git/config file, specifying the name of the remote (origin), the URL of the remote repository, and the refspec to be used for fetching:
+
+
+
[remote "origin"]
+ url = https://github.com/schacon/simplegit-progit
+ fetch = +refs/heads/*:refs/remotes/origin/*
+
+
+
The format of the refspec is, first, an optional +, followed by <src>:<dst>, where <src> is the pattern for references on the remote side and <dst> is where those references will be tracked locally.
+The + tells Git to update the reference even if it isn’t a fast-forward.
+
+
In the default case that is automatically written by a git remote add origin command, Git fetches all the references under refs/heads/ on the server and writes them to refs/remotes/origin/ locally.
+So, if there is a master branch on the server, you can access the log of that branch locally via any of the following:
+
+
+
$ git log origin/master
+$ git log remotes/origin/master
+$ git log refs/remotes/origin/master
+
+
+
They’re all equivalent, because Git expands each of them to refs/remotes/origin/master.
+
+
If you want Git instead to pull down only the master branch each time, and not every other branch on the remote server, you can change the fetch line to refer to that branch only:
+
+
+
fetch = +refs/heads/master:refs/remotes/origin/master
+
+
+
This is just the default refspec for git fetch for that remote.
+If you want to do a one-time only fetch, you can specify the specific refspec on the command line, too.
+To pull the master branch on the remote down to origin/mymaster locally, you can run:
+
+
+
$ git fetch origin master:refs/remotes/origin/mymaster
+
+
+
You can also specify multiple refspecs.
+On the command line, you can pull down several branches like so:
+
+
+
$ git fetch origin master:refs/remotes/origin/mymaster \
+ topic:refs/remotes/origin/topic
+From git@github.com:schacon/simplegit
+ ! [rejected] master -> origin/mymaster (non fast forward)
+ * [new branch] topic -> origin/topic
+
+
+
In this case, the master branch pull was rejected because it wasn’t listed as a fast-forward reference.
+You can override that by specifying the + in front of the refspec.
+
+
You can also specify multiple refspecs for fetching in your configuration file.
+If you want to always fetch the master and experiment branches from the origin remote, add two lines:
+
+
+
[remote "origin"]
+ url = https://github.com/schacon/simplegit-progit
+ fetch = +refs/heads/master:refs/remotes/origin/master
+ fetch = +refs/heads/experiment:refs/remotes/origin/experiment
+
+
+
You can’t use partial globs in the pattern, so this would be invalid:
+
+
+
fetch = +refs/heads/qa*:refs/remotes/origin/qa*
+
+
+
However, you can use namespaces (or directories) to accomplish something like that.
+If you have a QA team that pushes a series of branches, and you want to get the master branch and any of the QA team’s branches but nothing else, you can use a config section like this:
+
+
+
[remote "origin"]
+ url = https://github.com/schacon/simplegit-progit
+ fetch = +refs/heads/master:refs/remotes/origin/master
+ fetch = +refs/heads/qa/*:refs/remotes/origin/qa/*
+
+
+
If you have a complex workflow process that has a QA team pushing branches, developers pushing branches, and integration teams pushing and collaborating on remote branches, you can namespace them easily this way.
+
+
Pushing Refspecs
+
+
It’s nice that you can fetch namespaced references that way, but how does the QA team get their branches into a qa/ namespace in the first place?
+You accomplish that by using refspecs to push.
+
+
+
If the QA team wants to push their master branch to qa/master on the remote server, they can run
+
+
+
+
$ git push origin master:refs/heads/qa/master
+
+
+
+
If they want Git to do that automatically each time they run git push origin, they can add a push value to their config file:
+
+
+
+
[remote "origin"]
+ url = https://github.com/schacon/simplegit-progit
+ fetch = +refs/heads/*:refs/remotes/origin/*
+ push = refs/heads/master:refs/heads/qa/master
+
+
+
+
Again, this will cause a git push origin to push the local master branch to the remote qa/master branch by default.
+
+
+
+
Deleting References
+
+
You can also use the refspec to delete references from the remote server by running something like this:
+
+
+
+
$ git push origin :topic
+
+
+
+
Because the refspec is <src>:<dst>, by leaving off the <src> part, this basically says to make the topic branch on the remote nothing, which deletes it.
+
+
+
Or you can use the newer syntax (available since Git v1.7.0):
+
+
+
+
$ git push origin --delete topic
+
+
+
Transfer Protocols
+
+
Git can transfer data between two repositories in two major ways: the “dumb” protocol and the “smart” protocol.
+This section will quickly cover how these two main protocols operate.
+
+
The Dumb Protocol
+
+
If you’re setting up a repository to be served read-only over HTTP, the dumb protocol is likely what will be used.
+This protocol is called “dumb” because it requires no Git-specific code on the server side during the transport process; the fetch process is a series of HTTP GET requests, where the client can assume the layout of the Git repository on the server.
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ The dumb protocol is fairly rarely used these days.
+It’s difficult to secure or make private, so most Git hosts (both cloud-based and on-premises) will refuse to use it.
+It’s generally advised to use the smart protocol, which we describe a bit further on.
+ |
+
+
+
+
+
Let’s follow the http-fetch process for the simplegit library:
+
+
+
+
$ git clone http://server/simplegit-progit.git
+
+
+
+
The first thing this command does is pull down the info/refs file.
+This file is written by the update-server-info command, which is why you need to enable that as a post-receive hook in order for the HTTP transport to work properly:
+
+
+
+
=> GET info/refs
+ca82a6dff817ec66f44342007202690a93763949 refs/heads/master
+
+
+
+
Now you have a list of the remote references and SHA-1s.
+Next, you look for what the HEAD reference is so you know what to check out when you’re finished:
+
+
+
+
=> GET HEAD
+ref: refs/heads/master
+
+
+
+
You need to check out the master branch when you’ve completed the process.
+At this point, you’re ready to start the walking process.
+Because your starting point is the ca82a6 commit object you saw in the info/refs file, you start by fetching that:
+
+
+
+
=> GET objects/ca/82a6dff817ec66f44342007202690a93763949
+(179 bytes of binary data)
+
+
+
+
You get an object back – that object is in loose format on the server, and you fetched it over a static HTTP GET request.
+You can zlib-uncompress it, strip off the header, and look at the commit content:
+
+
+
+
$ git cat-file -p ca82a6dff817ec66f44342007202690a93763949
+tree cfda3bf379e4f8dba8717dee55aab78aef7f4daf
+parent 085bb3bcb608e1e8451d4b2432f8ecbe6306e7e7
+author Scott Chacon <schacon@gmail.com> 1205815931 -0700
+committer Scott Chacon <schacon@gmail.com> 1240030591 -0700
+
+Change version number
+
+
+
+
Next, you have two more objects to retrieve – cfda3b, which is the tree of content that the commit we just retrieved points to; and 085bb3, which is the parent commit:
+
+
+
+
=> GET objects/08/5bb3bcb608e1e8451d4b2432f8ecbe6306e7e7
+(179 bytes of data)
+
+
+
+
That gives you your next commit object.
+Grab the tree object:
+
+
+
+
=> GET objects/cf/da3bf379e4f8dba8717dee55aab78aef7f4daf
+(404 - Not Found)
+
+
+
+
Oops – it looks like that tree object isn’t in loose format on the server, so you get a 404 response back.
+There are a couple of reasons for this – the object could be in an alternate repository, or it could be in a packfile in this repository.
+Git checks for any listed alternates first:
+
+
+
+
=> GET objects/info/http-alternates
+(empty file)
+
+
+
+
If this comes back with a list of alternate URLs, Git checks for loose files and packfiles there – this is a nice mechanism for projects that are forks of one another to share objects on disk.
+However, because no alternates are listed in this case, your object must be in a packfile.
+To see what packfiles are available on this server, you need to get the objects/info/packs file, which contains a listing of them (also generated by update-server-info):
+
+
+
+
=> GET objects/info/packs
+P pack-816a9b2334da9953e530f27bcac22082a9f5b835.pack
+
+
+
+
There is only one packfile on the server, so your object is obviously in there, but you’ll check the index file to make sure.
+This is also useful if you have multiple packfiles on the server, so you can see which packfile contains the object you need:
+
+
+
+
=> GET objects/pack/pack-816a9b2334da9953e530f27bcac22082a9f5b835.idx
+(4k of binary data)
+
+
+
+
Now that you have the packfile index, you can see if your object is in it – because the index lists the SHA-1s of the objects contained in the packfile and the offsets to those objects.
+Your object is there, so go ahead and get the whole packfile:
+
+
+
+
=> GET objects/pack/pack-816a9b2334da9953e530f27bcac22082a9f5b835.pack
+(13k of binary data)
+
+
+
+
You have your tree object, so you continue walking your commits.
+They’re all also within the packfile you just downloaded, so you don’t have to do any more requests to your server.
+Git checks out a working copy of the master branch that was pointed to by the HEAD reference you downloaded at the beginning.
+
+
+
The Smart Protocol
+
+
The dumb protocol is simple but a bit inefficient, and it can’t handle writing of data from the client to the server.
+The smart protocol is a more common method of transferring data, but it requires a process on the remote end that is intelligent about Git – it can read local data, figure out what the client has and needs, and generate a custom packfile for it.
+There are two sets of processes for transferring data: a pair for uploading data and a pair for downloading data.
+
+
+
Uploading Data
+
+
+To upload data to a remote process, Git uses the send-pack and receive-pack processes.
+The send-pack process runs on the client and connects to a receive-pack process on the remote side.
+
+
+
SSH
+
+
For example, say you run git push origin master in your project, and origin is defined as a URL that uses the SSH protocol.
+Git fires up the send-pack process, which initiates a connection over SSH to your server.
+It tries to run a command on the remote server via an SSH call that looks something like this:
+
+
+
+
$ ssh -x git@server "git-receive-pack 'simplegit-progit.git'"
+00a5ca82a6dff817ec66f4437202690a93763949 refs/heads/master□report-status \
+ delete-refs side-band-64k quiet ofs-delta \
+ agent=git/2:2.1.1+github-607-gfba4028 delete-refs
+0000
+
+
+
+
The git-receive-pack command immediately responds with one line for each reference it currently has – in this case, just the master branch and its SHA-1.
+The first line also has a list of the server’s capabilities (here, report-status, delete-refs, and some others, including the client identifier).
+
+
+
Each line starts with a 4-character hex value specifying how long the rest of the line is.
+Your first line starts with 00a5, which is hexadecimal for 165, meaning that 165 bytes remain on that line.
+The next line is 0000, meaning the server is done with its references listing.
+
+
+
Now that it knows the server’s state, your send-pack process determines what commits it has that the server doesn’t.
+For each reference that this push will update, the send-pack process tells the receive-pack process that information.
+For instance, if you’re updating the master branch and adding an experiment branch, the send-pack response may look something like this:
+
+
+
+
0076ca82a6dff817ec66f44342007202690a93763949 15027957951b64cf874c3557a0f3547bd83b3ff6 \
+ refs/heads/master report-status
+006c0000000000000000000000000000000000000000 cdfdb42577e2506715f8cfeacdbabc092bf63e8d \
+ refs/heads/experiment
+0000
+
+
+
+
Git sends a line for each reference you’re updating with the line’s length, the old SHA-1, the new SHA-1, and the reference that is being updated.
+The first line also has the client’s capabilities.
+The SHA-1 value of all '0’s means that nothing was there before – because you’re adding the experiment reference.
+If you were deleting a reference, you would see the opposite: all '0’s on the right side.
+
+
+
Next, the client sends a packfile of all the objects the server doesn’t have yet.
+Finally, the server responds with a success (or failure) indication:
+
+
+
+
+
HTTP(S)
+
+
This process is mostly the same over HTTP, though the handshaking is a bit different.
+The connection is initiated with this request:
+
+
+
+
=> GET http://server/simplegit-progit.git/info/refs?service=git-receive-pack
+001f# service=git-receive-pack
+00ab6c5f0e45abd7832bf23074a333f739977c9e8188 refs/heads/master□report-status \
+ delete-refs side-band-64k quiet ofs-delta \
+ agent=git/2:2.1.1~vmg-bitmaps-bugaloo-608-g116744e
+0000
+
+
+
+
That’s the end of the first client-server exchange.
+The client then makes another request, this time a POST, with the data that send-pack provides.
+
+
+
+
=> POST http://server/simplegit-progit.git/git-receive-pack
+
+
+
+
The POST request includes the send-pack output and the packfile as its payload.
+The server then indicates success or failure with its HTTP response.
+
+
+
+
+
Downloading Data
+
+
+When you download data, the fetch-pack and upload-pack processes are involved.
+The client initiates a fetch-pack process that connects to an upload-pack process on the remote side to negotiate what data will be transferred down.
+
+
+
SSH
+
+
If you’re doing the fetch over SSH, fetch-pack runs something like this:
+
+
+
+
$ ssh -x git@server "git-upload-pack 'simplegit-progit.git'"
+
+
+
+
After fetch-pack connects, upload-pack sends back something like this:
+
+
+
+
00dfca82a6dff817ec66f44342007202690a93763949 HEAD□multi_ack thin-pack \
+ side-band side-band-64k ofs-delta shallow no-progress include-tag \
+ multi_ack_detailed symref=HEAD:refs/heads/master \
+ agent=git/2:2.1.1+github-607-gfba4028
+003fe2409a098dc3e53539a9028a94b6224db9d6a6b6 refs/heads/master
+0000
+
+
+
+
This is very similar to what receive-pack responds with, but the capabilities are different.
+In addition, it sends back what HEAD points to (symref=HEAD:refs/heads/master) so the client knows what to check out if this is a clone.
+
+
+
At this point, the fetch-pack process looks at what objects it has and responds with the objects that it needs by sending “want” and then the SHA-1 it wants.
+It sends all the objects it already has with “have” and then the SHA-1.
+At the end of this list, it writes “done” to initiate the upload-pack process to begin sending the packfile of the data it needs:
+
+
+
+
003cwant ca82a6dff817ec66f44342007202690a93763949 ofs-delta
+0032have 085bb3bcb608e1e8451d4b2432f8ecbe6306e7e7
+0009done
+0000
+
+
+
+
+
HTTP(S)
+
+
The handshake for a fetch operation takes two HTTP requests.
+The first is a GET to the same endpoint used in the dumb protocol:
+
+
+
+
=> GET $GIT_URL/info/refs?service=git-upload-pack
+001e# service=git-upload-pack
+00e7ca82a6dff817ec66f44342007202690a93763949 HEAD□multi_ack thin-pack \
+ side-band side-band-64k ofs-delta shallow no-progress include-tag \
+ multi_ack_detailed no-done symref=HEAD:refs/heads/master \
+ agent=git/2:2.1.1+github-607-gfba4028
+003fca82a6dff817ec66f44342007202690a93763949 refs/heads/master
+0000
+
+
+
+
This is very similar to invoking git-upload-pack over an SSH connection, but the second exchange is performed as a separate request:
+
+
+
+
=> POST $GIT_URL/git-upload-pack HTTP/1.0
+0032want 0a53e9ddeaddad63ad106860237bbf53411d11a7
+0032have 441b40d833fdfa93eb2908e52742248faf0ee993
+0000
+
+
+
+
Again, this is the same format as above.
+The response to this request indicates success or failure, and includes the packfile.
+
+
+
+
+
Protocols Summary
+
+
This section contains a very basic overview of the transfer protocols.
+The protocol includes many other features, such as multi_ack or side-band capabilities, but covering them is outside the scope of this book.
+We’ve tried to give you a sense of the general back-and-forth between client and server; if you need more knowledge than this, you’ll probably want to take a look at the Git source code.
+
+
Advanced Merging
+
+
Merging in Git is typically fairly easy.
+Since Git makes it easy to merge another branch multiple times, it means that you can have a very long lived branch but you can keep it up to date as you go, solving small conflicts often, rather than be surprised by one enormous conflict at the end of the series.
+
+
However, sometimes tricky conflicts do occur.
+Unlike some other version control systems, Git does not try to be overly clever about merge conflict resolution.
+Git’s philosophy is to be smart about determining when a merge resolution is unambiguous, but if there is a conflict, it does not try to be clever about automatically resolving it.
+Therefore, if you wait too long to merge two branches that diverge quickly, you can run into some issues.
+
+
In this section, we’ll go over what some of those issues might be and what tools Git gives you to help handle these more tricky situations.
+We’ll also cover some of the different, non-standard types of merges you can do, as well as see how to back out of merges that you’ve done.
+
+
Merge Conflicts
+
+
While we covered some basics on resolving merge conflicts in تداخلات ادغام پایه, for more complex conflicts, Git provides a few tools to help you figure out what’s going on and how to better deal with the conflict.
+
+
+
First of all, if at all possible, try to make sure your working directory is clean before doing a merge that may have conflicts.
+If you have work in progress, either commit it to a temporary branch or stash it.
+This makes it so that you can undo anything you try here.
+If you have unsaved changes in your working directory when you try a merge, some of these tips may help you preserve that work.
+
+
+
Let’s walk through a very simple example.
+We have a super simple Ruby file that prints hello world.
+
+
+
+
#! /usr/bin/env ruby
+
+def hello
+ puts 'hello world'
+end
+
+hello()
+
+
+
+
In our repository, we create a new branch named whitespace and proceed to change all the Unix line endings to DOS line endings, essentially changing every line of the file, but just with whitespace.
+Then we change the line “hello world” to “hello mundo”.
+
+
+
+
$ git checkout -b whitespace
+Switched to a new branch 'whitespace'
+
+$ unix2dos hello.rb
+unix2dos: converting file hello.rb to DOS format ...
+$ git commit -am 'Convert hello.rb to DOS'
+[whitespace 3270f76] Convert hello.rb to DOS
+ 1 file changed, 7 insertions(+), 7 deletions(-)
+
+$ vim hello.rb
+$ git diff -b
+diff --git a/hello.rb b/hello.rb
+index ac51efd..e85207e 100755
+--- a/hello.rb
++++ b/hello.rb
+@@ -1,7 +1,7 @@
+ #! /usr/bin/env ruby
+
+ def hello
+- puts 'hello world'
++ puts 'hello mundo'^M
+ end
+
+ hello()
+
+$ git commit -am 'Use Spanish instead of English'
+[whitespace 6d338d2] Use Spanish instead of English
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+
+
+
+
Now we switch back to our master branch and add some documentation for the function.
+
+
+
+
$ git checkout master
+Switched to branch 'master'
+
+$ vim hello.rb
+$ git diff
+diff --git a/hello.rb b/hello.rb
+index ac51efd..36c06c8 100755
+--- a/hello.rb
++++ b/hello.rb
+@@ -1,5 +1,6 @@
+ #! /usr/bin/env ruby
+
++# prints out a greeting
+ def hello
+ puts 'hello world'
+ end
+
+$ git commit -am 'Add comment documenting the function'
+[master bec6336] Add comment documenting the function
+ 1 file changed, 1 insertion(+)
+
+
+
+
Now we try to merge in our whitespace branch and we’ll get conflicts because of the whitespace changes.
+
+
+
+
$ git merge whitespace
+Auto-merging hello.rb
+CONFLICT (content): Merge conflict in hello.rb
+Automatic merge failed; fix conflicts and then commit the result.
+
+
+
+
Aborting a Merge
+
+
We now have a few options.
+First, let’s cover how to get out of this situation.
+If you perhaps weren’t expecting conflicts and don’t want to quite deal with the situation yet, you can simply back out of the merge with git merge --abort.
+
+
+
+
$ git status -sb
+## master
+UU hello.rb
+
+$ git merge --abort
+
+$ git status -sb
+## master
+
+
+
+
The git merge --abort option tries to revert back to your state before you ran the merge.
+The only cases where it may not be able to do this perfectly would be if you had unstashed, uncommitted changes in your working directory when you ran it, otherwise it should work fine.
+
+
+
If for some reason you just want to start over, you can also run git reset --hard HEAD, and your repository will be back to the last committed state.
+Remember that any uncommitted work will be lost, so make sure you don’t want any of your changes.
+
+
+
+
Ignoring Whitespace
+
+
In this specific case, the conflicts are whitespace related.
+We know this because the case is simple, but it’s also pretty easy to tell in real cases when looking at the conflict because every line is removed on one side and added again on the other.
+By default, Git sees all of these lines as being changed, so it can’t merge the files.
+
+
+
The default merge strategy can take arguments though, and a few of them are about properly ignoring whitespace changes.
+If you see that you have a lot of whitespace issues in a merge, you can simply abort it and do it again, this time with -Xignore-all-space or -Xignore-space-change.
+The first option ignores whitespace completely when comparing lines, the second treats sequences of one or more whitespace characters as equivalent.
+
+
+
+
$ git merge -Xignore-space-change whitespace
+Auto-merging hello.rb
+Merge made by the 'recursive' strategy.
+ hello.rb | 2 +-
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+
+
+
+
Since in this case, the actual file changes were not conflicting, once we ignore the whitespace changes, everything merges just fine.
+
+
+
This is a lifesaver if you have someone on your team who likes to occasionally reformat everything from spaces to tabs or vice-versa.
+
+
+
+
Manual File Re-merging
+
+
Though Git handles whitespace pre-processing pretty well, there are other types of changes that perhaps Git can’t handle automatically, but are scriptable fixes.
+As an example, let’s pretend that Git could not handle the whitespace change and we needed to do it by hand.
+
+
+
What we really need to do is run the file we’re trying to merge in through a dos2unix program before trying the actual file merge.
+So how would we do that?
+
+
+
First, we get into the merge conflict state.
+Then we want to get copies of my version of the file, their version (from the branch we’re merging in) and the common version (from where both sides branched off).
+Then we want to fix up either their side or our side and re-try the merge again for just this single file.
+
+
+
Getting the three file versions is actually pretty easy.
+Git stores all of these versions in the index under “stages” which each have numbers associated with them.
+Stage 1 is the common ancestor, stage 2 is your version and stage 3 is from the MERGE_HEAD, the version you’re merging in (“theirs”).
+
+
+
You can extract a copy of each of these versions of the conflicted file with the git show command and a special syntax.
+
+
+
+
$ git show :1:hello.rb > hello.common.rb
+$ git show :2:hello.rb > hello.ours.rb
+$ git show :3:hello.rb > hello.theirs.rb
+
+
+
+
If you want to get a little more hard core, you can also use the ls-files -u plumbing command to get the actual SHA-1s of the Git blobs for each of these files.
+
+
+
+
$ git ls-files -u
+100755 ac51efdc3df4f4fd328d1a02ad05331d8e2c9111 1 hello.rb
+100755 36c06c8752c78d2aff89571132f3bf7841a7b5c3 2 hello.rb
+100755 e85207e04dfdd5eb0a1e9febbc67fd837c44a1cd 3 hello.rb
+
+
+
+
The :1:hello.rb is just a shorthand for looking up that blob SHA-1.
+
+
+
Now that we have the content of all three stages in our working directory, we can manually fix up theirs to fix the whitespace issue and re-merge the file with the little-known git merge-file command which does just that.
+
+
+
+
$ dos2unix hello.theirs.rb
+dos2unix: converting file hello.theirs.rb to Unix format ...
+
+$ git merge-file -p \
+ hello.ours.rb hello.common.rb hello.theirs.rb > hello.rb
+
+$ git diff -b
+diff --cc hello.rb
+index 36c06c8,e85207e..0000000
+--- a/hello.rb
++++ b/hello.rb
+@@@ -1,8 -1,7 +1,8 @@@
+ #! /usr/bin/env ruby
+
+ +# prints out a greeting
+ def hello
+- puts 'hello world'
++ puts 'hello mundo'
+ end
+
+ hello()
+
+
+
+
At this point we have nicely merged the file.
+In fact, this actually works better than the ignore-space-change option because this actually fixes the whitespace changes before merge instead of simply ignoring them.
+In the ignore-space-change merge, we actually ended up with a few lines with DOS line endings, making things mixed.
+
+
+
If you want to get an idea before finalizing this commit about what was actually changed between one side or the other, you can ask git diff to compare what is in your working directory that you’re about to commit as the result of the merge to any of these stages.
+Let’s go through them all.
+
+
+
To compare your result to what you had in your branch before the merge, in other words, to see what the merge introduced, you can run git diff --ours
+
+
+
+
$ git diff --ours
+* Unmerged path hello.rb
+diff --git a/hello.rb b/hello.rb
+index 36c06c8..44d0a25 100755
+--- a/hello.rb
++++ b/hello.rb
+@@ -2,7 +2,7 @@
+
+ # prints out a greeting
+ def hello
+- puts 'hello world'
++ puts 'hello mundo'
+ end
+
+ hello()
+
+
+
+
So here we can easily see that what happened in our branch, what we’re actually introducing to this file with this merge, is changing that single line.
+
+
+
If we want to see how the result of the merge differed from what was on their side, you can run git diff --theirs.
+In this and the following example, we have to use -b to strip out the whitespace because we’re comparing it to what is in Git, not our cleaned up hello.theirs.rb file.
+
+
+
+
$ git diff --theirs -b
+* Unmerged path hello.rb
+diff --git a/hello.rb b/hello.rb
+index e85207e..44d0a25 100755
+--- a/hello.rb
++++ b/hello.rb
+@@ -1,5 +1,6 @@
+ #! /usr/bin/env ruby
+
++# prints out a greeting
+ def hello
+ puts 'hello mundo'
+ end
+
+
+
+
Finally, you can see how the file has changed from both sides with git diff --base.
+
+
+
+
$ git diff --base -b
+* Unmerged path hello.rb
+diff --git a/hello.rb b/hello.rb
+index ac51efd..44d0a25 100755
+--- a/hello.rb
++++ b/hello.rb
+@@ -1,7 +1,8 @@
+ #! /usr/bin/env ruby
+
++# prints out a greeting
+ def hello
+- puts 'hello world'
++ puts 'hello mundo'
+ end
+
+ hello()
+
+
+
+
At this point we can use the git clean command to clear out the extra files we created to do the manual merge but no longer need.
+
+
+
+
$ git clean -f
+Removing hello.common.rb
+Removing hello.ours.rb
+Removing hello.theirs.rb
+
+
+
+
+
Checking Out Conflicts
+
+
Perhaps we’re not happy with the resolution at this point for some reason, or maybe manually editing one or both sides still didn’t work well and we need more context.
+
+
+
Let’s change up the example a little.
+For this example, we have two longer lived branches that each have a few commits in them but create a legitimate content conflict when merged.
+
+
+
+
$ git log --graph --oneline --decorate --all
+* f1270f7 (HEAD, master) Update README
+* 9af9d3b Create README
+* 694971d Update phrase to 'hola world'
+| * e3eb223 (mundo) Add more tests
+| * 7cff591 Create initial testing script
+| * c3ffff1 Change text to 'hello mundo'
+|/
+* b7dcc89 Initial hello world code
+
+
+
+
We now have three unique commits that live only on the master branch and three others that live on the mundo branch.
+If we try to merge the mundo branch in, we get a conflict.
+
+
+
+
$ git merge mundo
+Auto-merging hello.rb
+CONFLICT (content): Merge conflict in hello.rb
+Automatic merge failed; fix conflicts and then commit the result.
+
+
+
+
We would like to see what the merge conflict is.
+If we open up the file, we’ll see something like this:
+
+
+
+
#! /usr/bin/env ruby
+
+def hello
+<<<<<<< HEAD
+ puts 'hola world'
+=======
+ puts 'hello mundo'
+>>>>>>> mundo
+end
+
+hello()
+
+
+
+
Both sides of the merge added content to this file, but some of the commits modified the file in the same place that caused this conflict.
+
+
+
Let’s explore a couple of tools that you now have at your disposal to determine how this conflict came to be.
+Perhaps it’s not obvious how exactly you should fix this conflict.
+You need more context.
+
+
+
One helpful tool is git checkout with the --conflict option.
+This will re-checkout the file again and replace the merge conflict markers.
+This can be useful if you want to reset the markers and try to resolve them again.
+
+
+
You can pass --conflict either diff3 or merge (which is the default).
+If you pass it diff3, Git will use a slightly different version of conflict markers, not only giving you the “ours” and “theirs” versions, but also the “base” version inline to give you more context.
+
+
+
+
$ git checkout --conflict=diff3 hello.rb
+
+
+
+
Once we run that, the file will look like this instead:
+
+
+
+
#! /usr/bin/env ruby
+
+def hello
+<<<<<<< ours
+ puts 'hola world'
+||||||| base
+ puts 'hello world'
+=======
+ puts 'hello mundo'
+>>>>>>> theirs
+end
+
+hello()
+
+
+
+
If you like this format, you can set it as the default for future merge conflicts by setting the merge.conflictstyle setting to diff3.
+
+
+
+
$ git config --global merge.conflictstyle diff3
+
+
+
+
The git checkout command can also take --ours and --theirs options, which can be a really fast way of just choosing either one side or the other without merging things at all.
+
+
+
This can be particularly useful for conflicts of binary files where you can simply choose one side, or where you only want to merge certain files in from another branch — you can do the merge and then checkout certain files from one side or the other before committing.
+
+
+
+
Merge Log
+
+
Another useful tool when resolving merge conflicts is git log.
+This can help you get context on what may have contributed to the conflicts.
+Reviewing a little bit of history to remember why two lines of development were touching the same area of code can be really helpful sometimes.
+
+
+
To get a full list of all of the unique commits that were included in either branch involved in this merge, we can use the “triple dot” syntax that we learned in Triple Dot.
+
+
+
+
$ git log --oneline --left-right HEAD...MERGE_HEAD
+< f1270f7 Update README
+< 9af9d3b Create README
+< 694971d Update phrase to 'hola world'
+> e3eb223 Add more tests
+> 7cff591 Create initial testing script
+> c3ffff1 Change text to 'hello mundo'
+
+
+
+
That’s a nice list of the six total commits involved, as well as which line of development each commit was on.
+
+
+
We can further simplify this though to give us much more specific context.
+If we add the --merge option to git log, it will only show the commits in either side of the merge that touch a file that’s currently conflicted.
+
+
+
+
$ git log --oneline --left-right --merge
+< 694971d Update phrase to 'hola world'
+> c3ffff1 Change text to 'hello mundo'
+
+
+
+
If you run that with the -p option instead, you get just the diffs to the file that ended up in conflict.
+This can be really helpful in quickly giving you the context you need to help understand why something conflicts and how to more intelligently resolve it.
+
+
+
+
+
+
Since Git stages any merge results that are successful, when you run git diff while in a conflicted merge state, you only get what is currently still in conflict.
+This can be helpful to see what you still have to resolve.
+
+
+
When you run git diff directly after a merge conflict, it will give you information in a rather unique diff output format.
+
+
+
+
$ git diff
+diff --cc hello.rb
+index 0399cd5,59727f0..0000000
+--- a/hello.rb
++++ b/hello.rb
+@@@ -1,7 -1,7 +1,11 @@@
+ #! /usr/bin/env ruby
+
+ def hello
+++<<<<<<< HEAD
+ + puts 'hola world'
+++=======
++ puts 'hello mundo'
+++>>>>>>> mundo
+ end
+
+ hello()
+
+
+
+
The format is called “Combined Diff” and gives you two columns of data next to each line.
+The first column shows you if that line is different (added or removed) between the “ours” branch and the file in your working directory and the second column does the same between the “theirs” branch and your working directory copy.
+
+
+
So in that example you can see that the <<<<<<< and >>>>>>> lines are in the working copy but were not in either side of the merge.
+This makes sense because the merge tool stuck them in there for our context, but we’re expected to remove them.
+
+
+
If we resolve the conflict and run git diff again, we’ll see the same thing, but it’s a little more useful.
+
+
+
+
$ vim hello.rb
+$ git diff
+diff --cc hello.rb
+index 0399cd5,59727f0..0000000
+--- a/hello.rb
++++ b/hello.rb
+@@@ -1,7 -1,7 +1,7 @@@
+ #! /usr/bin/env ruby
+
+ def hello
+- puts 'hola world'
+ - puts 'hello mundo'
+++ puts 'hola mundo'
+ end
+
+ hello()
+
+
+
+
This shows us that “hola world” was in our side but not in the working copy, that “hello mundo” was in their side but not in the working copy and finally that “hola mundo” was not in either side but is now in the working copy.
+This can be useful to review before committing the resolution.
+
+
+
You can also get this from the git log for any merge to see how something was resolved after the fact.
+Git will output this format if you run git show on a merge commit, or if you add a --cc option to a git log -p (which by default only shows patches for non-merge commits).
+
+
+
+
$ git log --cc -p -1
+commit 14f41939956d80b9e17bb8721354c33f8d5b5a79
+Merge: f1270f7 e3eb223
+Author: Scott Chacon <schacon@gmail.com>
+Date: Fri Sep 19 18:14:49 2014 +0200
+
+ Merge branch 'mundo'
+
+ Conflicts:
+ hello.rb
+
+diff --cc hello.rb
+index 0399cd5,59727f0..e1d0799
+--- a/hello.rb
++++ b/hello.rb
+@@@ -1,7 -1,7 +1,7 @@@
+ #! /usr/bin/env ruby
+
+ def hello
+- puts 'hola world'
+ - puts 'hello mundo'
+++ puts 'hola mundo'
+ end
+
+ hello()
+
+
+
+
+
Undoing Merges
+
+
Now that you know how to create a merge commit, you’ll probably make some by mistake.
+One of the great things about working with Git is that it’s okay to make mistakes, because it’s possible (and in many cases easy) to fix them.
+
+
+
Merge commits are no different.
+Let’s say you started work on a topic branch, accidentally merged it into master, and now your commit history looks like this:
+
+
+
+
}}" alt="Accidental merge commit.">
+
+
نمودار 138. Accidental merge commit
+
+
+
There are two ways to approach this problem, depending on what your desired outcome is.
+
+
+
Fix the references
+
+
If the unwanted merge commit only exists on your local repository, the easiest and best solution is to move the branches so that they point where you want them to.
+In most cases, if you follow the errant git merge with git reset --hard HEAD~, this will reset the branch pointers so they look like this:
+
+
+
+
}}" alt="History after `git reset --hard HEAD~`.">
+
+
نمودار 139. History after git reset --hard HEAD~
+
+
+
+
We covered reset back in Reset Demystified, so it shouldn’t be too hard to figure out what’s going on here.
+Here’s a quick refresher: reset --hard usually goes through three steps:
+
+
+
+-
+
Move the branch HEAD points to.
+In this case, we want to move master to where it was before the merge commit (C6).
+
+-
+
Make the index look like HEAD.
+
+-
+
Make the working directory look like the index.
+
+
+
+
+
The downside of this approach is that it’s rewriting history, which can be problematic with a shared repository.
+Check out خطرات ریبیسکردن for more on what can happen; the short version is that if other people have the commits you’re rewriting, you should probably avoid reset.
+This approach also won’t work if any other commits have been created since the merge; moving the refs would effectively lose those changes.
+
+
+
+
Reverse the commit
+
+
If moving the branch pointers around isn’t going to work for you, Git gives you the option of making a new commit which undoes all the changes from an existing one.
+Git calls this operation a “revert”, and in this particular scenario, you’d invoke it like this:
+
+
+
+
$ git revert -m 1 HEAD
+[master b1d8379] Revert "Merge branch 'topic'"
+
+
+
+
The -m 1 flag indicates which parent is the “mainline” and should be kept.
+When you invoke a merge into HEAD (git merge topic), the new commit has two parents: the first one is HEAD (C6), and the second is the tip of the branch being merged in (C4).
+In this case, we want to undo all the changes introduced by merging in parent #2 (C4), while keeping all the content from parent #1 (C6).
+
+
+
The history with the revert commit looks like this:
+
+
+
+
}}" alt="History after `git revert -m 1`.">
+
+
نمودار 140. History after git revert -m 1
+
+
+
+
The new commit ^M has exactly the same contents as C6, so starting from here it’s as if the merge never happened, except that the now-unmerged commits are still in HEAD's history.
+Git will get confused if you try to merge topic into master again:
+
+
+
+
$ git merge topic
+Already up-to-date.
+
+
+
+
There’s nothing in topic that isn’t already reachable from master.
+What’s worse, if you add work to topic and merge again, Git will only bring in the changes since the reverted merge:
+
+
+
+
}}" alt="History with a bad merge.">
+
+
نمودار 141. History with a bad merge
+
+
+
The best way around this is to un-revert the original merge, since now you want to bring in the changes that were reverted out, then create a new merge commit:
+
+
+
+
$ git revert ^M
+[master 09f0126] Revert "Revert "Merge branch 'topic'""
+$ git merge topic
+
+
+
+
+
}}" alt="History after re-merging a reverted merge.">
+
+
نمودار 142. History after re-merging a reverted merge
+
+
+
In this example, M and ^M cancel out.
+^^M effectively merges in the changes from C3 and C4, and C8 merges in the changes from C7, so now topic is fully merged.
+
+
+
+
Other Types of Merges
+
+
So far we’ve covered the normal merge of two branches, normally handled with what is called the “recursive” strategy of merging.
+There are other ways to merge branches together however.
+Let’s cover a few of them quickly.
+
+
+
Our or Theirs Preference
+
+
First of all, there is another useful thing we can do with the normal “recursive” mode of merging.
+We’ve already seen the ignore-all-space and ignore-space-change options which are passed with a -X but we can also tell Git to favor one side or the other when it sees a conflict.
+
+
+
By default, when Git sees a conflict between two branches being merged, it will add merge conflict markers into your code and mark the file as conflicted and let you resolve it.
+If you would prefer for Git to simply choose a specific side and ignore the other side instead of letting you manually resolve the conflict, you can pass the merge command either a -Xours or -Xtheirs.
+
+
+
If Git sees this, it will not add conflict markers.
+Any differences that are mergeable, it will merge.
+Any differences that conflict, it will simply choose the side you specify in whole, including binary files.
+
+
+
If we go back to the “hello world” example we were using before, we can see that merging in our branch causes conflicts.
+
+
+
+
$ git merge mundo
+Auto-merging hello.rb
+CONFLICT (content): Merge conflict in hello.rb
+Resolved 'hello.rb' using previous resolution.
+Automatic merge failed; fix conflicts and then commit the result.
+
+
+
+
However if we run it with -Xours or -Xtheirs it does not.
+
+
+
+
$ git merge -Xours mundo
+Auto-merging hello.rb
+Merge made by the 'recursive' strategy.
+ hello.rb | 2 +-
+ test.sh | 2 ++
+ 2 files changed, 3 insertions(+), 1 deletion(-)
+ create mode 100644 test.sh
+
+
+
+
In that case, instead of getting conflict markers in the file with “hello mundo” on one side and “hola world” on the other, it will simply pick “hola world”.
+However, all the other non-conflicting changes on that branch are merged successfully in.
+
+
+
This option can also be passed to the git merge-file command we saw earlier by running something like git merge-file --ours for individual file merges.
+
+
+
If you want to do something like this but not have Git even try to merge changes from the other side in, there is a more draconian option, which is the “ours” merge strategy.
+This is different from the “ours” recursive merge option.
+
+
+
This will basically do a fake merge.
+It will record a new merge commit with both branches as parents, but it will not even look at the branch you’re merging in.
+It will simply record as the result of the merge the exact code in your current branch.
+
+
+
+
$ git merge -s ours mundo
+Merge made by the 'ours' strategy.
+$ git diff HEAD HEAD~
+$
+
+
+
+
You can see that there is no difference between the branch we were on and the result of the merge.
+
+
+
This can often be useful to basically trick Git into thinking that a branch is already merged when doing a merge later on.
+For example, say you branched off a release branch and have done some work on it that you will want to merge back into your master branch at some point.
+In the meantime some bugfix on master needs to be backported into your release branch.
+You can merge the bugfix branch into the release branch and also merge -s ours the same branch into your master branch (even though the fix is already there) so when you later merge the release branch again, there are no conflicts from the bugfix.
+
+
+
+
Subtree Merging
+
+
The idea of the subtree merge is that you have two projects, and one of the projects maps to a subdirectory of the other one.
+When you specify a subtree merge, Git is often smart enough to figure out that one is a subtree of the other and merge appropriately.
+
+
+
We’ll go through an example of adding a separate project into an existing project and then merging the code of the second into a subdirectory of the first.
+
+
+
First, we’ll add the Rack application to our project.
+We’ll add the Rack project as a remote reference in our own project and then check it out into its own branch:
+
+
+
+
$ git remote add rack_remote https://github.com/rack/rack
+$ git fetch rack_remote --no-tags
+warning: no common commits
+remote: Counting objects: 3184, done.
+remote: Compressing objects: 100% (1465/1465), done.
+remote: Total 3184 (delta 1952), reused 2770 (delta 1675)
+Receiving objects: 100% (3184/3184), 677.42 KiB | 4 KiB/s, done.
+Resolving deltas: 100% (1952/1952), done.
+From https://github.com/rack/rack
+ * [new branch] build -> rack_remote/build
+ * [new branch] master -> rack_remote/master
+ * [new branch] rack-0.4 -> rack_remote/rack-0.4
+ * [new branch] rack-0.9 -> rack_remote/rack-0.9
+$ git checkout -b rack_branch rack_remote/master
+Branch rack_branch set up to track remote branch refs/remotes/rack_remote/master.
+Switched to a new branch "rack_branch"
+
+
+
+
Now we have the root of the Rack project in our rack_branch branch and our own project in the master branch.
+If you check out one and then the other, you can see that they have different project roots:
+
+
+
+
$ ls
+AUTHORS KNOWN-ISSUES Rakefile contrib lib
+COPYING README bin example test
+$ git checkout master
+Switched to branch "master"
+$ ls
+README
+
+
+
+
This is sort of a strange concept.
+Not all the branches in your repository actually have to be branches of the same project.
+It’s not common, because it’s rarely helpful, but it’s fairly easy to have branches contain completely different histories.
+
+
+
In this case, we want to pull the Rack project into our master project as a subdirectory.
+We can do that in Git with git read-tree.
+You’ll learn more about read-tree and its friends in Git Internals, but for now know that it reads the root tree of one branch into your current staging area and working directory.
+We just switched back to your master branch, and we pull the rack_branch branch into the rack subdirectory of our master branch of our main project:
+
+
+
+
$ git read-tree --prefix=rack/ -u rack_branch
+
+
+
+
When we commit, it looks like we have all the Rack files under that subdirectory – as though we copied them in from a tarball.
+What gets interesting is that we can fairly easily merge changes from one of the branches to the other.
+So, if the Rack project updates, we can pull in upstream changes by switching to that branch and pulling:
+
+
+
+
$ git checkout rack_branch
+$ git pull
+
+
+
+
Then, we can merge those changes back into our master branch.
+To pull in the changes and prepopulate the commit message, use the --squash option, as well as the recursive merge strategy’s -Xsubtree option.
+(The recursive strategy is the default here, but we include it for clarity.)
+
+
+
+
$ git checkout master
+$ git merge --squash -s recursive -Xsubtree=rack rack_branch
+Squash commit -- not updating HEAD
+Automatic merge went well; stopped before committing as requested
+
+
+
+
All the changes from the Rack project are merged in and ready to be committed locally.
+You can also do the opposite – make changes in the rack subdirectory of your master branch and then merge them into your rack_branch branch later to submit them to the maintainers or push them upstream.
+
+
+
This gives us a way to have a workflow somewhat similar to the submodule workflow without using submodules (which we will cover in Submodules).
+We can keep branches with other related projects in our repository and subtree merge them into our project occasionally.
+It is nice in some ways, for example all the code is committed to a single place.
+However, it has other drawbacks in that it’s a bit more complex and easier to make mistakes in reintegrating changes or accidentally pushing a branch into an unrelated repository.
+
+
+
Another slightly weird thing is that to get a diff between what you have in your rack subdirectory and the code in your rack_branch branch – to see if you need to merge them – you can’t use the normal diff command.
+Instead, you must run git diff-tree with the branch you want to compare to:
+
+
+
+
$ git diff-tree -p rack_branch
+
+
+
+
Or, to compare what is in your rack subdirectory with what the master branch on the server was the last time you fetched, you can run
+
+
+
+
$ git diff-tree -p rack_remote/master
+
+
+
+
Bundling
+
+
Though we’ve covered the common ways to transfer Git data over a network (HTTP, SSH, etc), there is actually one more way to do so that is not commonly used but can actually be quite useful.
+
+
Git is capable of “bundling” its data into a single file.
+This can be useful in various scenarios.
+Maybe your network is down and you want to send changes to your co-workers.
+Perhaps you’re working somewhere offsite and don’t have access to the local network for security reasons.
+Maybe your wireless/ethernet card just broke.
+Maybe you don’t have access to a shared server for the moment, you want to email someone updates and you don’t want to transfer 40 commits via format-patch.
+
+
This is where the git bundle command can be helpful.
+The bundle command will package up everything that would normally be pushed over the wire with a git push command into a binary file that you can email to someone or put on a flash drive, then unbundle into another repository.
+
+
Let’s see a simple example.
+Let’s say you have a repository with two commits:
+
+
+
$ git log
+commit 9a466c572fe88b195efd356c3f2bbeccdb504102
+Author: Scott Chacon <schacon@gmail.com>
+Date: Wed Mar 10 07:34:10 2010 -0800
+
+ Second commit
+
+commit b1ec3248f39900d2a406049d762aa68e9641be25
+Author: Scott Chacon <schacon@gmail.com>
+Date: Wed Mar 10 07:34:01 2010 -0800
+
+ First commit
+
+
+
If you want to send that repository to someone and you don’t have access to a repository to push to, or simply don’t want to set one up, you can bundle it with git bundle create.
+
+
+
$ git bundle create repo.bundle HEAD master
+Counting objects: 6, done.
+Delta compression using up to 2 threads.
+Compressing objects: 100% (2/2), done.
+Writing objects: 100% (6/6), 441 bytes, done.
+Total 6 (delta 0), reused 0 (delta 0)
+
+
+
Now you have a file named repo.bundle that has all the data needed to re-create the repository’s master branch.
+With the bundle command you need to list out every reference or specific range of commits that you want to be included.
+If you intend for this to be cloned somewhere else, you should add HEAD as a reference as well as we’ve done here.
+
+
You can email this repo.bundle file to someone else, or put it on a USB drive and walk it over.
+
+
On the other side, say you are sent this repo.bundle file and want to work on the project.
+You can clone from the binary file into a directory, much like you would from a URL.
+
+
+
$ git clone repo.bundle repo
+Cloning into 'repo'...
+...
+$ cd repo
+$ git log --oneline
+9a466c5 Second commit
+b1ec324 First commit
+
+
+
If you don’t include HEAD in the references, you have to also specify -b master or whatever branch is included because otherwise it won’t know what branch to check out.
+
+
Now let’s say you do three commits on it and want to send the new commits back via a bundle on a USB stick or email.
+
+
+
$ git log --oneline
+71b84da Last commit - second repo
+c99cf5b Fourth commit - second repo
+7011d3d Third commit - second repo
+9a466c5 Second commit
+b1ec324 First commit
+
+
+
First we need to determine the range of commits we want to include in the bundle.
+Unlike the network protocols which figure out the minimum set of data to transfer over the network for us, we’ll have to figure this out manually.
+ Now, you could just do the same thing and bundle the entire repository, which will work, but it’s better to just bundle up the difference - just the three commits we just made locally.
+
+
In order to do that, you’ll have to calculate the difference.
+As we described in Commit Ranges, you can specify a range of commits in a number of ways.
+To get the three commits that we have in our master branch that weren’t in the branch we originally cloned, we can use something like origin/master..master or master ^origin/master.
+You can test that with the log command.
+
+
+
$ git log --oneline master ^origin/master
+71b84da Last commit - second repo
+c99cf5b Fourth commit - second repo
+7011d3d Third commit - second repo
+
+
+
So now that we have the list of commits we want to include in the bundle, let’s bundle them up.
+We do that with the git bundle create command, giving it a filename we want our bundle to be and the range of commits we want to go into it.
+
+
+
$ git bundle create commits.bundle master ^9a466c5
+Counting objects: 11, done.
+Delta compression using up to 2 threads.
+Compressing objects: 100% (3/3), done.
+Writing objects: 100% (9/9), 775 bytes, done.
+Total 9 (delta 0), reused 0 (delta 0)
+
+
+
Now we have a commits.bundle file in our directory.
+If we take that and send it to our partner, she can then import it into the original repository, even if more work has been done there in the meantime.
+
+
When she gets the bundle, she can inspect it to see what it contains before she imports it into her repository.
+The first command is the bundle verify command that will make sure the file is actually a valid Git bundle and that you have all the necessary ancestors to reconstitute it properly.
+
+
+
$ git bundle verify ../commits.bundle
+The bundle contains 1 ref
+71b84daaf49abed142a373b6e5c59a22dc6560dc refs/heads/master
+The bundle requires these 1 ref
+9a466c572fe88b195efd356c3f2bbeccdb504102 second commit
+../commits.bundle is okay
+
+
+
If the bundler had created a bundle of just the last two commits they had done, rather than all three, the original repository would not be able to import it, since it is missing requisite history.
+The verify command would have looked like this instead:
+
+
+
$ git bundle verify ../commits-bad.bundle
+error: Repository lacks these prerequisite commits:
+error: 7011d3d8fc200abe0ad561c011c3852a4b7bbe95 Third commit - second repo
+
+
+
However, our first bundle is valid, so we can fetch in commits from it.
+If you want to see what branches are in the bundle that can be imported, there is also a command to just list the heads:
+
+
+
$ git bundle list-heads ../commits.bundle
+71b84daaf49abed142a373b6e5c59a22dc6560dc refs/heads/master
+
+
+
The verify sub-command will tell you the heads as well.
+The point is to see what can be pulled in, so you can use the fetch or pull commands to import commits from this bundle.
+Here we’ll fetch the master branch of the bundle to a branch named other-master in our repository:
+
+
+
$ git fetch ../commits.bundle master:other-master
+From ../commits.bundle
+ * [new branch] master -> other-master
+
+
+
Now we can see that we have the imported commits on the other-master branch as well as any commits we’ve done in the meantime in our own master branch.
+
+
+
$ git log --oneline --decorate --graph --all
+* 8255d41 (HEAD, master) Third commit - first repo
+| * 71b84da (other-master) Last commit - second repo
+| * c99cf5b Fourth commit - second repo
+| * 7011d3d Third commit - second repo
+|/
+* 9a466c5 Second commit
+* b1ec324 First commit
+
+
+
So, git bundle can be really useful for sharing or doing network-type operations when you don’t have the proper network or shared repository to do so.
+
Credential Storage
+
+
+
+If you use the SSH transport for connecting to remotes, it’s possible for you to have a key without a passphrase, which allows you to securely transfer data without typing in your username and password.
+However, this isn’t possible with the HTTP protocols – every connection needs a username and password.
+This gets even harder for systems with two-factor authentication, where the token you use for a password is randomly generated and unpronounceable.
+
+
Fortunately, Git has a credentials system that can help with this.
+Git has a few options provided in the box:
+
+
+-
+
The default is not to cache at all.
+Every connection will prompt you for your username and password.
+
+-
+
The “cache” mode keeps credentials in memory for a certain period of time.
+None of the passwords are ever stored on disk, and they are purged from the cache after 15 minutes.
+
+-
+
The “store” mode saves the credentials to a plain-text file on disk, and they never expire.
+This means that until you change your password for the Git host, you won’t ever have to type in your credentials again.
+The downside of this approach is that your passwords are stored in cleartext in a plain file in your home directory.
+
+-
+
If you’re using a Mac, Git comes with an “osxkeychain” mode, which caches credentials in the secure keychain that’s attached to your system account.
+This method stores the credentials on disk, and they never expire, but they’re encrypted with the same system that stores HTTPS certificates and Safari auto-fills.
+
+-
+
If you’re using Windows, you can install a helper called “Git Credential Manager for Windows.”
+This is similar to the “osxkeychain” helper described above, but uses the Windows Credential Store to control sensitive information.
+It can be found at https://github.com/Microsoft/Git-Credential-Manager-for-Windows.
+
+
+
+
You can choose one of these methods by setting a Git configuration value:
+
+
+
$ git config --global credential.helper cache
+
+
+
Some of these helpers have options.
+The “store” helper can take a --file <path> argument, which customizes where the plain-text file is saved (the default is ~/.git-credentials).
+The “cache” helper accepts the --timeout <seconds> option, which changes the amount of time its daemon is kept running (the default is “900”, or 15 minutes).
+Here’s an example of how you’d configure the “store” helper with a custom file name:
+
+
+
$ git config --global credential.helper 'store --file ~/.my-credentials'
+
+
+
Git even allows you to configure several helpers.
+When looking for credentials for a particular host, Git will query them in order, and stop after the first answer is provided.
+When saving credentials, Git will send the username and password to all of the helpers in the list, and they can choose what to do with them.
+Here’s what a .gitconfig would look like if you had a credentials file on a thumb drive, but wanted to use the in-memory cache to save some typing if the drive isn’t plugged in:
+
+
+
[credential]
+ helper = store --file /mnt/thumbdrive/.git-credentials
+ helper = cache --timeout 30000
+
+
+
Under the Hood
+
+
How does this all work?
+Git’s root command for the credential-helper system is git credential, which takes a command as an argument, and then more input through stdin.
+
+
+
This might be easier to understand with an example.
+Let’s say that a credential helper has been configured, and the helper has stored credentials for mygithost.
+Here’s a session that uses the “fill” command, which is invoked when Git is trying to find credentials for a host:
+
+
+
+
$ git credential fill (1)
+protocol=https (2)
+host=mygithost
+(3)
+protocol=https (4)
+host=mygithost
+username=bob
+password=s3cre7
+$ git credential fill (5)
+protocol=https
+host=unknownhost
+
+Username for 'https://unknownhost': bob
+Password for 'https://bob@unknownhost':
+protocol=https
+host=unknownhost
+username=bob
+password=s3cre7
+
+
+
+
+-
+
This is the command line that initiates the interaction.
+
+-
+
Git-credential is then waiting for input on stdin.
+We provide it with the things we know: the protocol and hostname.
+
+-
+
A blank line indicates that the input is complete, and the credential system should answer with what it knows.
+
+-
+
Git-credential then takes over, and writes to stdout with the bits of information it found.
+
+-
+
If credentials are not found, Git asks the user for the username and password, and provides them back to the invoking stdout (here they’re attached to the same console).
+
+
+
+
+
The credential system is actually invoking a program that’s separate from Git itself; which one and how depends on the credential.helper configuration value.
+There are several forms it can take:
+
+
+
+
+
+
+
+
+| Configuration Value |
+Behavior |
+
+
+
+
+foo
|
+Runs git-credential-foo |
+
+
+foo -a --opt=bcd
|
+Runs git-credential-foo -a --opt=bcd |
+
+
+/absolute/path/foo -xyz
|
+Runs /absolute/path/foo -xyz |
+
+
+!f() { echo "password=s3cre7"; }; f
|
+Code after ! evaluated in shell |
+
+
+
+
+
So the helpers described above are actually named git-credential-cache, git-credential-store, and so on, and we can configure them to take command-line arguments.
+The general form for this is “git-credential-foo [args] <action>.”
+The stdin/stdout protocol is the same as git-credential, but they use a slightly different set of actions:
+
+
+
+-
+
get is a request for a username/password pair.
+
+-
+
store is a request to save a set of credentials in this helper’s memory.
+
+-
+
erase purge the credentials for the given properties from this helper’s memory.
+
+
+
+
+
For the store and erase actions, no response is required (Git ignores it anyway).
+For the get action, however, Git is very interested in what the helper has to say.
+If the helper doesn’t know anything useful, it can simply exit with no output, but if it does know, it should augment the provided information with the information it has stored.
+The output is treated like a series of assignment statements; anything provided will replace what Git already knows.
+
+
+
Here’s the same example from above, but skipping git-credential and going straight for git-credential-store:
+
+
+
+
$ git credential-store --file ~/git.store store (1)
+protocol=https
+host=mygithost
+username=bob
+password=s3cre7
+$ git credential-store --file ~/git.store get (2)
+protocol=https
+host=mygithost
+
+username=bob (3)
+password=s3cre7
+
+
+
+
+-
+
Here we tell git-credential-store to save some credentials: the username “bob” and the password “s3cre7” are to be used when https://mygithost is accessed.
+
+-
+
Now we’ll retrieve those credentials.
+We provide the parts of the connection we already know (https://mygithost), and an empty line.
+
+-
+
git-credential-store replies with the username and password we stored above.
+
+
+
+
+
Here’s what the ~/git.store file looks like:
+
+
+
+
https://bob:s3cre7@mygithost
+
+
+
+
It’s just a series of lines, each of which contains a credential-decorated URL.
+The osxkeychain and wincred helpers use the native format of their backing stores, while cache uses its own in-memory format (which no other process can read).
+
+
+
A Custom Credential Cache
+
+
Given that git-credential-store and friends are separate programs from Git, it’s not much of a leap to realize that any program can be a Git credential helper.
+The helpers provided by Git cover many common use cases, but not all.
+For example, let’s say your team has some credentials that are shared with the entire team, perhaps for deployment.
+These are stored in a shared directory, but you don’t want to copy them to your own credential store, because they change often.
+None of the existing helpers cover this case; let’s see what it would take to write our own.
+There are several key features this program needs to have:
+
+
+
+-
+
The only action we need to pay attention to is get; store and erase are write operations, so we’ll just exit cleanly when they’re received.
+
+-
+
The file format of the shared-credential file is the same as that used by git-credential-store.
+
+-
+
The location of that file is fairly standard, but we should allow the user to pass a custom path just in case.
+
+
+
+
+
Once again, we’ll write this extension in Ruby, but any language will work so long as Git can execute the finished product.
+Here’s the full source code of our new credential helper:
+
+
+
+
#!/usr/bin/env ruby
+
+require 'optparse'
+
+path = File.expand_path '~/.git-credentials' # (1)
+OptionParser.new do |opts|
+ opts.banner = 'USAGE: git-credential-read-only [options] <action>'
+ opts.on('-f', '--file PATH', 'Specify path for backing store') do |argpath|
+ path = File.expand_path argpath
+ end
+end.parse!
+
+exit(0) unless ARGV[0].downcase == 'get' # (2)
+exit(0) unless File.exists? path
+
+known = {} # (3)
+while line = STDIN.gets
+ break if line.strip == ''
+ k,v = line.strip.split '=', 2
+ known[k] = v
+end
+
+File.readlines(path).each do |fileline| # (4)
+ prot,user,pass,host = fileline.scan(/^(.*?):\/\/(.*?):(.*?)@(.*)$/).first
+ if prot == known['protocol'] and host == known['host'] and user == known['username'] then
+ puts "protocol=#{prot}"
+ puts "host=#{host}"
+ puts "username=#{user}"
+ puts "password=#{pass}"
+ exit(0)
+ end
+end
+
+
+
+
+-
+
Here we parse the command-line options, allowing the user to specify the input file.
+The default is ~/.git-credentials.
+
+-
+
This program only responds if the action is get and the backing-store file exists.
+
+-
+
This loop reads from stdin until the first blank line is reached.
+The inputs are stored in the known hash for later reference.
+
+-
+
This loop reads the contents of the storage file, looking for matches.
+If the protocol and host from known match this line, the program prints the results to stdout and exits.
+
+
+
+
+
We’ll save our helper as git-credential-read-only, put it somewhere in our PATH and mark it executable.
+Here’s what an interactive session looks like:
+
+
+
+
$ git credential-read-only --file=/mnt/shared/creds get
+protocol=https
+host=mygithost
+
+protocol=https
+host=mygithost
+username=bob
+password=s3cre7
+
+
+
+
Since its name starts with “git-”, we can use the simple syntax for the configuration value:
+
+
+
+
$ git config --global credential.helper 'read-only --file /mnt/shared/creds'
+
+
+
+
As you can see, extending this system is pretty straightforward, and can solve some common problems for you and your team.
+
+
Debugging with Git
+
+
In addition to being primarily for version control, Git also provides a couple commands to help you debug your source code projects.
+Because Git is designed to handle nearly any type of content, these tools are pretty generic, but they can often help you hunt for a bug or culprit when things go wrong.
+
+
File Annotation
+
+
If you track down a bug in your code and want to know when it was introduced and why, file annotation is often your best tool.
+It shows you what commit was the last to modify each line of any file.
+So if you see that a method in your code is buggy, you can annotate the file with git blame to determine which commit was responsible for the introduction of that line.
+
+
+
The following example uses git blame to determine which commit and committer was responsible for lines in the top-level Linux kernel Makefile and, further, uses the -L option to restrict the output of the annotation to lines 69 through 82 of that file:
+
+
+
+
$ git blame -L 69,82 Makefile
+b8b0618cf6fab (Cheng Renquan 2009-05-26 16:03:07 +0800 69) ifeq ("$(origin V)", "command line")
+b8b0618cf6fab (Cheng Renquan 2009-05-26 16:03:07 +0800 70) KBUILD_VERBOSE = $(V)
+^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 71) endif
+^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 72) ifndef KBUILD_VERBOSE
+^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 73) KBUILD_VERBOSE = 0
+^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 74) endif
+^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 75)
+066b7ed955808 (Michal Marek 2014-07-04 14:29:30 +0200 76) ifeq ($(KBUILD_VERBOSE),1)
+066b7ed955808 (Michal Marek 2014-07-04 14:29:30 +0200 77) quiet =
+066b7ed955808 (Michal Marek 2014-07-04 14:29:30 +0200 78) Q =
+066b7ed955808 (Michal Marek 2014-07-04 14:29:30 +0200 79) else
+066b7ed955808 (Michal Marek 2014-07-04 14:29:30 +0200 80) quiet=quiet_
+066b7ed955808 (Michal Marek 2014-07-04 14:29:30 +0200 81) Q = @
+066b7ed955808 (Michal Marek 2014-07-04 14:29:30 +0200 82) endif
+
+
+
+
Notice that the first field is the partial SHA-1 of the commit that last modified that line.
+The next two fields are values extracted from that commit — the author name and the authored date of that commit — so you can easily see who modified that line and when.
+After that come the line number and the content of the file.
+Also note the ^1da177e4c3f4 commit lines, where the ^ prefix designates lines that were introduced in the repository’s initial commit and have remained unchanged ever since.
+This is a tad confusing, because now you’ve seen at least three different ways that Git uses the ^ to modify a commit SHA-1, but that is what it means here.
+
+
+
Another cool thing about Git is that it doesn’t track file renames explicitly.
+It records the snapshots and then tries to figure out what was renamed implicitly, after the fact.
+One of the interesting features of this is that you can ask it to figure out all sorts of code movement as well.
+If you pass -C to git blame, Git analyzes the file you’re annotating and tries to figure out where snippets of code within it originally came from if they were copied from elsewhere.
+For example, say you are refactoring a file named GITServerHandler.m into multiple files, one of which is GITPackUpload.m.
+By blaming GITPackUpload.m with the -C option, you can see where sections of the code originally came from:
+
+
+
+
$ git blame -C -L 141,153 GITPackUpload.m
+f344f58d GITServerHandler.m (Scott 2009-01-04 141)
+f344f58d GITServerHandler.m (Scott 2009-01-04 142) - (void) gatherObjectShasFromC
+f344f58d GITServerHandler.m (Scott 2009-01-04 143) {
+70befddd GITServerHandler.m (Scott 2009-03-22 144) //NSLog(@"GATHER COMMI
+ad11ac80 GITPackUpload.m (Scott 2009-03-24 145)
+ad11ac80 GITPackUpload.m (Scott 2009-03-24 146) NSString *parentSha;
+ad11ac80 GITPackUpload.m (Scott 2009-03-24 147) GITCommit *commit = [g
+ad11ac80 GITPackUpload.m (Scott 2009-03-24 148)
+ad11ac80 GITPackUpload.m (Scott 2009-03-24 149) //NSLog(@"GATHER COMMI
+ad11ac80 GITPackUpload.m (Scott 2009-03-24 150)
+56ef2caf GITServerHandler.m (Scott 2009-01-05 151) if(commit) {
+56ef2caf GITServerHandler.m (Scott 2009-01-05 152) [refDict setOb
+56ef2caf GITServerHandler.m (Scott 2009-01-05 153)
+
+
+
+
This is really useful.
+Normally, you get as the original commit the commit where you copied the code over, because that is the first time you touched those lines in this file.
+Git tells you the original commit where you wrote those lines, even if it was in another file.
+
+
+
Binary Search
+
+
Annotating a file helps if you know where the issue is to begin with.
+If you don’t know what is breaking, and there have been dozens or hundreds of commits since the last state where you know the code worked, you’ll likely turn to git bisect for help.
+The bisect command does a binary search through your commit history to help you identify as quickly as possible which commit introduced an issue.
+
+
+
Let’s say you just pushed out a release of your code to a production environment, you’re getting bug reports about something that wasn’t happening in your development environment, and you can’t imagine why the code is doing that.
+You go back to your code, and it turns out you can reproduce the issue, but you can’t figure out what is going wrong.
+You can bisect the code to find out.
+First you run git bisect start to get things going, and then you use git bisect bad to tell the system that the current commit you’re on is broken.
+Then, you must tell bisect when the last known good state was, using git bisect good <good_commit>:
+
+
+
+
$ git bisect start
+$ git bisect bad
+$ git bisect good v1.0
+Bisecting: 6 revisions left to test after this
+[ecb6e1bc347ccecc5f9350d878ce677feb13d3b2] Error handling on repo
+
+
+
+
Git figured out that about 12 commits came between the commit you marked as the last good commit (v1.0) and the current bad version, and it checked out the middle one for you.
+At this point, you can run your test to see if the issue exists as of this commit.
+If it does, then it was introduced sometime before this middle commit; if it doesn’t, then the problem was introduced sometime after the middle commit.
+It turns out there is no issue here, and you tell Git that by typing git bisect good and continue your journey:
+
+
+
+
$ git bisect good
+Bisecting: 3 revisions left to test after this
+[b047b02ea83310a70fd603dc8cd7a6cd13d15c04] Secure this thing
+
+
+
+
Now you’re on another commit, halfway between the one you just tested and your bad commit.
+You run your test again and find that this commit is broken, so you tell Git that with git bisect bad:
+
+
+
+
$ git bisect bad
+Bisecting: 1 revisions left to test after this
+[f71ce38690acf49c1f3c9bea38e09d82a5ce6014] Drop exceptions table
+
+
+
+
This commit is fine, and now Git has all the information it needs to determine where the issue was introduced.
+It tells you the SHA-1 of the first bad commit and show some of the commit information and which files were modified in that commit so you can figure out what happened that may have introduced this bug:
+
+
+
+
$ git bisect good
+b047b02ea83310a70fd603dc8cd7a6cd13d15c04 is first bad commit
+commit b047b02ea83310a70fd603dc8cd7a6cd13d15c04
+Author: PJ Hyett <pjhyett@example.com>
+Date: Tue Jan 27 14:48:32 2009 -0800
+
+ Secure this thing
+
+:040000 040000 40ee3e7821b895e52c1695092db9bdc4c61d1730
+f24d3c6ebcfc639b1a3814550e62d60b8e68a8e4 M config
+
+
+
+
When you’re finished, you should run git bisect reset to reset your HEAD to where you were before you started, or you’ll end up in a weird state:
+
+
+
+
This is a powerful tool that can help you check hundreds of commits for an introduced bug in minutes.
+In fact, if you have a script that will exit 0 if the project is good or non-0 if the project is bad, you can fully automate git bisect.
+First, you again tell it the scope of the bisect by providing the known bad and good commits.
+You can do this by listing them with the bisect start command if you want, listing the known bad commit first and the known good commit second:
+
+
+
+
$ git bisect start HEAD v1.0
+$ git bisect run test-error.sh
+
+
+
+
Doing so automatically runs test-error.sh on each checked-out commit until Git finds the first broken commit.
+You can also run something like make or make tests or whatever you have that runs automated tests for you.
+
+
Interactive Staging
+
+
In this section, you’ll look at a few interactive Git commands that can help you craft your commits to include only certain combinations and parts of files.
+These tools are helpful if you modify a number of files extensively, then decide that you want those changes to be partitioned into several focused commits rather than one big messy commit.
+This way, you can make sure your commits are logically separate changesets and can be reviewed easily by the developers working with you.
+
+
If you run git add with the -i or --interactive option, Git enters an interactive shell mode, displaying something like this:
+
+
+
$ git add -i
+ staged unstaged path
+ 1: unchanged +0/-1 TODO
+ 2: unchanged +1/-1 index.html
+ 3: unchanged +5/-1 lib/simplegit.rb
+
+*** Commands ***
+ 1: [s]tatus 2: [u]pdate 3: [r]evert 4: [a]dd untracked
+ 5: [p]atch 6: [d]iff 7: [q]uit 8: [h]elp
+What now>
+
+
+
You can see that this command shows you a much different view of your staging area than you’re probably used to — basically, the same information you get with git status but a bit more succinct and informative.
+It lists the changes you’ve staged on the left and unstaged changes on the right.
+
+
After this comes a “Commands” section, which allows you to do a number of things like staging and unstaging files, staging parts of files, adding untracked files, and displaying diffs of what has been staged.
+
+
Staging and Unstaging Files
+
+
If you type u or 2 (for update) at the What now> prompt, you’re prompted for which files you want to stage:
+
+
+
+
What now> u
+ staged unstaged path
+ 1: unchanged +0/-1 TODO
+ 2: unchanged +1/-1 index.html
+ 3: unchanged +5/-1 lib/simplegit.rb
+Update>>
+
+
+
+
To stage the TODO and index.html files, you can type the numbers:
+
+
+
+
Update>> 1,2
+ staged unstaged path
+* 1: unchanged +0/-1 TODO
+* 2: unchanged +1/-1 index.html
+ 3: unchanged +5/-1 lib/simplegit.rb
+Update>>
+
+
+
+
The * next to each file means the file is selected to be staged.
+If you press Enter after typing nothing at the Update>> prompt, Git takes anything selected and stages it for you:
+
+
+
+
Update>>
+updated 2 paths
+
+*** Commands ***
+ 1: [s]tatus 2: [u]pdate 3: [r]evert 4: [a]dd untracked
+ 5: [p]atch 6: [d]iff 7: [q]uit 8: [h]elp
+What now> s
+ staged unstaged path
+ 1: +0/-1 nothing TODO
+ 2: +1/-1 nothing index.html
+ 3: unchanged +5/-1 lib/simplegit.rb
+
+
+
+
Now you can see that the TODO and index.html files are staged and the simplegit.rb file is still unstaged.
+If you want to unstage the TODO file at this point, you use the r or 3 (for revert) option:
+
+
+
+
*** Commands ***
+ 1: [s]tatus 2: [u]pdate 3: [r]evert 4: [a]dd untracked
+ 5: [p]atch 6: [d]iff 7: [q]uit 8: [h]elp
+What now> r
+ staged unstaged path
+ 1: +0/-1 nothing TODO
+ 2: +1/-1 nothing index.html
+ 3: unchanged +5/-1 lib/simplegit.rb
+Revert>> 1
+ staged unstaged path
+* 1: +0/-1 nothing TODO
+ 2: +1/-1 nothing index.html
+ 3: unchanged +5/-1 lib/simplegit.rb
+Revert>> [enter]
+reverted one path
+
+
+
+
Looking at your Git status again, you can see that you’ve unstaged the TODO file:
+
+
+
+
*** Commands ***
+ 1: [s]tatus 2: [u]pdate 3: [r]evert 4: [a]dd untracked
+ 5: [p]atch 6: [d]iff 7: [q]uit 8: [h]elp
+What now> s
+ staged unstaged path
+ 1: unchanged +0/-1 TODO
+ 2: +1/-1 nothing index.html
+ 3: unchanged +5/-1 lib/simplegit.rb
+
+
+
+
To see the diff of what you’ve staged, you can use the d or 6 (for diff) command.
+It shows you a list of your staged files, and you can select the ones for which you would like to see the staged diff.
+This is much like specifying git diff --cached on the command line:
+
+
+
+
*** Commands ***
+ 1: [s]tatus 2: [u]pdate 3: [r]evert 4: [a]dd untracked
+ 5: [p]atch 6: [d]iff 7: [q]uit 8: [h]elp
+What now> d
+ staged unstaged path
+ 1: +1/-1 nothing index.html
+Review diff>> 1
+diff --git a/index.html b/index.html
+index 4d07108..4335f49 100644
+--- a/index.html
++++ b/index.html
+@@ -16,7 +16,7 @@ Date Finder
+
+ <p id="out">...</p>
+
+-<div id="footer">contact : support@github.com</div>
++<div id="footer">contact : email.support@github.com</div>
+
+ <script type="text/javascript">
+
+
+
+
With these basic commands, you can use the interactive add mode to deal with your staging area a little more easily.
+
+
+
Staging Patches
+
+
It’s also possible for Git to stage certain parts of files and not the rest.
+For example, if you make two changes to your simplegit.rb file and want to stage one of them and not the other, doing so is very easy in Git.
+From the same interactive prompt explained in the previous section, type p or 5 (for patch).
+Git will ask you which files you would like to partially stage; then, for each section of the selected files, it will display hunks of the file diff and ask if you would like to stage them, one by one:
+
+
+
+
diff --git a/lib/simplegit.rb b/lib/simplegit.rb
+index dd5ecc4..57399e0 100644
+--- a/lib/simplegit.rb
++++ b/lib/simplegit.rb
+@@ -22,7 +22,7 @@ class SimpleGit
+ end
+
+ def log(treeish = 'master')
+- command("git log -n 25 #{treeish}")
++ command("git log -n 30 #{treeish}")
+ end
+
+ def blame(path)
+Stage this hunk [y,n,a,d,/,j,J,g,e,?]?
+
+
+
+
You have a lot of options at this point.
+Typing ? shows a list of what you can do:
+
+
+
+
Stage this hunk [y,n,a,d,/,j,J,g,e,?]? ?
+y - stage this hunk
+n - do not stage this hunk
+a - stage this and all the remaining hunks in the file
+d - do not stage this hunk nor any of the remaining hunks in the file
+g - select a hunk to go to
+/ - search for a hunk matching the given regex
+j - leave this hunk undecided, see next undecided hunk
+J - leave this hunk undecided, see next hunk
+k - leave this hunk undecided, see previous undecided hunk
+K - leave this hunk undecided, see previous hunk
+s - split the current hunk into smaller hunks
+e - manually edit the current hunk
+? - print help
+
+
+
+
Generally, you’ll type y or n if you want to stage each hunk, but staging all of them in certain files or skipping a hunk decision until later can be helpful too.
+If you stage one part of the file and leave another part unstaged, your status output will look like this:
+
+
+
+
What now> 1
+ staged unstaged path
+ 1: unchanged +0/-1 TODO
+ 2: +1/-1 nothing index.html
+ 3: +1/-1 +4/-0 lib/simplegit.rb
+
+
+
+
The status of the simplegit.rb file is interesting.
+It shows you that a couple of lines are staged and a couple are unstaged.
+You’ve partially staged this file.
+At this point, you can exit the interactive adding script and run git commit to commit the partially staged files.
+
+
+
You also don’t need to be in interactive add mode to do the partial-file staging — you can start the same script by using git add -p or git add --patch on the command line.
+
+
+
Furthermore, you can use patch mode for partially resetting files with the git reset --patch command, for checking out parts of files with the git checkout --patch command and for stashing parts of files with the git stash save --patch command.
+We’ll go into more details on each of these as we get to more advanced usages of these commands.
+
+
Replace
+
+
As we’ve emphasized before, the objects in Git’s object database are unchangeable, but Git does provide an interesting way to pretend to replace objects in its database with other objects.
+
+
The replace command lets you specify an object in Git and say "every time you refer to this object, pretend it’s a different object".
+This is most commonly useful for replacing one commit in your history with another one without having to rebuild the entire history with, say, git filter-branch.
+
+
For example, let’s say you have a huge code history and want to split your repository into one short history for new developers and one much longer and larger history for people interested in data mining.
+You can graft one history onto the other by "replacing" the earliest commit in the new line with the latest commit on the older one.
+This is nice because it means that you don’t actually have to rewrite every commit in the new history, as you would normally have to do to join them together (because the parentage affects the SHA-1s).
+
+
Let’s try this out.
+Let’s take an existing repository, split it into two repositories, one recent and one historical, and then we’ll see how we can recombine them without modifying the recent repositories SHA-1 values via replace.
+
+
We’ll use a simple repository with five simple commits:
+
+
+
$ git log --oneline
+ef989d8 Fifth commit
+c6e1e95 Fourth commit
+9c68fdc Third commit
+945704c Second commit
+c1822cf First commit
+
+
+
We want to break this up into two lines of history.
+One line goes from commit one to commit four - that will be the historical one.
+The second line will just be commits four and five - that will be the recent history.
+
+
+
}}" alt="replace1">
+
+
+
Well, creating the historical history is easy, we can just put a branch in the history and then push that branch to the master branch of a new remote repository.
+
+
+
$ git branch history c6e1e95
+$ git log --oneline --decorate
+ef989d8 (HEAD, master) Fifth commit
+c6e1e95 (history) Fourth commit
+9c68fdc Third commit
+945704c Second commit
+c1822cf First commit
+
+
+
+
}}" alt="replace2">
+
+
+
Now we can push the new history branch to the master branch of our new repository:
+
+
+
$ git remote add project-history https://github.com/schacon/project-history
+$ git push project-history history:master
+Counting objects: 12, done.
+Delta compression using up to 2 threads.
+Compressing objects: 100% (4/4), done.
+Writing objects: 100% (12/12), 907 bytes, done.
+Total 12 (delta 0), reused 0 (delta 0)
+Unpacking objects: 100% (12/12), done.
+To git@github.com:schacon/project-history.git
+ * [new branch] history -> master
+
+
+
OK, so our history is published.
+Now the harder part is truncating our recent history down so it’s smaller.
+We need an overlap so we can replace a commit in one with an equivalent commit in the other, so we’re going to truncate this to just commits four and five (so commit four overlaps).
+
+
+
$ git log --oneline --decorate
+ef989d8 (HEAD, master) Fifth commit
+c6e1e95 (history) Fourth commit
+9c68fdc Third commit
+945704c Second commit
+c1822cf First commit
+
+
+
It’s useful in this case to create a base commit that has instructions on how to expand the history, so other developers know what to do if they hit the first commit in the truncated history and need more.
+So, what we’re going to do is create an initial commit object as our base point with instructions, then rebase the remaining commits (four and five) on top of it.
+
+
To do that, we need to choose a point to split at, which for us is the third commit, which is 9c68fdc in SHA-speak.
+So, our base commit will be based off of that tree.
+We can create our base commit using the commit-tree command, which just takes a tree and will give us a brand new, parentless commit object SHA-1 back.
+
+
+
$ echo 'Get history from blah blah blah' | git commit-tree 9c68fdc^{tree}
+622e88e9cbfbacfb75b5279245b9fb38dfea10cf
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ The commit-tree command is one of a set of commands that are commonly referred to as plumbing commands.
+These are commands that are not generally meant to be used directly, but instead are used by other Git commands to do smaller jobs.
+On occasions when we’re doing weirder things like this, they allow us to do really low-level things but are not meant for daily use.
+You can read more about plumbing commands in Plumbing and Porcelain
+ |
+
+
+
+
+
}}" alt="replace3">
+
+
+
OK, so now that we have a base commit, we can rebase the rest of our history on top of that with git rebase --onto.
+The --onto argument will be the SHA-1 we just got back from commit-tree and the rebase point will be the third commit (the parent of the first commit we want to keep, 9c68fdc):
+
+
+
$ git rebase --onto 622e88 9c68fdc
+First, rewinding head to replay your work on top of it...
+Applying: fourth commit
+Applying: fifth commit
+
+
+
+
}}" alt="replace4">
+
+
+
OK, so now we’ve re-written our recent history on top of a throw away base commit that now has instructions in it on how to reconstitute the entire history if we wanted to.
+We can push that new history to a new project and now when people clone that repository, they will only see the most recent two commits and then a base commit with instructions.
+
+
Let’s now switch roles to someone cloning the project for the first time who wants the entire history.
+To get the history data after cloning this truncated repository, one would have to add a second remote for the historical repository and fetch:
+
+
+
$ git clone https://github.com/schacon/project
+$ cd project
+
+$ git log --oneline master
+e146b5f Fifth commit
+81a708d Fourth commit
+622e88e Get history from blah blah blah
+
+$ git remote add project-history https://github.com/schacon/project-history
+$ git fetch project-history
+From https://github.com/schacon/project-history
+ * [new branch] master -> project-history/master
+
+
+
Now the collaborator would have their recent commits in the master branch and the historical commits in the project-history/master branch.
+
+
+
$ git log --oneline master
+e146b5f Fifth commit
+81a708d Fourth commit
+622e88e Get history from blah blah blah
+
+$ git log --oneline project-history/master
+c6e1e95 Fourth commit
+9c68fdc Third commit
+945704c Second commit
+c1822cf First commit
+
+
+
To combine them, you can simply call git replace with the commit you want to replace and then the commit you want to replace it with.
+So we want to replace the "fourth" commit in the master branch with the "fourth" commit in the project-history/master branch:
+
+
+
$ git replace 81a708d c6e1e95
+
+
+
Now, if you look at the history of the master branch, it appears to look like this:
+
+
+
$ git log --oneline master
+e146b5f Fifth commit
+81a708d Fourth commit
+9c68fdc Third commit
+945704c Second commit
+c1822cf First commit
+
+
+
Cool, right? Without having to change all the SHA-1s upstream, we were able to replace one commit in our history with an entirely different commit and all the normal tools (bisect, blame, etc) will work how we would expect them to.
+
+
+
}}" alt="replace5">
+
+
+
Interestingly, it still shows 81a708d as the SHA-1, even though it’s actually using the c6e1e95 commit data that we replaced it with.
+Even if you run a command like cat-file, it will show you the replaced data:
+
+
+
$ git cat-file -p 81a708d
+tree 7bc544cf438903b65ca9104a1e30345eee6c083d
+parent 9c68fdceee073230f19ebb8b5e7fc71b479c0252
+author Scott Chacon <schacon@gmail.com> 1268712581 -0700
+committer Scott Chacon <schacon@gmail.com> 1268712581 -0700
+
+fourth commit
+
+
+
Remember that the actual parent of 81a708d was our placeholder commit (622e88e), not 9c68fdce as it states here.
+
+
Another interesting thing is that this data is kept in our references:
+
+
+
$ git for-each-ref
+e146b5f14e79d4935160c0e83fb9ebe526b8da0d commit refs/heads/master
+c6e1e95051d41771a649f3145423f8809d1a74d4 commit refs/remotes/history/master
+e146b5f14e79d4935160c0e83fb9ebe526b8da0d commit refs/remotes/origin/HEAD
+e146b5f14e79d4935160c0e83fb9ebe526b8da0d commit refs/remotes/origin/master
+c6e1e95051d41771a649f3145423f8809d1a74d4 commit refs/replace/81a708dd0e167a3f691541c7a6463343bc457040
+
+
+
This means that it’s easy to share our replacement with others, because we can push this to our server and other people can easily download it.
+This is not that helpful in the history grafting scenario we’ve gone over here (since everyone would be downloading both histories anyhow, so why separate them?) but it can be useful in other circumstances.
+
Rerere
+
+
The git rerere functionality is a bit of a hidden feature.
+The name stands for “reuse recorded resolution” and, as the name implies, it allows you to ask Git to remember how you’ve resolved a hunk conflict so that the next time it sees the same conflict, Git can resolve it for you automatically.
+
+
There are a number of scenarios in which this functionality might be really handy.
+One of the examples that is mentioned in the documentation is when you want to make sure a long-lived topic branch will ultimately merge cleanly, but you don’t want to have a bunch of intermediate merge commits cluttering up your commit history.
+With rerere enabled, you can attempt the occasional merge, resolve the conflicts, then back out of the merge.
+If you do this continuously, then the final merge should be easy because rerere can just do everything for you automatically.
+
+
This same tactic can be used if you want to keep a branch rebased so you don’t have to deal with the same rebasing conflicts each time you do it.
+Or if you want to take a branch that you merged and fixed a bunch of conflicts and then decide to rebase it instead — you likely won’t have to do all the same conflicts again.
+
+
Another application of rerere is where you merge a bunch of evolving topic branches together into a testable head occasionally, as the Git project itself often does.
+If the tests fail, you can rewind the merges and re-do them without the topic branch that made the tests fail without having to re-resolve the conflicts again.
+
+
To enable rerere functionality, you simply have to run this config setting:
+
+
+
$ git config --global rerere.enabled true
+
+
+
You can also turn it on by creating the .git/rr-cache directory in a specific repository, but the config setting is clearer and enables that feature globally for you.
+
+
Now let’s see a simple example, similar to our previous one.
+Let’s say we have a file named hello.rb that looks like this:
+
+
+
#! /usr/bin/env ruby
+
+def hello
+ puts 'hello world'
+end
+
+
+
In one branch we change the word “hello” to “hola”, then in another branch we change the “world” to “mundo”, just like before.
+
+
+
}}" alt="rerere1">
+
+
+
When we merge the two branches together, we’ll get a merge conflict:
+
+
+
$ git merge i18n-world
+Auto-merging hello.rb
+CONFLICT (content): Merge conflict in hello.rb
+Recorded preimage for 'hello.rb'
+Automatic merge failed; fix conflicts and then commit the result.
+
+
+
You should notice the new line Recorded preimage for FILE in there.
+Otherwise it should look exactly like a normal merge conflict.
+At this point, rerere can tell us a few things.
+Normally, you might run git status at this point to see what all conflicted:
+
+
+
$ git status
+# On branch master
+# Unmerged paths:
+# (use "git reset HEAD <file>..." to unstage)
+# (use "git add <file>..." to mark resolution)
+#
+# both modified: hello.rb
+#
+
+
+
However, git rerere will also tell you what it has recorded the pre-merge state for with git rerere status:
+
+
+
$ git rerere status
+hello.rb
+
+
+
And git rerere diff will show the current state of the resolution — what you started with to resolve and what you’ve resolved it to.
+
+
+
$ git rerere diff
+--- a/hello.rb
++++ b/hello.rb
+@@ -1,11 +1,11 @@
+ #! /usr/bin/env ruby
+
+ def hello
+-<<<<<<<
+- puts 'hello mundo'
+-=======
++<<<<<<< HEAD
+ puts 'hola world'
+->>>>>>>
++=======
++ puts 'hello mundo'
++>>>>>>> i18n-world
+ end
+
+
+
Also (and this isn’t really related to rerere), you can use git ls-files -u to see the conflicted files and the before, left and right versions:
+
+
+
$ git ls-files -u
+100644 39804c942a9c1f2c03dc7c5ebcd7f3e3a6b97519 1 hello.rb
+100644 a440db6e8d1fd76ad438a49025a9ad9ce746f581 2 hello.rb
+100644 54336ba847c3758ab604876419607e9443848474 3 hello.rb
+
+
+
Now you can resolve it to just be puts 'hola mundo' and you can run git rerere diff again to see what rerere will remember:
+
+
+
$ git rerere diff
+--- a/hello.rb
++++ b/hello.rb
+@@ -1,11 +1,7 @@
+ #! /usr/bin/env ruby
+
+ def hello
+-<<<<<<<
+- puts 'hello mundo'
+-=======
+- puts 'hola world'
+->>>>>>>
++ puts 'hola mundo'
+ end
+
+
+
So that basically says, when Git sees a hunk conflict in a hello.rb file that has “hello mundo” on one side and “hola world” on the other, it will resolve it to “hola mundo”.
+
+
Now we can mark it as resolved and commit it:
+
+
+
$ git add hello.rb
+$ git commit
+Recorded resolution for 'hello.rb'.
+[master 68e16e5] Merge branch 'i18n'
+
+
+
You can see that it "Recorded resolution for FILE".
+
+
+
}}" alt="rerere2">
+
+
+
Now, let’s undo that merge and then rebase it on top of our master branch instead.
+We can move our branch back by using git reset as we saw in Reset Demystified.
+
+
+
$ git reset --hard HEAD^
+HEAD is now at ad63f15 i18n the hello
+
+
+
Our merge is undone.
+Now let’s rebase the topic branch.
+
+
+
$ git checkout i18n-world
+Switched to branch 'i18n-world'
+
+$ git rebase master
+First, rewinding head to replay your work on top of it...
+Applying: i18n one word
+Using index info to reconstruct a base tree...
+Falling back to patching base and 3-way merge...
+Auto-merging hello.rb
+CONFLICT (content): Merge conflict in hello.rb
+Resolved 'hello.rb' using previous resolution.
+Failed to merge in the changes.
+Patch failed at 0001 i18n one word
+
+
+
Now, we got the same merge conflict like we expected, but take a look at the Resolved FILE using previous resolution line.
+If we look at the file, we’ll see that it’s already been resolved, there are no merge conflict markers in it.
+
+
+
#! /usr/bin/env ruby
+
+def hello
+ puts 'hola mundo'
+end
+
+
+
Also, git diff will show you how it was automatically re-resolved:
+
+
+
$ git diff
+diff --cc hello.rb
+index a440db6,54336ba..0000000
+--- a/hello.rb
++++ b/hello.rb
+@@@ -1,7 -1,7 +1,7 @@@
+ #! /usr/bin/env ruby
+
+ def hello
+- puts 'hola world'
+ - puts 'hello mundo'
+++ puts 'hola mundo'
+ end
+
+
+
+
}}" alt="rerere3">
+
+
+
You can also recreate the conflicted file state with git checkout:
+
+
+
$ git checkout --conflict=merge hello.rb
+$ cat hello.rb
+#! /usr/bin/env ruby
+
+def hello
+<<<<<<< ours
+ puts 'hola world'
+=======
+ puts 'hello mundo'
+>>>>>>> theirs
+end
+
+
+
We saw an example of this in Advanced Merging.
+For now though, let’s re-resolve it by just running git rerere again:
+
+
+
$ git rerere
+Resolved 'hello.rb' using previous resolution.
+$ cat hello.rb
+#! /usr/bin/env ruby
+
+def hello
+ puts 'hola mundo'
+end
+
+
+
We have re-resolved the file automatically using the rerere cached resolution.
+You can now add and continue the rebase to complete it.
+
+
+
$ git add hello.rb
+$ git rebase --continue
+Applying: i18n one word
+
+
+
So, if you do a lot of re-merges, or want to keep a topic branch up to date with your master branch without a ton of merges, or you rebase often, you can turn on rerere to help your life out a bit.
+
Reset Demystified
+
+
Before moving on to more specialized tools, let’s talk about the Git reset and checkout commands.
+These commands are two of the most confusing parts of Git when you first encounter them.
+They do so many things that it seems hopeless to actually understand them and employ them properly.
+For this, we recommend a simple metaphor.
+
+
The Three Trees
+
+
An easier way to think about reset and checkout is through the mental frame of Git being a content manager of three different trees.
+By “tree” here, we really mean “collection of files”, not specifically the data structure.
+(There are a few cases where the index doesn’t exactly act like a tree, but for our purposes it is easier to think about it this way for now.)
+
+
+
Git as a system manages and manipulates three trees in its normal operation:
+
+
+
+
+
+
+
+
+| Tree |
+Role |
+
+
+
+
+HEAD |
+Last commit snapshot, next parent |
+
+
+Index |
+Proposed next commit snapshot |
+
+
+Working Directory |
+Sandbox |
+
+
+
+
+
The HEAD
+
+
HEAD is the pointer to the current branch reference, which is in turn a pointer to the last commit made on that branch.
+That means HEAD will be the parent of the next commit that is created.
+It’s generally simplest to think of HEAD as the snapshot of your last commit on that branch.
+
+
+
In fact, it’s pretty easy to see what that snapshot looks like.
+Here is an example of getting the actual directory listing and SHA-1 checksums for each file in the HEAD snapshot:
+
+
+
+
$ git cat-file -p HEAD
+tree cfda3bf379e4f8dba8717dee55aab78aef7f4daf
+author Scott Chacon 1301511835 -0700
+committer Scott Chacon 1301511835 -0700
+
+initial commit
+
+$ git ls-tree -r HEAD
+100644 blob a906cb2a4a904a152... README
+100644 blob 8f94139338f9404f2... Rakefile
+040000 tree 99f1a6d12cb4b6f19... lib
+
+
+
+
The Git cat-file and ls-tree commands are “plumbing” commands that are used for lower level things and not really used in day-to-day work, but they help us see what’s going on here.
+
+
+
+
The Index
+
+
The index is your proposed next commit.
+We’ve also been referring to this concept as Git’s “Staging Area” as this is what Git looks at when you run git commit.
+
+
+
Git populates this index with a list of all the file contents that were last checked out into your working directory and what they looked like when they were originally checked out.
+You then replace some of those files with new versions of them, and git commit converts that into the tree for a new commit.
+
+
+
+
$ git ls-files -s
+100644 a906cb2a4a904a152e80877d4088654daad0c859 0 README
+100644 8f94139338f9404f26296befa88755fc2598c289 0 Rakefile
+100644 47c6340d6459e05787f644c2447d2595f5d3a54b 0 lib/simplegit.rb
+
+
+
+
Again, here we’re using git ls-files, which is more of a behind the scenes command that shows you what your index currently looks like.
+
+
+
The index is not technically a tree structure — it’s actually implemented as a flattened manifest — but for our purposes it’s close enough.
+
+
+
+
The Working Directory
+
+
Finally, you have your working directory (also commonly referred to as the “working tree”).
+The other two trees store their content in an efficient but inconvenient manner, inside the .git folder.
+The working directory unpacks them into actual files, which makes it much easier for you to edit them.
+Think of the working directory as a sandbox, where you can try changes out before committing them to your staging area (index) and then to history.
+
+
+
+
$ tree
+.
+├── README
+├── Rakefile
+└── lib
+ └── simplegit.rb
+
+1 directory, 3 files
+
+
+
+
+
The Workflow
+
+
Git’s typical workflow is to record snapshots of your project in successively better states, by manipulating these three trees.
+
+
+
+
}}" alt="reset workflow">
+
+
+
+
Let’s visualize this process: say you go into a new directory with a single file in it.
+We’ll call this v1 of the file, and we’ll indicate it in blue.
+Now we run git init, which will create a Git repository with a HEAD reference which points to the unborn master branch.
+
+
+
+
}}" alt="reset ex1">
+
+
+
+
At this point, only the working directory tree has any content.
+
+
+
Now we want to commit this file, so we use git add to take content in the working directory and copy it to the index.
+
+
+
+
}}" alt="reset ex2">
+
+
+
+
Then we run git commit, which takes the contents of the index and saves it as a permanent snapshot, creates a commit object which points to that snapshot, and updates master to point to that commit.
+
+
+
+
}}" alt="reset ex3">
+
+
+
+
If we run git status, we’ll see no changes, because all three trees are the same.
+
+
+
Now we want to make a change to that file and commit it.
+We’ll go through the same process; first, we change the file in our working directory.
+Let’s call this v2 of the file, and indicate it in red.
+
+
+
+
}}" alt="reset ex4">
+
+
+
+
If we run git status right now, we’ll see the file in red as “Changes not staged for commit”, because that entry differs between the index and the working directory.
+Next we run git add on it to stage it into our index.
+
+
+
+
}}" alt="reset ex5">
+
+
+
+
At this point, if we run git status, we will see the file in green under “Changes to be committed” because the index and HEAD differ — that is, our proposed next commit is now different from our last commit.
+Finally, we run git commit to finalize the commit.
+
+
+
+
}}" alt="reset ex6">
+
+
+
+
Now git status will give us no output, because all three trees are the same again.
+
+
+
Switching branches or cloning goes through a similar process.
+When you checkout a branch, it changes HEAD to point to the new branch ref, populates your index with the snapshot of that commit, then copies the contents of the index into your working Directory.
+
+
+
The Role of Reset
+
+
The reset command makes more sense when viewed in this context.
+
+
+
For the purposes of these examples, let’s say that we’ve modified file.txt again and committed it a third time.
+So now our history looks like this:
+
+
+
+
}}" alt="reset start">
+
+
+
+
Let’s now walk through exactly what reset does when you call it.
+It directly manipulates these three trees in a simple and predictable way.
+It does up to three basic operations.
+
+
+
Step 1: Move HEAD
+
+
The first thing reset will do is move what HEAD points to.
+This isn’t the same as changing HEAD itself (which is what checkout does); reset moves the branch that HEAD is pointing to.
+This means if HEAD is set to the master branch (i.e. you’re currently on the master branch), running git reset 9e5e6a4 will start by making master point to 9e5e6a4.
+
+
+
+
}}" alt="reset soft">
+
+
+
+
No matter what form of reset with a commit you invoke, this is the first thing it will always try to do.
+With reset --soft, it will simply stop there.
+
+
+
Now take a second to look at that diagram and realize what happened: it essentially undid the last git commit command.
+When you run git commit, Git creates a new commit and moves the branch that HEAD points to up to it.
+When you reset back to HEAD~ (the parent of HEAD), you are moving the branch back to where it was, without changing the index or working directory.
+You could now update the index and run git commit again to accomplish what git commit --amend would have done (see Changing the Last Commit).
+
+
+
+
Step 2: Updating the Index (--mixed)
+
+
Note that if you run git status now you’ll see in green the difference between the index and what the new HEAD is.
+
+
+
The next thing reset will do is to update the index with the contents of whatever snapshot HEAD now points to.
+
+
+
+
}}" alt="reset mixed">
+
+
+
+
If you specify the --mixed option, reset will stop at this point.
+This is also the default, so if you specify no option at all (just git reset HEAD~ in this case), this is where the command will stop.
+
+
+
Now take another second to look at that diagram and realize what happened: it still undid your last commit, but also unstaged everything.
+You rolled back to before you ran all your git add and git commit commands.
+
+
+
+
Step 3: Updating the Working Directory (--hard)
+
+
The third thing that reset will do is to make the working directory look like the index.
+If you use the --hard option, it will continue to this stage.
+
+
+
+
}}" alt="reset hard">
+
+
+
+
So let’s think about what just happened.
+You undid your last commit, the git add and git commit commands, and all the work you did in your working directory.
+
+
+
It’s important to note that this flag (--hard) is the only way to make the reset command dangerous, and one of the very few cases where Git will actually destroy data.
+Any other invocation of reset can be pretty easily undone, but the --hard option cannot, since it forcibly overwrites files in the working directory.
+In this particular case, we still have the v3 version of our file in a commit in our Git DB, and we could get it back by looking at our reflog, but if we had not committed it, Git still would have overwritten the file and it would be unrecoverable.
+
+
+
+
Recap
+
+
The reset command overwrites these three trees in a specific order, stopping when you tell it to:
+
+
+
+-
+
Move the branch HEAD points to (stop here if --soft)
+
+-
+
Make the index look like HEAD (stop here unless --hard)
+
+-
+
Make the working directory look like the index
+
+
+
+
+
+
Reset With a Path
+
+
That covers the behavior of reset in its basic form, but you can also provide it with a path to act upon.
+If you specify a path, reset will skip step 1, and limit the remainder of its actions to a specific file or set of files.
+This actually sort of makes sense — HEAD is just a pointer, and you can’t point to part of one commit and part of another.
+But the index and working directory can be partially updated, so reset proceeds with steps 2 and 3.
+
+
+
So, assume we run git reset file.txt.
+This form (since you did not specify a commit SHA-1 or branch, and you didn’t specify --soft or --hard) is shorthand for git reset --mixed HEAD file.txt, which will:
+
+
+
+-
+
Move the branch HEAD points to (skipped)
+
+-
+
Make the index look like HEAD (stop here)
+
+
+
+
+
So it essentially just copies file.txt from HEAD to the index.
+
+
+
+
}}" alt="reset path1">
+
+
+
+
This has the practical effect of unstaging the file.
+If we look at the diagram for that command and think about what git add does, they are exact opposites.
+
+
+
+
}}" alt="reset path2">
+
+
+
+
+
We could just as easily not let Git assume we meant “pull the data from HEAD” by specifying a specific commit to pull that file version from.
+We would just run something like git reset eb43bf file.txt.
+
+
+
+
}}" alt="reset path3">
+
+
+
+
This effectively does the same thing as if we had reverted the content of the file to v1 in the working directory, ran git add on it, then reverted it back to v3 again (without actually going through all those steps).
+If we run git commit now, it will record a change that reverts that file back to v1, even though we never actually had it in our working directory again.
+
+
+
It’s also interesting to note that like git add, the reset command will accept a --patch option to unstage content on a hunk-by-hunk basis.
+So you can selectively unstage or revert content.
+
+
+
Squashing
+
+
Let’s look at how to do something interesting with this newfound power — squashing commits.
+
+
+
Say you have a series of commits with messages like “oops.”, “WIP” and “forgot this file”.
+You can use reset to quickly and easily squash them into a single commit that makes you look really smart.
+(Squashing Commits shows another way to do this, but in this example it’s simpler to use reset.)
+
+
+
Let’s say you have a project where the first commit has one file, the second commit added a new file and changed the first, and the third commit changed the first file again.
+The second commit was a work in progress and you want to squash it down.
+
+
+
+
}}" alt="reset squash r1">
+
+
+
+
You can run git reset --soft HEAD~2 to move the HEAD branch back to an older commit (the most recent commit you want to keep):
+
+
+
+
}}" alt="reset squash r2">
+
+
+
+
And then simply run git commit again:
+
+
+
+
}}" alt="reset squash r3">
+
+
+
+
Now you can see that your reachable history, the history you would push, now looks like you had one commit with file-a.txt v1, then a second that both modified file-a.txt to v3 and added file-b.txt.
+The commit with the v2 version of the file is no longer in the history.
+
+
+
Check It Out
+
+
Finally, you may wonder what the difference between checkout and reset is.
+Like reset, checkout manipulates the three trees, and it is a bit different depending on whether you give the command a file path or not.
+
+
+
Without Paths
+
+
Running git checkout [branch] is pretty similar to running git reset --hard [branch] in that it updates all three trees for you to look like [branch], but there are two important differences.
+
+
+
First, unlike reset --hard, checkout is working-directory safe; it will check to make sure it’s not blowing away files that have changes to them.
+Actually, it’s a bit smarter than that — it tries to do a trivial merge in the working directory, so all of the files you haven’t changed will be updated.
+reset --hard, on the other hand, will simply replace everything across the board without checking.
+
+
+
The second important difference is how checkout updates HEAD.
+Whereas reset will move the branch that HEAD points to, checkout will move HEAD itself to point to another branch.
+
+
+
For instance, say we have master and develop branches which point at different commits, and we’re currently on develop (so HEAD points to it).
+If we run git reset master, develop itself will now point to the same commit that master does.
+If we instead run git checkout master, develop does not move, HEAD itself does.
+HEAD will now point to master.
+
+
+
So, in both cases we’re moving HEAD to point to commit A, but how we do so is very different.
+reset will move the branch HEAD points to, checkout moves HEAD itself.
+
+
+
+
}}" alt="reset checkout">
+
+
+
+
+
With Paths
+
+
The other way to run checkout is with a file path, which, like reset, does not move HEAD.
+It is just like git reset [branch] file in that it updates the index with that file at that commit, but it also overwrites the file in the working directory.
+It would be exactly like git reset --hard [branch] file (if reset would let you run that) — it’s not working-directory safe, and it does not move HEAD.
+
+
+
Also, like git reset and git add, checkout will accept a --patch option to allow you to selectively revert file contents on a hunk-by-hunk basis.
+
+
+
+
Summary
+
+
Hopefully now you understand and feel more comfortable with the reset command, but are probably still a little confused about how exactly it differs from checkout and could not possibly remember all the rules of the different invocations.
+
+
+
Here’s a cheat-sheet for which commands affect which trees.
+The “HEAD” column reads “REF” if that command moves the reference (branch) that HEAD points to, and “HEAD” if it moves HEAD itself.
+Pay especial attention to the WD Safe? column — if it says NO, take a second to think before running that command.
+
+
+
+
+
+
+
+
+
+
+
+ |
+HEAD |
+Index |
+Workdir |
+WD Safe? |
+
+
+
+
+Commit Level |
+ |
+ |
+ |
+ |
+
+
+reset --soft [commit]
|
+REF |
+NO |
+NO |
+YES |
+
+
+reset [commit]
|
+REF |
+YES |
+NO |
+YES |
+
+
+reset --hard [commit]
|
+REF |
+YES |
+YES |
+NO |
+
+
+checkout <commit>
|
+HEAD |
+YES |
+YES |
+YES |
+
+
+File Level |
+ |
+ |
+ |
+ |
+
+
+reset [commit] <paths>
|
+NO |
+YES |
+NO |
+YES |
+
+
+checkout [commit] <paths>
|
+NO |
+YES |
+YES |
+NO |
+
+
+
+
By now, you’ve learned most of the day-to-day commands and workflows that you need to manage or maintain a Git repository for your source code control.
+You’ve accomplished the basic tasks of tracking and committing files, and you’ve harnessed the power of the staging area and lightweight topic branching and merging.
Now you’ll explore a number of very powerful things that Git can do that you may not necessarily use on a day-to-day basis but that you may need at some point.
+Revision Selection
+
+
Git allows you to refer to a single commit, set of commits, or range of commits in a number of ways.
+They aren’t necessarily obvious but are helpful to know.
+
+
Single Revisions
+
+
You can obviously refer to any single commit by its full, 40-character SHA-1 hash, but there are more human-friendly ways to refer to commits as well.
+This section outlines the various ways you can refer to any commit.
+
+
+
Short SHA-1
+
+
Git is smart enough to figure out what commit you’re referring to if you provide the first few characters of the SHA-1 hash, as long as that partial hash is at least four characters long and unambiguous; that is, no other object in the object database can have a hash that begins with the same prefix.
+
+
+
For example, to examine a specific commit where you know you added certain functionality, you might first run the git log command to locate the commit:
+
+
+
+
$ git log
+commit 734713bc047d87bf7eac9674765ae793478c50d3
+Author: Scott Chacon <schacon@gmail.com>
+Date: Fri Jan 2 18:32:33 2009 -0800
+
+ Fix refs handling, add gc auto, update tests
+
+commit d921970aadf03b3cf0e71becdaab3147ba71cdef
+Merge: 1c002dd... 35cfb2b...
+Author: Scott Chacon <schacon@gmail.com>
+Date: Thu Dec 11 15:08:43 2008 -0800
+
+ Merge commit 'phedders/rdocs'
+
+commit 1c002dd4b536e7479fe34593e72e6c6c1819e53b
+Author: Scott Chacon <schacon@gmail.com>
+Date: Thu Dec 11 14:58:32 2008 -0800
+
+ Add some blame and merge stuff
+
+
+
+
In this case, say you’re interested in the commit whose hash begins with 1c002dd....
+You can inspect that commit with any of the following variations of git show (assuming the shorter versions are unambiguous):
+
+
+
+
$ git show 1c002dd4b536e7479fe34593e72e6c6c1819e53b
+$ git show 1c002dd4b536e7479f
+$ git show 1c002d
+
+
+
+
Git can figure out a short, unique abbreviation for your SHA-1 values.
+If you pass --abbrev-commit to the git log command, the output will use shorter values but keep them unique; it defaults to using seven characters but makes them longer if necessary to keep the SHA-1 unambiguous:
+
+
+
+
$ git log --abbrev-commit --pretty=oneline
+ca82a6d Change the version number
+085bb3b Remove unnecessary test code
+a11bef0 Initial commit
+
+
+
+
Generally, eight to ten characters are more than enough to be unique within a project.
+For example, as of February 2019, the Linux kernel (which is a fairly sizable project) has over 875,000 commits and almost seven million objects in its object database, with no two objects whose SHA-1s are identical in the first 12 characters.
+
+
+
+
+|
+ یادداشت
+ |
+
+ A SHORT NOTE ABOUT SHA-1
+
+ A lot of people become concerned at some point that they will, by random happenstance, have two distinct objects in their repository that hash to the same SHA-1 value.
+What then?
+
+ If you do happen to commit an object that hashes to the same SHA-1 value as a previous different object in your repository, Git will see the previous object already in your Git database, assume it was already written and simply reuse it.
+If you try to check out that object again at some point, you’ll always get the data of the first object.
+
+ However, you should be aware of how ridiculously unlikely this scenario is.
+The SHA-1 digest is 20 bytes or 160 bits.
+The number of randomly hashed objects needed to ensure a 50% probability of a single collision is about 280
+(the formula for determining collision probability is p = (n(n-1)/2) * (1/2^160)). 280
+is 1.2 x 1024
+or 1 million billion billion.
+That’s 1,200 times the number of grains of sand on the earth.
+
+ Here’s an example to give you an idea of what it would take to get a SHA-1 collision.
+If all 6.5 billion humans on Earth were programming, and every second, each one was producing code that was the equivalent of the entire Linux kernel history (6.5 million Git objects) and pushing it into one enormous Git repository, it would take roughly 2 years until that repository contained enough objects to have a 50% probability of a single SHA-1 object collision.
+Thus, a SHA-1 collision is less likely than every member of your programming team being attacked and killed by wolves in unrelated incidents on the same night.
+ |
+
+
+
+
+
Branch References
+
+
One straightforward way to refer to a particular commit is if it’s the commit at the tip of a branch; in that case, you can simply use the branch name in any Git command that expects a reference to a commit.
+For instance, if you want to examine the last commit object on a branch, the following commands are equivalent, assuming that the topic1 branch points to commit ca82a6d...:
+
+
+
+
$ git show ca82a6dff817ec66f44342007202690a93763949
+$ git show topic1
+
+
+
+
If you want to see which specific SHA-1 a branch points to, or if you want to see what any of these examples boils down to in terms of SHA-1s, you can use a Git plumbing tool called rev-parse.
+You can see Git Internals for more information about plumbing tools; basically, rev-parse exists for lower-level operations and isn’t designed to be used in day-to-day operations.
+However, it can be helpful sometimes when you need to see what’s really going on.
+Here you can run rev-parse on your branch.
+
+
+
+
$ git rev-parse topic1
+ca82a6dff817ec66f44342007202690a93763949
+
+
+
+
RefLog Shortnames
+
+
One of the things Git does in the background while you’re working away is keep a “reflog” — a log of where your HEAD and branch references have been for the last few months.
+
+
+
You can see your reflog by using git reflog:
+
+
+
+
$ git reflog
+734713b HEAD@{0}: commit: Fix refs handling, add gc auto, update tests
+d921970 HEAD@{1}: merge phedders/rdocs: Merge made by the 'recursive' strategy.
+1c002dd HEAD@{2}: commit: Add some blame and merge stuff
+1c36188 HEAD@{3}: rebase -i (squash): updating HEAD
+95df984 HEAD@{4}: commit: # This is a combination of two commits.
+1c36188 HEAD@{5}: rebase -i (squash): updating HEAD
+7e05da5 HEAD@{6}: rebase -i (pick): updating HEAD
+
+
+
+
Every time your branch tip is updated for any reason, Git stores that information for you in this temporary history.
+You can use your reflog data to refer to older commits as well.
+For example, if you want to see the fifth prior value of the HEAD of your repository, you can use the @{5} reference that you see in the reflog output:
+
+
+
+
You can also use this syntax to see where a branch was some specific amount of time ago.
+For instance, to see where your master branch was yesterday, you can type
+
+
+
+
$ git show master@{yesterday}
+
+
+
+
That would show you where tip of your master branch was yesterday.
+This technique only works for data that’s still in your reflog, so you can’t use it to look for commits older than a few months.
+
+
+
To see reflog information formatted like the git log output, you can run git log -g:
+
+
+
+
$ git log -g master
+commit 734713bc047d87bf7eac9674765ae793478c50d3
+Reflog: master@{0} (Scott Chacon <schacon@gmail.com>)
+Reflog message: commit: Fix refs handling, add gc auto, update tests
+Author: Scott Chacon <schacon@gmail.com>
+Date: Fri Jan 2 18:32:33 2009 -0800
+
+ Fix refs handling, add gc auto, update tests
+
+commit d921970aadf03b3cf0e71becdaab3147ba71cdef
+Reflog: master@{1} (Scott Chacon <schacon@gmail.com>)
+Reflog message: merge phedders/rdocs: Merge made by recursive.
+Author: Scott Chacon <schacon@gmail.com>
+Date: Thu Dec 11 15:08:43 2008 -0800
+
+ Merge commit 'phedders/rdocs'
+
+
+
+
It’s important to note that reflog information is strictly local — it’s a log only of what you’ve done in your repository.
+The references won’t be the same on someone else’s copy of the repository; also, right after you initially clone a repository, you’ll have an empty reflog, as no activity has occurred yet in your repository.
+Running git show HEAD@{2.months.ago} will show you the matching commit only if you cloned the project at least two months ago — if you cloned it any more recently than that, you’ll see only your first local commit.
+
+
+
+
+|
+ نکته
+ |
+
+ Think of the reflog as Git’s version of shell history
+
+ If you have a UNIX or Linux background, you can think of the reflog as Git’s version of shell history, which emphasizes that what’s there is clearly relevant only for you and your “session”, and has nothing to do with anyone else who might be working on the same machine.
+ |
+
+
+
+
+
Ancestry References
+
+
The other main way to specify a commit is via its ancestry.
+If you place a ^ (caret) at the end of a reference, Git resolves it to mean the parent of that commit.
+Suppose you look at the history of your project:
+
+
+
+
$ git log --pretty=format:'%h %s' --graph
+* 734713b Fix refs handling, add gc auto, update tests
+* d921970 Merge commit 'phedders/rdocs'
+|\
+| * 35cfb2b Some rdoc changes
+* | 1c002dd Add some blame and merge stuff
+|/
+* 1c36188 Ignore *.gem
+* 9b29157 Add open3_detach to gemspec file list
+
+
+
+
Then, you can see the previous commit by specifying HEAD^, which means “the parent of HEAD”:
+
+
+
+
$ git show HEAD^
+commit d921970aadf03b3cf0e71becdaab3147ba71cdef
+Merge: 1c002dd... 35cfb2b...
+Author: Scott Chacon <schacon@gmail.com>
+Date: Thu Dec 11 15:08:43 2008 -0800
+
+ Merge commit 'phedders/rdocs'
+
+
+
+
+
+|
+ یادداشت
+ |
+
+ Escaping the caret on Windows
+
+ On Windows in cmd.exe, ^ is a special character and needs to be treated differently.
+You can either double it or put the commit reference in quotes:
+
+
+ $ git show HEAD^ # will NOT work on Windows
+$ git show HEAD^^ # OK
+$ git show "HEAD^" # OK
+
+ |
+
+
+
+
+
You can also specify a number after the ^ to identify which parent you want; for example, d921970^2 means “the second parent of d921970.”
+This syntax is useful only for merge commits, which have more than one parent — the first parent of a merge commit is from the branch you were on when you merged (frequently master), while the second parent of a merge commit is from the branch that was merged (say, topic):
+
+
+
+
$ git show d921970^
+commit 1c002dd4b536e7479fe34593e72e6c6c1819e53b
+Author: Scott Chacon <schacon@gmail.com>
+Date: Thu Dec 11 14:58:32 2008 -0800
+
+ Add some blame and merge stuff
+
+$ git show d921970^2
+commit 35cfb2b795a55793d7cc56a6cc2060b4bb732548
+Author: Paul Hedderly <paul+git@mjr.org>
+Date: Wed Dec 10 22:22:03 2008 +0000
+
+ Some rdoc changes
+
+
+
+
The other main ancestry specification is the ~ (tilde).
+This also refers to the first parent, so HEAD~ and HEAD^ are equivalent.
+The difference becomes apparent when you specify a number.
+HEAD~2 means “the first parent of the first parent,” or “the grandparent” — it traverses the first parents the number of times you specify.
+For example, in the history listed earlier, HEAD~3 would be
+
+
+
+
$ git show HEAD~3
+commit 1c3618887afb5fbcbea25b7c013f4e2114448b8d
+Author: Tom Preston-Werner <tom@mojombo.com>
+Date: Fri Nov 7 13:47:59 2008 -0500
+
+ Ignore *.gem
+
+
+
+
This can also be written HEAD~~~, which again is the first parent of the first parent of the first parent:
+
+
+
+
$ git show HEAD~~~
+commit 1c3618887afb5fbcbea25b7c013f4e2114448b8d
+Author: Tom Preston-Werner <tom@mojombo.com>
+Date: Fri Nov 7 13:47:59 2008 -0500
+
+ Ignore *.gem
+
+
+
+
You can also combine these syntaxes — you can get the second parent of the previous reference (assuming it was a merge commit) by using HEAD~3^2, and so on.
+
+
+
Commit Ranges
+
+
Now that you can specify individual commits, let’s see how to specify ranges of commits.
+This is particularly useful for managing your branches — if you have a lot of branches, you can use range specifications to answer questions such as, “What work is on this branch that I haven’t yet merged into my main branch?”
+
+
+
Double Dot
+
+
The most common range specification is the double-dot syntax.
+This basically asks Git to resolve a range of commits that are reachable from one commit but aren’t reachable from another.
+For example, say you have a commit history that looks like Example history for range selection..
+
+
+
+
}}" alt="Example history for range selection.">
+
+
نمودار 137. Example history for range selection.
+
+
+
Say you want to see what is in your experiment branch that hasn’t yet been merged into your master branch.
+You can ask Git to show you a log of just those commits with master..experiment — that means “all commits reachable from experiment that aren’t reachable from master.”
+For the sake of brevity and clarity in these examples, the letters of the commit objects from the diagram are used in place of the actual log output in the order that they would display:
+
+
+
+
$ git log master..experiment
+D
+C
+
+
+
+
If, on the other hand, you want to see the opposite — all commits in master that aren’t in experiment — you can reverse the branch names.
+experiment..master shows you everything in master not reachable from experiment:
+
+
+
+
$ git log experiment..master
+F
+E
+
+
+
+
This is useful if you want to keep the experiment branch up to date and preview what you’re about to merge.
+Another frequent use of this syntax is to see what you’re about to push to a remote:
+
+
+
+
$ git log origin/master..HEAD
+
+
+
+
This command shows you any commits in your current branch that aren’t in the master branch on your origin remote.
+If you run a git push and your current branch is tracking origin/master, the commits listed by git log origin/master..HEAD are the commits that will be transferred to the server.
+You can also leave off one side of the syntax to have Git assume HEAD.
+For example, you can get the same results as in the previous example by typing git log origin/master.. — Git substitutes HEAD if one side is missing.
+
+
+
+
Multiple Points
+
+
The double-dot syntax is useful as a shorthand, but perhaps you want to specify more than two branches to indicate your revision, such as seeing what commits are in any of several branches that aren’t in the branch you’re currently on.
+Git allows you to do this by using either the ^ character or --not before any reference from which you don’t want to see reachable commits.
+Thus, the following three commands are equivalent:
+
+
+
+
$ git log refA..refB
+$ git log ^refA refB
+$ git log refB --not refA
+
+
+
+
This is nice because with this syntax you can specify more than two references in your query, which you cannot do with the double-dot syntax.
+For instance, if you want to see all commits that are reachable from refA or refB but not from refC, you can use either of:
+
+
+
+
$ git log refA refB ^refC
+$ git log refA refB --not refC
+
+
+
+
This makes for a very powerful revision query system that should help you figure out what is in your branches.
+
+
+
+
Triple Dot
+
+
The last major range-selection syntax is the triple-dot syntax, which specifies all the commits that are reachable by either of two references but not by both of them.
+Look back at the example commit history in Example history for range selection..
+If you want to see what is in master or experiment but not any common references, you can run:
+
+
+
+
$ git log master...experiment
+F
+E
+D
+C
+
+
+
+
Again, this gives you normal log output but shows you only the commit information for those four commits, appearing in the traditional commit date ordering.
+
+
+
A common switch to use with the log command in this case is --left-right, which shows you which side of the range each commit is in.
+This helps make the output more useful:
+
+
+
+
$ git log --left-right master...experiment
+< F
+< E
+> D
+> C
+
+
+
+
With these tools, you can much more easily let Git know what commit or commits you want to inspect.
+
+
+
Rewriting History
+
+
Many times, when working with Git, you may want to revise your local commit history.
+One of the great things about Git is that it allows you to make decisions at the last possible moment.
+You can decide what files go into which commits right before you commit with the staging area, you can decide that you didn’t mean to be working on something yet with git stash, and you can rewrite commits that already happened so they look like they happened in a different way.
+This can involve changing the order of the commits, changing messages or modifying files in a commit, squashing together or splitting apart commits, or removing commits entirely — all before you share your work with others.
+
+
In this section, you’ll see how to accomplish these tasks so that you can make your commit history look the way you want before you share it with others.
+
+
+
+|
+ یادداشت
+ |
+
+ Don’t push your work until you’re happy with it
+
+ One of the cardinal rules of Git is that, since so much work is local within your clone, you have a great deal of freedom to rewrite your history locally.
+However, once you push your work, it is a different story entirely, and you should consider pushed work as final unless you have good reason to change it.
+In short, you should avoid pushing your work until you’re happy with it and ready to share it with the rest of the world.
+ |
+
+
+
+
Changing the Last Commit
+
+
Changing your most recent commit is probably the most common rewriting of history that you’ll do.
+You’ll often want to do two basic things to your last commit: simply change the commit message, or change the actual content of the commit by adding, removing and modifying files.
+
+
+
If you simply want to modify your last commit message, that’s easy:
+
+
+
+
The command above loads the previous commit message into an editor session, where you can make changes to the message, save those changes and exit.
+When you save and close the editor, the editor writes a new commit containing that updated commit message and makes it your new last commit.
+
+
+
If, on the other hand, you want to change the actual content of your last commit, the process works basically the same way — first make the changes you think you forgot, stage those changes, and the subsequent git commit --amend replaces that last commit with your new, improved commit.
+
+
+
You need to be careful with this technique because amending changes the SHA-1 of the commit.
+It’s like a very small rebase — don’t amend your last commit if you’ve already pushed it.
+
+
+
+
+|
+ نکته
+ |
+
+ An amended commit may (or may not) need an amended commit message
+
+ When you amend a commit, you have the opportunity to change both the commit message and the content of the commit.
+If you amend the content of the commit substantially, you should almost certainly update the commit message to reflect that amended content.
+
+ On the other hand, if your amendments are suitably trivial (fixing a silly typo or adding a file you forgot to stage) such that the earlier commit message is just fine, you can simply make the changes, stage them, and avoid the unnecessary editor session entirely with:
+
+
+ $ git commit --amend --no-edit
+
+ |
+
+
+
+
+
Changing Multiple Commit Messages
+
+
To modify a commit that is farther back in your history, you must move to more complex tools.
+Git doesn’t have a modify-history tool, but you can use the rebase tool to rebase a series of commits onto the HEAD they were originally based on instead of moving them to another one.
+With the interactive rebase tool, you can then stop after each commit you want to modify and change the message, add files, or do whatever you wish.
+You can run rebase interactively by adding the -i option to git rebase.
+You must indicate how far back you want to rewrite commits by telling the command which commit to rebase onto.
+
+
+
For example, if you want to change the last three commit messages, or any of the commit messages in that group, you supply as an argument to git rebase -i the parent of the last commit you want to edit, which is HEAD~2^ or HEAD~3.
+It may be easier to remember the ~3 because you’re trying to edit the last three commits, but keep in mind that you’re actually designating four commits ago, the parent of the last commit you want to edit:
+
+
+
+
$ git rebase -i HEAD~3
+
+
+
+
Remember again that this is a rebasing command — every commit in the range HEAD~3..HEAD with a changed message and all of its descendants will be rewritten.
+Don’t include any commit you’ve already pushed to a central server — doing so will confuse other developers by providing an alternate version of the same change.
+
+
+
Running this command gives you a list of commits in your text editor that looks something like this:
+
+
+
+
pick f7f3f6d Change my name a bit
+pick 310154e Update README formatting and add blame
+pick a5f4a0d Add cat-file
+
+# Rebase 710f0f8..a5f4a0d onto 710f0f8
+#
+# Commands:
+# p, pick <commit> = use commit
+# r, reword <commit> = use commit, but edit the commit message
+# e, edit <commit> = use commit, but stop for amending
+# s, squash <commit> = use commit, but meld into previous commit
+# f, fixup <commit> = like "squash", but discard this commit's log message
+# x, exec <command> = run command (the rest of the line) using shell
+# b, break = stop here (continue rebase later with 'git rebase --continue')
+# d, drop <commit> = remove commit
+# l, label <label> = label current HEAD with a name
+# t, reset <label> = reset HEAD to a label
+# m, merge [-C <commit> | -c <commit>] <label> [# <oneline>]
+# . create a merge commit using the original merge commit's
+# . message (or the oneline, if no original merge commit was
+# . specified). Use -c <commit> to reword the commit message.
+#
+# These lines can be re-ordered; they are executed from top to bottom.
+#
+# If you remove a line here THAT COMMIT WILL BE LOST.
+#
+# However, if you remove everything, the rebase will be aborted.
+#
+# Note that empty commits are commented out
+
+
+
+
It’s important to note that these commits are listed in the opposite order than you normally see them using the log command.
+If you run a log, you see something like this:
+
+
+
+
$ git log --pretty=format:"%h %s" HEAD~3..HEAD
+a5f4a0d Add cat-file
+310154e Update README formatting and add blame
+f7f3f6d Change my name a bit
+
+
+
+
Notice the reverse order.
+The interactive rebase gives you a script that it’s going to run.
+It will start at the commit you specify on the command line (HEAD~3) and replay the changes introduced in each of these commits from top to bottom.
+It lists the oldest at the top, rather than the newest, because that’s the first one it will replay.
+
+
+
You need to edit the script so that it stops at the commit you want to edit.
+To do so, change the word ‘pick’ to the word ‘edit’ for each of the commits you want the script to stop after.
+For example, to modify only the third commit message, you change the file to look like this:
+
+
+
+
edit f7f3f6d Change my name a bit
+pick 310154e Update README formatting and add blame
+pick a5f4a0d Add cat-file
+
+
+
+
When you save and exit the editor, Git rewinds you back to the last commit in that list and drops you on the command line with the following message:
+
+
+
+
$ git rebase -i HEAD~3
+Stopped at f7f3f6d... changed my name a bit
+You can amend the commit now, with
+
+ git commit --amend
+
+Once you're satisfied with your changes, run
+
+ git rebase --continue
+
+
+
+
These instructions tell you exactly what to do.
+Type
+
+
+
+
Change the commit message, and exit the editor.
+Then, run
+
+
+
+
$ git rebase --continue
+
+
+
+
This command will apply the other two commits automatically, and then you’re done.
+If you change pick to edit on more lines, you can repeat these steps for each commit you change to edit.
+Each time, Git will stop, let you amend the commit, and continue when you’re finished.
+
+
+
Reordering Commits
+
+
You can also use interactive rebases to reorder or remove commits entirely.
+If you want to remove the “added cat-file” commit and change the order in which the other two commits are introduced, you can change the rebase script from this
+
+
+
+
pick f7f3f6d Change my name a bit
+pick 310154e Update README formatting and add blame
+pick a5f4a0d Add cat-file
+
+
+
+
+
+
pick 310154e Update README formatting and add blame
+pick f7f3f6d Change my name a bit
+
+
+
+
When you save and exit the editor, Git rewinds your branch to the parent of these commits, applies 310154e and then f7f3f6d, and then stops.
+You effectively change the order of those commits and remove the “added cat-file” commit completely.
+
+
+
Squashing Commits
+
+
It’s also possible to take a series of commits and squash them down into a single commit with the interactive rebasing tool.
+The script puts helpful instructions in the rebase message:
+
+
+
+
#
+# Commands:
+# p, pick <commit> = use commit
+# r, reword <commit> = use commit, but edit the commit message
+# e, edit <commit> = use commit, but stop for amending
+# s, squash <commit> = use commit, but meld into previous commit
+# f, fixup <commit> = like "squash", but discard this commit's log message
+# x, exec <command> = run command (the rest of the line) using shell
+# b, break = stop here (continue rebase later with 'git rebase --continue')
+# d, drop <commit> = remove commit
+# l, label <label> = label current HEAD with a name
+# t, reset <label> = reset HEAD to a label
+# m, merge [-C <commit> | -c <commit>] <label> [# <oneline>]
+# . create a merge commit using the original merge commit's
+# . message (or the oneline, if no original merge commit was
+# . specified). Use -c <commit> to reword the commit message.
+#
+# These lines can be re-ordered; they are executed from top to bottom.
+#
+# If you remove a line here THAT COMMIT WILL BE LOST.
+#
+# However, if you remove everything, the rebase will be aborted.
+#
+# Note that empty commits are commented out
+
+
+
+
If, instead of “pick” or “edit”, you specify “squash”, Git applies both that change and the change directly before it and makes you merge the commit messages together.
+So, if you want to make a single commit from these three commits, you make the script look like this:
+
+
+
+
pick f7f3f6d Change my name a bit
+squash 310154e Update README formatting and add blame
+squash a5f4a0d Add cat-file
+
+
+
+
When you save and exit the editor, Git applies all three changes and then puts you back into the editor to merge the three commit messages:
+
+
+
+
# This is a combination of 3 commits.
+# The first commit's message is:
+Change my name a bit
+
+# This is the 2nd commit message:
+
+Update README formatting and add blame
+
+# This is the 3rd commit message:
+
+Add cat-file
+
+
+
+
When you save that, you have a single commit that introduces the changes of all three previous commits.
+
+
+
Splitting a Commit
+
+
Splitting a commit undoes a commit and then partially stages and commits as many times as commits you want to end up with.
+For example, suppose you want to split the middle commit of your three commits.
+Instead of “Update README formatting and add blame”, you want to split it into two commits: “Update README formatting” for the first, and “Add blame” for the second.
+You can do that in the rebase -i script by changing the instruction on the commit you want to split to “edit”:
+
+
+
+
pick f7f3f6d Change my name a bit
+edit 310154e Update README formatting and add blame
+pick a5f4a0d Add cat-file
+
+
+
+
Then, when the script drops you to the command line, you reset that commit, take the changes that have been reset, and create multiple commits out of them.
+When you save and exit the editor, Git rewinds to the parent of the first commit in your list, applies the first commit (f7f3f6d), applies the second (310154e), and drops you to the console.
+There, you can do a mixed reset of that commit with git reset HEAD^, which effectively undoes that commit and leaves the modified files unstaged.
+Now you can stage and commit files until you have several commits, and run git rebase --continue when you’re done:
+
+
+
+
$ git reset HEAD^
+$ git add README
+$ git commit -m 'Update README formatting'
+$ git add lib/simplegit.rb
+$ git commit -m 'Add blame'
+$ git rebase --continue
+
+
+
+
Git applies the last commit (a5f4a0d) in the script, and your history looks like this:
+
+
+
+
$ git log -4 --pretty=format:"%h %s"
+1c002dd Add cat-file
+9b29157 Add blame
+35cfb2b Update README formatting
+f3cc40e Change my name a bit
+
+
+
+
Once again, this changes the SHA-1s of all the commits in your list, so make sure no commit shows up in that list that you’ve already pushed to a shared repository.
+
+
+
The Nuclear Option: filter-branch
+
+
There is another history-rewriting option that you can use if you need to rewrite a larger number of commits in some scriptable way — for instance, changing your email address globally or removing a file from every commit.
+The command is filter-branch, and it can rewrite huge swaths of your history, so you probably shouldn’t use it unless your project isn’t yet public and other people haven’t based work off the commits you’re about to rewrite.
+However, it can be very useful.
+You’ll learn a few of the common uses so you can get an idea of some of the things it’s capable of.
+
+
+
+
+|
+ گوشزد
+ |
+
+
+ git filter-branch has many pitfalls, and is no longer the recommended way to rewrite history.
+Instead, consider using git-filter-repo, which is a Python script that does a better job for most applications where you would normally turn to filter-branch.
+Its documentation and source code can be found at https://github.com/newren/git-filter-repo.
+ |
+
+
+
+
+
Removing a File from Every Commit
+
+
This occurs fairly commonly.
+Someone accidentally commits a huge binary file with a thoughtless git add ., and you want to remove it everywhere.
+Perhaps you accidentally committed a file that contained a password, and you want to make your project open source.
+filter-branch is the tool you probably want to use to scrub your entire history.
+To remove a file named passwords.txt from your entire history, you can use the --tree-filter option to filter-branch:
+
+
+
+
$ git filter-branch --tree-filter 'rm -f passwords.txt' HEAD
+Rewrite 6b9b3cf04e7c5686a9cb838c3f36a8cb6a0fc2bd (21/21)
+Ref 'refs/heads/master' was rewritten
+
+
+
+
The --tree-filter option runs the specified command after each checkout of the project and then recommits the results.
+In this case, you remove a file called passwords.txt from every snapshot, whether it exists or not.
+If you want to remove all accidentally committed editor backup files, you can run something like git filter-branch --tree-filter 'rm -f *~' HEAD.
+
+
+
You’ll be able to watch Git rewriting trees and commits and then move the branch pointer at the end.
+It’s generally a good idea to do this in a testing branch and then hard-reset your master branch after you’ve determined the outcome is what you really want.
+To run filter-branch on all your branches, you can pass --all to the command.
+
+
+
+
Making a Subdirectory the New Root
+
+
Suppose you’ve done an import from another source control system and have subdirectories that make no sense (trunk, tags, and so on).
+If you want to make the trunk subdirectory be the new project root for every commit, filter-branch can help you do that, too:
+
+
+
+
$ git filter-branch --subdirectory-filter trunk HEAD
+Rewrite 856f0bf61e41a27326cdae8f09fe708d679f596f (12/12)
+Ref 'refs/heads/master' was rewritten
+
+
+
+
Now your new project root is what was in the trunk subdirectory each time.
+Git will also automatically remove commits that did not affect the subdirectory.
+
+
+
+
Changing Email Addresses Globally
+
+
Another common case is that you forgot to run git config to set your name and email address before you started working, or perhaps you want to open-source a project at work and change all your work email addresses to your personal address.
+In any case, you can change email addresses in multiple commits in a batch with filter-branch as well.
+You need to be careful to change only the email addresses that are yours, so you use --commit-filter:
+
+
+
+
$ git filter-branch --commit-filter '
+ if [ "$GIT_AUTHOR_EMAIL" = "schacon@localhost" ];
+ then
+ GIT_AUTHOR_NAME="Scott Chacon";
+ GIT_AUTHOR_EMAIL="schacon@example.com";
+ git commit-tree "$@";
+ else
+ git commit-tree "$@";
+ fi' HEAD
+
+
+
+
This goes through and rewrites every commit to have your new address.
+Because commits contain the SHA-1 values of their parents, this command changes every commit SHA-1 in your history, not just those that have the matching email address.
+
+
+
Searching
+
+
With just about any size codebase, you’ll often need to find where a function is called or defined, or display the history of a method.
+Git provides a couple of useful tools for looking through the code and commits stored in its database quickly and easily.
+We’ll go through a few of them.
+
+
Git Grep
+
+
Git ships with a command called grep that allows you to easily search through any committed tree, the working directory, or even the index for a string or regular expression.
+For the examples that follow, we’ll search through the source code for Git itself.
+
+
+
By default, git grep will look through the files in your working directory.
+As a first variation, you can use either of the -n or --line-number options to print out the line numbers where Git has found matches:
+
+
+
+
$ git grep -n gmtime_r
+compat/gmtime.c:3:#undef gmtime_r
+compat/gmtime.c:8: return git_gmtime_r(timep, &result);
+compat/gmtime.c:11:struct tm *git_gmtime_r(const time_t *timep, struct tm *result)
+compat/gmtime.c:16: ret = gmtime_r(timep, result);
+compat/mingw.c:826:struct tm *gmtime_r(const time_t *timep, struct tm *result)
+compat/mingw.h:206:struct tm *gmtime_r(const time_t *timep, struct tm *result);
+date.c:482: if (gmtime_r(&now, &now_tm))
+date.c:545: if (gmtime_r(&time, tm)) {
+date.c:758: /* gmtime_r() in match_digit() may have clobbered it */
+git-compat-util.h:1138:struct tm *git_gmtime_r(const time_t *, struct tm *);
+git-compat-util.h:1140:#define gmtime_r git_gmtime_r
+
+
+
+
In addition to the basic search shown above, git grep supports a plethora of other interesting options.
+
+
+
For instance, instead of printing all of the matches, you can ask git grep to summarize the output by showing you only which files contained the search string and how many matches there were in each file with the -c or --count option:
+
+
+
+
$ git grep --count gmtime_r
+compat/gmtime.c:4
+compat/mingw.c:1
+compat/mingw.h:1
+date.c:3
+git-compat-util.h:2
+
+
+
+
If you’re interested in the context of a search string, you can display the enclosing method or function for each matching string with either of the -p or --show-function options:
+
+
+
+
$ git grep -p gmtime_r *.c
+date.c=static int match_multi_number(timestamp_t num, char c, const char *date,
+date.c: if (gmtime_r(&now, &now_tm))
+date.c=static int match_digit(const char *date, struct tm *tm, int *offset, int *tm_gmt)
+date.c: if (gmtime_r(&time, tm)) {
+date.c=int parse_date_basic(const char *date, timestamp_t *timestamp, int *offset)
+date.c: /* gmtime_r() in match_digit() may have clobbered it */
+
+
+
+
As you can see, the gmtime_r routine is called from both the match_multi_number and match_digit functions in the date.c file (the third match displayed represents just the string appearing in a comment).
+
+
+
You can also search for complex combinations of strings with the --and flag, which ensures that multiple matches must occur in the same line of text.
+For instance, let’s look for any lines that define a constant whose name contains either of the substrings “LINK” or “BUF_MAX”, specifically in an older version of the Git codebase represented by the tag v1.8.0 (we’ll throw in the --break and --heading options which help split up the output into a more readable format):
+
+
+
+
$ git grep --break --heading \
+ -n -e '#define' --and \( -e LINK -e BUF_MAX \) v1.8.0
+v1.8.0:builtin/index-pack.c
+62:#define FLAG_LINK (1u<<20)
+
+v1.8.0:cache.h
+73:#define S_IFGITLINK 0160000
+74:#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
+
+v1.8.0:environment.c
+54:#define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
+
+v1.8.0:strbuf.c
+326:#define STRBUF_MAXLINK (2*PATH_MAX)
+
+v1.8.0:symlinks.c
+53:#define FL_SYMLINK (1 << 2)
+
+v1.8.0:zlib.c
+30:/* #define ZLIB_BUF_MAX ((uInt)-1) */
+31:#define ZLIB_BUF_MAX ((uInt) 1024 * 1024 * 1024) /* 1GB */
+
+
+
+
The git grep command has a few advantages over normal searching commands like grep and ack.
+The first is that it’s really fast, the second is that you can search through any tree in Git, not just the working directory.
+As we saw in the above example, we looked for terms in an older version of the Git source code, not the version that was currently checked out.
+
+
+
Git Log Searching
+
+
Perhaps you’re looking not for where a term exists, but when it existed or was introduced.
+The git log command has a number of powerful tools for finding specific commits by the content of their messages or even the content of the diff they introduce.
+
+
+
If, for example, we want to find out when the ZLIB_BUF_MAX constant was originally introduced, we can use the -S option (colloquially referred to as the Git “pickaxe” option) to tell Git to show us only those commits that changed the number of occurrences of that string.
+
+
+
+
$ git log -S ZLIB_BUF_MAX --oneline
+e01503b zlib: allow feeding more than 4GB in one go
+ef49a7a zlib: zlib can only process 4GB at a time
+
+
+
+
If we look at the diff of those commits, we can see that in ef49a7a the constant was introduced and in e01503b it was modified.
+
+
+
If you need to be more specific, you can provide a regular expression to search for with the -G option.
+
+
+
Line Log Search
+
+
Another fairly advanced log search that is insanely useful is the line history search.
+Simply run git log with the -L option, and it will show you the history of a function or line of code in your codebase.
+
+
+
For example, if we wanted to see every change made to the function git_deflate_bound in the zlib.c file, we could run git log -L :git_deflate_bound:zlib.c.
+This will try to figure out what the bounds of that function are and then look through the history and show us every change that was made to the function as a series of patches back to when the function was first created.
+
+
+
+
$ git log -L :git_deflate_bound:zlib.c
+commit ef49a7a0126d64359c974b4b3b71d7ad42ee3bca
+Author: Junio C Hamano <gitster@pobox.com>
+Date: Fri Jun 10 11:52:15 2011 -0700
+
+ zlib: zlib can only process 4GB at a time
+
+diff --git a/zlib.c b/zlib.c
+--- a/zlib.c
++++ b/zlib.c
+@@ -85,5 +130,5 @@
+-unsigned long git_deflate_bound(z_streamp strm, unsigned long size)
++unsigned long git_deflate_bound(git_zstream *strm, unsigned long size)
+ {
+- return deflateBound(strm, size);
++ return deflateBound(&strm->z, size);
+ }
+
+
+commit 225a6f1068f71723a910e8565db4e252b3ca21fa
+Author: Junio C Hamano <gitster@pobox.com>
+Date: Fri Jun 10 11:18:17 2011 -0700
+
+ zlib: wrap deflateBound() too
+
+diff --git a/zlib.c b/zlib.c
+--- a/zlib.c
++++ b/zlib.c
+@@ -81,0 +85,5 @@
++unsigned long git_deflate_bound(z_streamp strm, unsigned long size)
++{
++ return deflateBound(strm, size);
++}
++
+
+
+
+
If Git can’t figure out how to match a function or method in your programming language, you can also provide it with a regular expression (or regex).
+For example, this would have done the same thing as the example above: git log -L '/unsigned long git_deflate_bound/',/^}/:zlib.c.
+You could also give it a range of lines or a single line number and you’ll get the same sort of output.
+
+
+
Signing Your Work
+
+
Git is cryptographically secure, but it’s not foolproof.
+If you’re taking work from others on the internet and want to verify that commits are actually from a trusted source, Git has a few ways to sign and verify work using GPG.
+
+
GPG Introduction
+
+
First of all, if you want to sign anything you need to get GPG configured and your personal key installed.
+
+
+
+
$ gpg --list-keys
+/Users/schacon/.gnupg/pubring.gpg
+---------------------------------
+pub 2048R/0A46826A 2014-06-04
+uid Scott Chacon (Git signing key) <schacon@gmail.com>
+sub 2048R/874529A9 2014-06-04
+
+
+
+
If you don’t have a key installed, you can generate one with gpg --gen-key.
+
+
+
+
Once you have a private key to sign with, you can configure Git to use it for signing things by setting the user.signingkey config setting.
+
+
+
+
$ git config --global user.signingkey 0A46826A
+
+
+
+
Now Git will use your key by default to sign tags and commits if you want.
+
+
+
+
+
If you have a GPG private key setup, you can now use it to sign new tags.
+All you have to do is use -s instead of -a:
+
+
+
+
$ git tag -s v1.5 -m 'my signed 1.5 tag'
+
+You need a passphrase to unlock the secret key for
+user: "Ben Straub <ben@straub.cc>"
+2048-bit RSA key, ID 800430EB, created 2014-05-04
+
+
+
+
If you run git show on that tag, you can see your GPG signature attached to it:
+
+
+
+
$ git show v1.5
+tag v1.5
+Tagger: Ben Straub <ben@straub.cc>
+Date: Sat May 3 20:29:41 2014 -0700
+
+my signed 1.5 tag
+-----BEGIN PGP SIGNATURE-----
+Version: GnuPG v1
+
+iQEcBAABAgAGBQJTZbQlAAoJEF0+sviABDDrZbQH/09PfE51KPVPlanr6q1v4/Ut
+LQxfojUWiLQdg2ESJItkcuweYg+kc3HCyFejeDIBw9dpXt00rY26p05qrpnG+85b
+hM1/PswpPLuBSr+oCIDj5GMC2r2iEKsfv2fJbNW8iWAXVLoWZRF8B0MfqX/YTMbm
+ecorc4iXzQu7tupRihslbNkfvfciMnSDeSvzCpWAHl7h8Wj6hhqePmLm9lAYqnKp
+8S5B/1SSQuEAjRZgI4IexpZoeKGVDptPHxLLS38fozsyi0QyDyzEgJxcJQVMXxVi
+RUysgqjcpT8+iQM1PblGfHR4XAhuOqN5Fx06PSaFZhqvWFezJ28/CLyX5q+oIVk=
+=EFTF
+-----END PGP SIGNATURE-----
+
+commit ca82a6dff817ec66f44342007202690a93763949
+Author: Scott Chacon <schacon@gee-mail.com>
+Date: Mon Mar 17 21:52:11 2008 -0700
+
+ Change version number
+
+
+
+
+
+
To verify a signed tag, you use git tag -v <tag-name>.
+This command uses GPG to verify the signature.
+You need the signer’s public key in your keyring for this to work properly:
+
+
+
+
$ git tag -v v1.4.2.1
+object 883653babd8ee7ea23e6a5c392bb739348b1eb61
+type commit
+tag v1.4.2.1
+tagger Junio C Hamano <junkio@cox.net> 1158138501 -0700
+
+GIT 1.4.2.1
+
+Minor fixes since 1.4.2, including git-mv and git-http with alternates.
+gpg: Signature made Wed Sep 13 02:08:25 2006 PDT using DSA key ID F3119B9A
+gpg: Good signature from "Junio C Hamano <junkio@cox.net>"
+gpg: aka "[jpeg image of size 1513]"
+Primary key fingerprint: 3565 2A26 2040 E066 C9A7 4A7D C0C6 D9A4 F311 9B9A
+
+
+
+
If you don’t have the signer’s public key, you get something like this instead:
+
+
+
+
gpg: Signature made Wed Sep 13 02:08:25 2006 PDT using DSA key ID F3119B9A
+gpg: Can't check signature: public key not found
+error: could not verify the tag 'v1.4.2.1'
+
+
+
+
Signing Commits
+
+
In more recent versions of Git (v1.7.9 and above), you can now also sign individual commits.
+If you’re interested in signing commits directly instead of just the tags, all you need to do is add a -S to your git commit command.
+
+
+
+
$ git commit -a -S -m 'Signed commit'
+
+You need a passphrase to unlock the secret key for
+user: "Scott Chacon (Git signing key) <schacon@gmail.com>"
+2048-bit RSA key, ID 0A46826A, created 2014-06-04
+
+[master 5c3386c] Signed commit
+ 4 files changed, 4 insertions(+), 24 deletions(-)
+ rewrite Rakefile (100%)
+ create mode 100644 lib/git.rb
+
+
+
+
To see and verify these signatures, there is also a --show-signature option to git log.
+
+
+
+
$ git log --show-signature -1
+commit 5c3386cf54bba0a33a32da706aa52bc0155503c2
+gpg: Signature made Wed Jun 4 19:49:17 2014 PDT using RSA key ID 0A46826A
+gpg: Good signature from "Scott Chacon (Git signing key) <schacon@gmail.com>"
+Author: Scott Chacon <schacon@gmail.com>
+Date: Wed Jun 4 19:49:17 2014 -0700
+
+ Signed commit
+
+
+
+
Additionally, you can configure git log to check any signatures it finds and list them in its output with the %G? format.
+
+
+
+
$ git log --pretty="format:%h %G? %aN %s"
+
+5c3386c G Scott Chacon Signed commit
+ca82a6d N Scott Chacon Change the version number
+085bb3b N Scott Chacon Remove unnecessary test code
+a11bef0 N Scott Chacon Initial commit
+
+
+
+
Here we can see that only the latest commit is signed and valid and the previous commits are not.
+
+
+
In Git 1.8.3 and later, git merge and git pull can be told to inspect and reject when merging a commit that does not carry a trusted GPG signature with the --verify-signatures command.
+
+
+
If you use this option when merging a branch and it contains commits that are not signed and valid, the merge will not work.
+
+
+
+
$ git merge --verify-signatures non-verify
+fatal: Commit ab06180 does not have a GPG signature.
+
+
+
+
If the merge contains only valid signed commits, the merge command will show you all the signatures it has checked and then move forward with the merge.
+
+
+
+
$ git merge --verify-signatures signed-branch
+Commit 13ad65e has a good GPG signature by Scott Chacon (Git signing key) <schacon@gmail.com>
+Updating 5c3386c..13ad65e
+Fast-forward
+ README | 2 ++
+ 1 file changed, 2 insertions(+)
+
+
+
+
You can also use the -S option with the git merge command to sign the resulting merge commit itself.
+The following example both verifies that every commit in the branch to be merged is signed and furthermore signs the resulting merge commit.
+
+
+
+
$ git merge --verify-signatures -S signed-branch
+Commit 13ad65e has a good GPG signature by Scott Chacon (Git signing key) <schacon@gmail.com>
+
+You need a passphrase to unlock the secret key for
+user: "Scott Chacon (Git signing key) <schacon@gmail.com>"
+2048-bit RSA key, ID 0A46826A, created 2014-06-04
+
+Merge made by the 'recursive' strategy.
+ README | 2 ++
+ 1 file changed, 2 insertions(+)
+
+
+
+
Everyone Must Sign
+
+
Signing tags and commits is great, but if you decide to use this in your normal workflow, you’ll have to make sure that everyone on your team understands how to do so.
+If you don’t, you’ll end up spending a lot of time helping people figure out how to rewrite their commits with signed versions.
+Make sure you understand GPG and the benefits of signing things before adopting this as part of your standard workflow.
+
+
Stashing and Cleaning
+
+
Often, when you’ve been working on part of your project, things are in a messy state and you want to switch branches for a bit to work on something else.
+The problem is, you don’t want to do a commit of half-done work just so you can get back to this point later.
+The answer to this issue is the git stash command.
+
+
Stashing takes the dirty state of your working directory — that is, your modified tracked files and staged changes — and saves it on a stack of unfinished changes that you can reapply at any time (even on a different branch).
+
+
+
+|
+ یادداشت
+ |
+
+ Migrating to git stash push
+
+
+ As of late October 2017, there has been extensive discussion on the Git mailing list, wherein the command git stash save is being deprecated in favour of the existing alternative git stash push.
+The main reason for this is that git stash push introduces the option of stashing selected pathspecs, something git stash save does not support.
+
+ git stash save is not going away any time soon, so don’t worry about it suddenly disappearing.
+But you might want to start migrating over to the push alternative for the new functionality.
+ |
+
+
+
+
Stashing Your Work
+
+
To demonstrate stashing, you’ll go into your project and start working on a couple of files and possibly stage one of the changes.
+If you run git status, you can see your dirty state:
+
+
+
+
$ git status
+Changes to be committed:
+ (use "git reset HEAD <file>..." to unstage)
+
+ modified: index.html
+
+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: lib/simplegit.rb
+
+
+
+
Now you want to switch branches, but you don’t want to commit what you’ve been working on yet, so you’ll stash the changes.
+To push a new stash onto your stack, run git stash or git stash push:
+
+
+
+
$ git stash
+Saved working directory and index state \
+ "WIP on master: 049d078 Create index file"
+HEAD is now at 049d078 Create index file
+(To restore them type "git stash apply")
+
+
+
+
You can now see that your working directory is clean:
+
+
+
+
$ git status
+# On branch master
+nothing to commit, working directory clean
+
+
+
+
At this point, you can switch branches and do work elsewhere; your changes are stored on your stack.
+To see which stashes you’ve stored, you can use git stash list:
+
+
+
+
$ git stash list
+stash@{0}: WIP on master: 049d078 Create index file
+stash@{1}: WIP on master: c264051 Revert "Add file_size"
+stash@{2}: WIP on master: 21d80a5 Add number to log
+
+
+
+
In this case, two stashes were saved previously, so you have access to three different stashed works.
+You can reapply the one you just stashed by using the command shown in the help output of the original stash command: git stash apply.
+If you want to apply one of the older stashes, you can specify it by naming it, like this: git stash apply stash@{2}.
+If you don’t specify a stash, Git assumes the most recent stash and tries to apply it:
+
+
+
+
$ git stash apply
+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: index.html
+ modified: lib/simplegit.rb
+
+no changes added to commit (use "git add" and/or "git commit -a")
+
+
+
+
You can see that Git re-modifies the files you reverted when you saved the stash.
+In this case, you had a clean working directory when you tried to apply the stash, and you tried to apply it on the same branch you saved it from.
+Having a clean working directory and applying it on the same branch aren’t necessary to successfully apply a stash.
+You can save a stash on one branch, switch to another branch later, and try to reapply the changes.
+You can also have modified and uncommitted files in your working directory when you apply a stash — Git gives you merge conflicts if anything no longer applies cleanly.
+
+
+
The changes to your files were reapplied, but the file you staged before wasn’t restaged.
+To do that, you must run the git stash apply command with a --index option to tell the command to try to reapply the staged changes.
+If you had run that instead, you’d have gotten back to your original position:
+
+
+
+
$ git stash apply --index
+On branch master
+Changes to be committed:
+ (use "git reset HEAD <file>..." to unstage)
+
+ modified: index.html
+
+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: lib/simplegit.rb
+
+
+
+
The apply option only tries to apply the stashed work — you continue to have it on your stack.
+To remove it, you can run git stash drop with the name of the stash to remove:
+
+
+
+
$ git stash list
+stash@{0}: WIP on master: 049d078 Create index file
+stash@{1}: WIP on master: c264051 Revert "Add file_size"
+stash@{2}: WIP on master: 21d80a5 Add number to log
+$ git stash drop stash@{0}
+Dropped stash@{0} (364e91f3f268f0900bc3ee613f9f733e82aaed43)
+
+
+
+
You can also run git stash pop to apply the stash and then immediately drop it from your stack.
+
+
+
Creative Stashing
+
+
There are a few stash variants that may also be helpful.
+The first option that is quite popular is the --keep-index option to the git stash command.
+This tells Git to not only include all staged content in the stash being created, but simultaneously leave it in the index.
+
+
+
+
$ git status -s
+M index.html
+ M lib/simplegit.rb
+
+$ git stash --keep-index
+Saved working directory and index state WIP on master: 1b65b17 added the index file
+HEAD is now at 1b65b17 added the index file
+
+$ git status -s
+M index.html
+
+
+
+
Another common thing you may want to do with stash is to stash the untracked files as well as the tracked ones.
+By default, git stash will stash only modified and staged tracked files.
+If you specify --include-untracked or -u, Git will include untracked files in the stash being created.
+However, including untracked files in the stash will still not include explicitly ignored files; to additionally include ignored files, use --all (or just -a).
+
+
+
+
$ git status -s
+M index.html
+ M lib/simplegit.rb
+?? new-file.txt
+
+$ git stash -u
+Saved working directory and index state WIP on master: 1b65b17 added the index file
+HEAD is now at 1b65b17 added the index file
+
+$ git status -s
+$
+
+
+
+
Finally, if you specify the --patch flag, Git will not stash everything that is modified but will instead prompt you interactively which of the changes you would like to stash and which you would like to keep in your working directory.
+
+
+
+
$ git stash --patch
+diff --git a/lib/simplegit.rb b/lib/simplegit.rb
+index 66d332e..8bb5674 100644
+--- a/lib/simplegit.rb
++++ b/lib/simplegit.rb
+@@ -16,6 +16,10 @@ class SimpleGit
+ return `#{git_cmd} 2>&1`.chomp
+ end
+ end
++
++ def show(treeish = 'master')
++ command("git show #{treeish}")
++ end
+
+ end
+ test
+Stash this hunk [y,n,q,a,d,/,e,?]? y
+
+Saved working directory and index state WIP on master: 1b65b17 added the index file
+
+
+
+
Creating a Branch from a Stash
+
+
If you stash some work, leave it there for a while, and continue on the branch from which you stashed the work, you may have a problem reapplying the work.
+If the apply tries to modify a file that you’ve since modified, you’ll get a merge conflict and will have to try to resolve it.
+If you want an easier way to test the stashed changes again, you can run git stash branch <new branchname>, which creates a new branch for you with your selected branch name, checks out the commit you were on when you stashed your work, reapplies your work there, and then drops the stash if it applies successfully:
+
+
+
+
$ git stash branch testchanges
+M index.html
+M lib/simplegit.rb
+Switched to a new branch 'testchanges'
+On branch testchanges
+Changes to be committed:
+ (use "git reset HEAD <file>..." to unstage)
+
+ modified: index.html
+
+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: lib/simplegit.rb
+
+Dropped refs/stash@{0} (29d385a81d163dfd45a452a2ce816487a6b8b014)
+
+
+
+
This is a nice shortcut to recover stashed work easily and work on it in a new branch.
+
+
+
Cleaning your Working Directory
+
+
Finally, you may not want to stash some work or files in your working directory, but simply get rid of them; that’s what the git clean command is for.
+
+
+
Some common reasons for cleaning your working directory might be to remove cruft that has been generated by merges or external tools or to remove build artifacts in order to run a clean build.
+
+
+
You’ll want to be pretty careful with this command, since it’s designed to remove files from your working directory that are not tracked.
+If you change your mind, there is often no retrieving the content of those files.
+A safer option is to run git stash --all to remove everything but save it in a stash.
+
+
+
Assuming you do want to remove cruft files or clean your working directory, you can do so with git clean.
+To remove all the untracked files in your working directory, you can run git clean -f -d, which removes any files and also any subdirectories that become empty as a result.
+The -f means force or “really do this,” and is required if the Git configuration variable clean.requireForce is not explicitly set to false.
+
+
+
If you ever want to see what it would do, you can run the command with the --dry-run (or -n) option, which means “do a dry run and tell me what you would have removed”.
+
+
+
+
$ git clean -d -n
+Would remove test.o
+Would remove tmp/
+
+
+
+
By default, the git clean command will only remove untracked files that are not ignored.
+Any file that matches a pattern in your .gitignore or other ignore files will not be removed.
+If you want to remove those files too, such as to remove all .o files generated from a build so you can do a fully clean build, you can add a -x to the clean command.
+
+
+
+
$ git status -s
+ M lib/simplegit.rb
+?? build.TMP
+?? tmp/
+
+$ git clean -n -d
+Would remove build.TMP
+Would remove tmp/
+
+$ git clean -n -d -x
+Would remove build.TMP
+Would remove test.o
+Would remove tmp/
+
+
+
+
If you don’t know what the git clean command is going to do, always run it with a -n first to double check before changing the -n to a -f and doing it for real.
+The other way you can be careful about the process is to run it with the -i or “interactive” flag.
+
+
+
This will run the clean command in an interactive mode.
+
+
+
+
$ git clean -x -i
+Would remove the following items:
+ build.TMP test.o
+*** Commands ***
+ 1: clean 2: filter by pattern 3: select by numbers 4: ask each 5: quit
+ 6: help
+What now>
+
+
+
+
This way you can step through each file individually or specify patterns for deletion interactively.
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ There is a quirky situation where you might need to be extra forceful in asking Git to clean your working directory.
+If you happen to be in a working directory under which you’ve copied or cloned other Git repositories (perhaps as submodules), even git clean -fd will refuse to delete those directories.
+In cases like that, you need to add a second -f option for emphasis.
+ |
+
+
+
+
Submodules
+
+
It often happens that while working on one project, you need to use another project from within it.
+Perhaps it’s a library that a third party developed or that you’re developing separately and using in multiple parent projects.
+A common issue arises in these scenarios: you want to be able to treat the two projects as separate yet still be able to use one from within the other.
+
+
Here’s an example.
+Suppose you’re developing a website and creating Atom feeds.
+Instead of writing your own Atom-generating code, you decide to use a library.
+You’re likely to have to either include this code from a shared library like a CPAN install or Ruby gem, or copy the source code into your own project tree.
+The issue with including the library is that it’s difficult to customize the library in any way and often more difficult to deploy it, because you need to make sure every client has that library available.
+The issue with copying the code into your own project is that any custom changes you make are difficult to merge when upstream changes become available.
+
+
Git addresses this issue using submodules.
+Submodules allow you to keep a Git repository as a subdirectory of another Git repository.
+This lets you clone another repository into your project and keep your commits separate.
+
+
Starting with Submodules
+
+
We’ll walk through developing a simple project that has been split up into a main project and a few sub-projects.
+
+
+
Let’s start by adding an existing Git repository as a submodule of the repository that we’re working on.
+To add a new submodule you use the git submodule add command with the absolute or relative URL of the project you would like to start tracking.
+In this example, we’ll add a library called “DbConnector”.
+
+
+
+
$ git submodule add https://github.com/chaconinc/DbConnector
+Cloning into 'DbConnector'...
+remote: Counting objects: 11, done.
+remote: Compressing objects: 100% (10/10), done.
+remote: Total 11 (delta 0), reused 11 (delta 0)
+Unpacking objects: 100% (11/11), done.
+Checking connectivity... done.
+
+
+
+
By default, submodules will add the subproject into a directory named the same as the repository, in this case “DbConnector”.
+You can add a different path at the end of the command if you want it to go elsewhere.
+
+
+
If you run git status at this point, you’ll notice a few things.
+
+
+
+
$ git status
+On branch master
+Your branch is up-to-date with 'origin/master'.
+
+Changes to be committed:
+ (use "git reset HEAD <file>..." to unstage)
+
+ new file: .gitmodules
+ new file: DbConnector
+
+
+
+
First you should notice the new .gitmodules file.
+This is a configuration file that stores the mapping between the project’s URL and the local subdirectory you’ve pulled it into:
+
+
+
+
[submodule "DbConnector"]
+ path = DbConnector
+ url = https://github.com/chaconinc/DbConnector
+
+
+
+
If you have multiple submodules, you’ll have multiple entries in this file.
+It’s important to note that this file is version-controlled with your other files, like your .gitignore file.
+It’s pushed and pulled with the rest of your project.
+This is how other people who clone this project know where to get the submodule projects from.
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ Since the URL in the .gitmodules file is what other people will first try to clone/fetch from, make sure to use a URL that they can access if possible.
+For example, if you use a different URL to push to than others would to pull from, use the one that others have access to.
+You can overwrite this value locally with git config submodule.DbConnector.url PRIVATE_URL for your own use.
+When applicable, a relative URL can be helpful.
+ |
+
+
+
+
+
The other listing in the git status output is the project folder entry.
+If you run git diff on that, you see something interesting:
+
+
+
+
$ git diff --cached DbConnector
+diff --git a/DbConnector b/DbConnector
+new file mode 160000
+index 0000000..c3f01dc
+--- /dev/null
++++ b/DbConnector
+@@ -0,0 +1 @@
++Subproject commit c3f01dc8862123d317dd46284b05b6892c7b29bc
+
+
+
+
Although DbConnector is a subdirectory in your working directory, Git sees it as a submodule and doesn’t track its contents when you’re not in that directory.
+Instead, Git sees it as a particular commit from that repository.
+
+
+
If you want a little nicer diff output, you can pass the --submodule option to git diff.
+
+
+
+
$ git diff --cached --submodule
+diff --git a/.gitmodules b/.gitmodules
+new file mode 100644
+index 0000000..71fc376
+--- /dev/null
++++ b/.gitmodules
+@@ -0,0 +1,3 @@
++[submodule "DbConnector"]
++ path = DbConnector
++ url = https://github.com/chaconinc/DbConnector
+Submodule DbConnector 0000000...c3f01dc (new submodule)
+
+
+
+
When you commit, you see something like this:
+
+
+
+
$ git commit -am 'Add DbConnector module'
+[master fb9093c] Add DbConnector module
+ 2 files changed, 4 insertions(+)
+ create mode 100644 .gitmodules
+ create mode 160000 DbConnector
+
+
+
+
Notice the 160000 mode for the DbConnector entry.
+That is a special mode in Git that basically means you’re recording a commit as a directory entry rather than a subdirectory or a file.
+
+
+
Lastly, push these changes:
+
+
+
+
$ git push origin master
+
+
+
+
Cloning a Project with Submodules
+
+
Here we’ll clone a project with a submodule in it.
+When you clone such a project, by default you get the directories that contain submodules, but none of the files within them yet:
+
+
+
+
$ git clone https://github.com/chaconinc/MainProject
+Cloning into 'MainProject'...
+remote: Counting objects: 14, done.
+remote: Compressing objects: 100% (13/13), done.
+remote: Total 14 (delta 1), reused 13 (delta 0)
+Unpacking objects: 100% (14/14), done.
+Checking connectivity... done.
+$ cd MainProject
+$ ls -la
+total 16
+drwxr-xr-x 9 schacon staff 306 Sep 17 15:21 .
+drwxr-xr-x 7 schacon staff 238 Sep 17 15:21 ..
+drwxr-xr-x 13 schacon staff 442 Sep 17 15:21 .git
+-rw-r--r-- 1 schacon staff 92 Sep 17 15:21 .gitmodules
+drwxr-xr-x 2 schacon staff 68 Sep 17 15:21 DbConnector
+-rw-r--r-- 1 schacon staff 756 Sep 17 15:21 Makefile
+drwxr-xr-x 3 schacon staff 102 Sep 17 15:21 includes
+drwxr-xr-x 4 schacon staff 136 Sep 17 15:21 scripts
+drwxr-xr-x 4 schacon staff 136 Sep 17 15:21 src
+$ cd DbConnector/
+$ ls
+$
+
+
+
+
The DbConnector directory is there, but empty.
+You must run two commands: git submodule init to initialize your local configuration file, and git submodule update to fetch all the data from that project and check out the appropriate commit listed in your superproject:
+
+
+
+
$ git submodule init
+Submodule 'DbConnector' (https://github.com/chaconinc/DbConnector) registered for path 'DbConnector'
+$ git submodule update
+Cloning into 'DbConnector'...
+remote: Counting objects: 11, done.
+remote: Compressing objects: 100% (10/10), done.
+remote: Total 11 (delta 0), reused 11 (delta 0)
+Unpacking objects: 100% (11/11), done.
+Checking connectivity... done.
+Submodule path 'DbConnector': checked out 'c3f01dc8862123d317dd46284b05b6892c7b29bc'
+
+
+
+
Now your DbConnector subdirectory is at the exact state it was in when you committed earlier.
+
+
+
There is another way to do this which is a little simpler, however.
+If you pass --recurse-submodules to the git clone command, it will automatically initialize and update each submodule in the repository, including nested submodules if any of the submodules in the repository have submodules themselves.
+
+
+
+
$ git clone --recurse-submodules https://github.com/chaconinc/MainProject
+Cloning into 'MainProject'...
+remote: Counting objects: 14, done.
+remote: Compressing objects: 100% (13/13), done.
+remote: Total 14 (delta 1), reused 13 (delta 0)
+Unpacking objects: 100% (14/14), done.
+Checking connectivity... done.
+Submodule 'DbConnector' (https://github.com/chaconinc/DbConnector) registered for path 'DbConnector'
+Cloning into 'DbConnector'...
+remote: Counting objects: 11, done.
+remote: Compressing objects: 100% (10/10), done.
+remote: Total 11 (delta 0), reused 11 (delta 0)
+Unpacking objects: 100% (11/11), done.
+Checking connectivity... done.
+Submodule path 'DbConnector': checked out 'c3f01dc8862123d317dd46284b05b6892c7b29bc'
+
+
+
+
If you already cloned the project and forgot --recurse-submodules, you can combine the git submodule init and git submodule update steps by running git submodule update --init.
+To also initialize, fetch and checkout any nested submodules, you can use the foolproof git submodule update --init --recursive.
+
+
+
Working on a Project with Submodules
+
+
Now we have a copy of a project with submodules in it and will collaborate with our teammates on both the main project and the submodule project.
+
+
+
Pulling in Upstream Changes from the Submodule Remote
+
+
The simplest model of using submodules in a project would be if you were simply consuming a subproject and wanted to get updates from it from time to time but were not actually modifying anything in your checkout.
+Let’s walk through a simple example there.
+
+
+
If you want to check for new work in a submodule, you can go into the directory and run git fetch and git merge the upstream branch to update the local code.
+
+
+
+
$ git fetch
+From https://github.com/chaconinc/DbConnector
+ c3f01dc..d0354fc master -> origin/master
+$ git merge origin/master
+Updating c3f01dc..d0354fc
+Fast-forward
+ scripts/connect.sh | 1 +
+ src/db.c | 1 +
+ 2 files changed, 2 insertions(+)
+
+
+
+
Now if you go back into the main project and run git diff --submodule you can see that the submodule was updated and get a list of commits that were added to it.
+If you don’t want to type --submodule every time you run git diff, you can set it as the default format by setting the diff.submodule config value to “log”.
+
+
+
+
$ git config --global diff.submodule log
+$ git diff
+Submodule DbConnector c3f01dc..d0354fc:
+ > more efficient db routine
+ > better connection routine
+
+
+
+
If you commit at this point then you will lock the submodule into having the new code when other people update.
+
+
+
There is an easier way to do this as well, if you prefer to not manually fetch and merge in the subdirectory.
+If you run git submodule update --remote, Git will go into your submodules and fetch and update for you.
+
+
+
+
$ git submodule update --remote DbConnector
+remote: Counting objects: 4, done.
+remote: Compressing objects: 100% (2/2), done.
+remote: Total 4 (delta 2), reused 4 (delta 2)
+Unpacking objects: 100% (4/4), done.
+From https://github.com/chaconinc/DbConnector
+ 3f19983..d0354fc master -> origin/master
+Submodule path 'DbConnector': checked out 'd0354fc054692d3906c85c3af05ddce39a1c0644'
+
+
+
+
This command will by default assume that you want to update the checkout to the master branch of the submodule repository.
+You can, however, set this to something different if you want.
+For example, if you want to have the DbConnector submodule track that repository’s “stable” branch, you can set it in either your .gitmodules file (so everyone else also tracks it), or just in your local .git/config file.
+Let’s set it in the .gitmodules file:
+
+
+
+
$ git config -f .gitmodules submodule.DbConnector.branch stable
+
+$ git submodule update --remote
+remote: Counting objects: 4, done.
+remote: Compressing objects: 100% (2/2), done.
+remote: Total 4 (delta 2), reused 4 (delta 2)
+Unpacking objects: 100% (4/4), done.
+From https://github.com/chaconinc/DbConnector
+ 27cf5d3..c87d55d stable -> origin/stable
+Submodule path 'DbConnector': checked out 'c87d55d4c6d4b05ee34fbc8cb6f7bf4585ae6687'
+
+
+
+
If you leave off the -f .gitmodules it will only make the change for you, but it probably makes more sense to track that information with the repository so everyone else does as well.
+
+
+
When we run git status at this point, Git will show us that we have “new commits” on the submodule.
+
+
+
+
$ git status
+On branch master
+Your branch is up-to-date with 'origin/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: .gitmodules
+ modified: DbConnector (new commits)
+
+no changes added to commit (use "git add" and/or "git commit -a")
+
+
+
+
If you set the configuration setting status.submodulesummary, Git will also show you a short summary of changes to your submodules:
+
+
+
+
$ git config status.submodulesummary 1
+
+$ git status
+On branch master
+Your branch is up-to-date with 'origin/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: .gitmodules
+ modified: DbConnector (new commits)
+
+Submodules changed but not updated:
+
+* DbConnector c3f01dc...c87d55d (4):
+ > catch non-null terminated lines
+
+
+
+
At this point if you run git diff we can see both that we have modified our .gitmodules file and also that there are a number of commits that we’ve pulled down and are ready to commit to our submodule project.
+
+
+
+
$ git diff
+diff --git a/.gitmodules b/.gitmodules
+index 6fc0b3d..fd1cc29 100644
+--- a/.gitmodules
++++ b/.gitmodules
+@@ -1,3 +1,4 @@
+ [submodule "DbConnector"]
+ path = DbConnector
+ url = https://github.com/chaconinc/DbConnector
++ branch = stable
+ Submodule DbConnector c3f01dc..c87d55d:
+ > catch non-null terminated lines
+ > more robust error handling
+ > more efficient db routine
+ > better connection routine
+
+
+
+
This is pretty cool as we can actually see the log of commits that we’re about to commit to in our submodule.
+Once committed, you can see this information after the fact as well when you run git log -p.
+
+
+
+
$ git log -p --submodule
+commit 0a24cfc121a8a3c118e0105ae4ae4c00281cf7ae
+Author: Scott Chacon <schacon@gmail.com>
+Date: Wed Sep 17 16:37:02 2014 +0200
+
+ updating DbConnector for bug fixes
+
+diff --git a/.gitmodules b/.gitmodules
+index 6fc0b3d..fd1cc29 100644
+--- a/.gitmodules
++++ b/.gitmodules
+@@ -1,3 +1,4 @@
+ [submodule "DbConnector"]
+ path = DbConnector
+ url = https://github.com/chaconinc/DbConnector
++ branch = stable
+Submodule DbConnector c3f01dc..c87d55d:
+ > catch non-null terminated lines
+ > more robust error handling
+ > more efficient db routine
+ > better connection routine
+
+
+
+
Git will by default try to update all of your submodules when you run git submodule update --remote so if you have a lot of them, you may want to pass the name of just the submodule you want to try to update.
+
+
+
+
Pulling Upstream Changes from the Project Remote
+
+
Let’s now step into the shoes of your collaborator, who has their own local clone of the MainProject repository.
+Simply executing git pull to get your newly committed changes is not enough:
+
+
+
+
$ git pull
+From https://github.com/chaconinc/MainProject
+ fb9093c..0a24cfc master -> origin/master
+Fetching submodule DbConnector
+From https://github.com/chaconinc/DbConnector
+ c3f01dc..c87d55d stable -> origin/stable
+Updating fb9093c..0a24cfc
+Fast-forward
+ .gitmodules | 2 +-
+ DbConnector | 2 +-
+ 2 files changed, 2 insertions(+), 2 deletions(-)
+
+$ git status
+ On branch master
+Your branch is up-to-date with 'origin/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: DbConnector (new commits)
+
+Submodules changed but not updated:
+
+* DbConnector c87d55d...c3f01dc (4):
+ < catch non-null terminated lines
+ < more robust error handling
+ < more efficient db routine
+ < better connection routine
+
+no changes added to commit (use "git add" and/or "git commit -a")
+
+
+
+
By default, the git pull command recursively fetches submodules changes, as we can see in the output of the first command above.
+However, it does not update the submodules.
+This is shown by the output of the git status command, which shows the submodule is “modified”, and has “new commits”.
+What’s more, the brackets showing the new commits point left (<), indicating that these commits are recorded in MainProject but are not present in the local DbConnector checkout.
+To finalize the update, you need to run git submodule update:
+
+
+
+
$ git submodule update --init --recursive
+Submodule path 'vendor/plugins/demo': checked out '48679c6302815f6c76f1fe30625d795d9e55fc56'
+
+$ git status
+ On branch master
+Your branch is up-to-date with 'origin/master'.
+nothing to commit, working tree clean
+
+
+
+
Note that to be on the safe side, you should run git submodule update with the --init flag in case the MainProject commits you just pulled added new submodules, and with the --recursive flag if any submodules have nested submodules.
+
+
+
If you want to automate this process, you can add the --recurse-submodules flag to the git pull command (since Git 2.14).
+This will make Git run git submodule update right after the pull, putting the submodules in the correct state.
+Moreover, if you want to make Git always pull with --recurse-submodules, you can set the configuration option submodule.recurse to true (this works for git pull since Git 2.15).
+This option will make Git use the --recurse-submodules flag for all commands that support it (except clone).
+
+
+
There is a special situation that can happen when pulling superproject updates: it could be that the upstream repository has changed the URL of the submodule in the .gitmodules file in one of the commits you pull.
+This can happen for example if the submodule project changes its hosting platform.
+In that case, it is possible for git pull --recurse-submodules, or git submodule update, to fail if the superproject references a submodule commit that is not found in the submodule remote locally configured in your repository.
+In order to remedy this situation, the git submodule sync command is required:
+
+
+
+
# copy the new URL to your local config
+$ git submodule sync --recursive
+# update the submodule from the new URL
+$ git submodule update --init --recursive
+
+
+
+
+
Working on a Submodule
+
+
It’s quite likely that if you’re using submodules, you’re doing so because you really want to work on the code in the submodule at the same time as you’re working on the code in the main project (or across several submodules).
+Otherwise you would probably instead be using a simpler dependency management system (such as Maven or Rubygems).
+
+
+
So now let’s go through an example of making changes to the submodule at the same time as the main project and committing and publishing those changes at the same time.
+
+
+
So far, when we’ve run the git submodule update command to fetch changes from the submodule repositories, Git would get the changes and update the files in the subdirectory but will leave the sub-repository in what’s called a “detached HEAD” state.
+This means that there is no local working branch (like master, for example) tracking changes.
+With no working branch tracking changes, that means even if you commit changes to the submodule, those changes will quite possibly be lost the next time you run git submodule update.
+You have to do some extra steps if you want changes in a submodule to be tracked.
+
+
+
In order to set up your submodule to be easier to go in and hack on, you need to do two things.
+You need to go into each submodule and check out a branch to work on.
+Then you need to tell Git what to do if you have made changes and then git submodule update --remote pulls in new work from upstream.
+The options are that you can merge them into your local work, or you can try to rebase your local work on top of the new changes.
+
+
+
First of all, let’s go into our submodule directory and check out a branch.
+
+
+
+
$ cd DbConnector/
+$ git checkout stable
+Switched to branch 'stable'
+
+
+
+
Let’s try updating our submodule with the “merge” option.
+To specify it manually, we can just add the --merge option to our update call.
+Here we’ll see that there was a change on the server for this submodule and it gets merged in.
+
+
+
+
$ cd ..
+$ git submodule update --remote --merge
+remote: Counting objects: 4, done.
+remote: Compressing objects: 100% (2/2), done.
+remote: Total 4 (delta 2), reused 4 (delta 2)
+Unpacking objects: 100% (4/4), done.
+From https://github.com/chaconinc/DbConnector
+ c87d55d..92c7337 stable -> origin/stable
+Updating c87d55d..92c7337
+Fast-forward
+ src/main.c | 1 +
+ 1 file changed, 1 insertion(+)
+Submodule path 'DbConnector': merged in '92c7337b30ef9e0893e758dac2459d07362ab5ea'
+
+
+
+
If we go into the DbConnector directory, we have the new changes already merged into our local stable branch.
+Now let’s see what happens when we make our own local change to the library and someone else pushes another change upstream at the same time.
+
+
+
+
$ cd DbConnector/
+$ vim src/db.c
+$ git commit -am 'Unicode support'
+[stable f906e16] Unicode support
+ 1 file changed, 1 insertion(+)
+
+
+
+
Now if we update our submodule we can see what happens when we have made a local change and upstream also has a change we need to incorporate.
+
+
+
+
$ cd ..
+$ git submodule update --remote --rebase
+First, rewinding head to replay your work on top of it...
+Applying: Unicode support
+Submodule path 'DbConnector': rebased into '5d60ef9bbebf5a0c1c1050f242ceeb54ad58da94'
+
+
+
+
If you forget the --rebase or --merge, Git will just update the submodule to whatever is on the server and reset your project to a detached HEAD state.
+
+
+
+
$ git submodule update --remote
+Submodule path 'DbConnector': checked out '5d60ef9bbebf5a0c1c1050f242ceeb54ad58da94'
+
+
+
+
If this happens, don’t worry, you can simply go back into the directory and check out your branch again (which will still contain your work) and merge or rebase origin/stable (or whatever remote branch you want) manually.
+
+
+
If you haven’t committed your changes in your submodule and you run a submodule update that would cause issues, Git will fetch the changes but not overwrite unsaved work in your submodule directory.
+
+
+
+
$ git submodule update --remote
+remote: Counting objects: 4, done.
+remote: Compressing objects: 100% (3/3), done.
+remote: Total 4 (delta 0), reused 4 (delta 0)
+Unpacking objects: 100% (4/4), done.
+From https://github.com/chaconinc/DbConnector
+ 5d60ef9..c75e92a stable -> origin/stable
+error: Your local changes to the following files would be overwritten by checkout:
+ scripts/setup.sh
+Please, commit your changes or stash them before you can switch branches.
+Aborting
+Unable to checkout 'c75e92a2b3855c9e5b66f915308390d9db204aca' in submodule path 'DbConnector'
+
+
+
+
If you made changes that conflict with something changed upstream, Git will let you know when you run the update.
+
+
+
+
$ git submodule update --remote --merge
+Auto-merging scripts/setup.sh
+CONFLICT (content): Merge conflict in scripts/setup.sh
+Recorded preimage for 'scripts/setup.sh'
+Automatic merge failed; fix conflicts and then commit the result.
+Unable to merge 'c75e92a2b3855c9e5b66f915308390d9db204aca' in submodule path 'DbConnector'
+
+
+
+
You can go into the submodule directory and fix the conflict just as you normally would.
+
+
+
+
Publishing Submodule Changes
+
+
Now we have some changes in our submodule directory.
+Some of these were brought in from upstream by our updates and others were made locally and aren’t available to anyone else yet as we haven’t pushed them yet.
+
+
+
+
$ git diff
+Submodule DbConnector c87d55d..82d2ad3:
+ > Merge from origin/stable
+ > Update setup script
+ > Unicode support
+ > Remove unnecessary method
+ > Add new option for conn pooling
+
+
+
+
If we commit in the main project and push it up without pushing the submodule changes up as well, other people who try to check out our changes are going to be in trouble since they will have no way to get the submodule changes that are depended on.
+Those changes will only exist on our local copy.
+
+
+
In order to make sure this doesn’t happen, you can ask Git to check that all your submodules have been pushed properly before pushing the main project.
+The git push command takes the --recurse-submodules argument which can be set to either “check” or “on-demand”.
+The “check” option will make push simply fail if any of the committed submodule changes haven’t been pushed.
+
+
+
+
$ git push --recurse-submodules=check
+The following submodule paths contain changes that can
+not be found on any remote:
+ DbConnector
+
+Please try
+
+ git push --recurse-submodules=on-demand
+
+or cd to the path and use
+
+ git push
+
+to push them to a remote.
+
+
+
+
As you can see, it also gives us some helpful advice on what we might want to do next.
+The simple option is to go into each submodule and manually push to the remotes to make sure they’re externally available and then try this push again.
+If you want the check behavior to happen for all pushes, you can make this behavior the default by doing git config push.recurseSubmodules check.
+
+
+
The other option is to use the “on-demand” value, which will try to do this for you.
+
+
+
+
$ git push --recurse-submodules=on-demand
+Pushing submodule 'DbConnector'
+Counting objects: 9, done.
+Delta compression using up to 8 threads.
+Compressing objects: 100% (8/8), done.
+Writing objects: 100% (9/9), 917 bytes | 0 bytes/s, done.
+Total 9 (delta 3), reused 0 (delta 0)
+To https://github.com/chaconinc/DbConnector
+ c75e92a..82d2ad3 stable -> stable
+Counting objects: 2, done.
+Delta compression using up to 8 threads.
+Compressing objects: 100% (2/2), done.
+Writing objects: 100% (2/2), 266 bytes | 0 bytes/s, done.
+Total 2 (delta 1), reused 0 (delta 0)
+To https://github.com/chaconinc/MainProject
+ 3d6d338..9a377d1 master -> master
+
+
+
+
As you can see there, Git went into the DbConnector module and pushed it before pushing the main project.
+If that submodule push fails for some reason, the main project push will also fail.
+You can make this behavior the default by doing git config push.recurseSubmodules on-demand.
+
+
+
+
Merging Submodule Changes
+
+
If you change a submodule reference at the same time as someone else, you may run into some problems.
+That is, if the submodule histories have diverged and are committed to diverging branches in a superproject, it may take a bit of work for you to fix.
+
+
+
If one of the commits is a direct ancestor of the other (a fast-forward merge), then Git will simply choose the latter for the merge, so that works fine.
+
+
+
Git will not attempt even a trivial merge for you, however.
+If the submodule commits diverge and need to be merged, you will get something that looks like this:
+
+
+
+
$ git pull
+remote: Counting objects: 2, done.
+remote: Compressing objects: 100% (1/1), done.
+remote: Total 2 (delta 1), reused 2 (delta 1)
+Unpacking objects: 100% (2/2), done.
+From https://github.com/chaconinc/MainProject
+ 9a377d1..eb974f8 master -> origin/master
+Fetching submodule DbConnector
+warning: Failed to merge submodule DbConnector (merge following commits not found)
+Auto-merging DbConnector
+CONFLICT (submodule): Merge conflict in DbConnector
+Automatic merge failed; fix conflicts and then commit the result.
+
+
+
+
So basically what has happened here is that Git has figured out that the two branches record points in the submodule’s history that are divergent and need to be merged.
+It explains it as “merge following commits not found”, which is confusing but we’ll explain why that is in a bit.
+
+
+
To solve the problem, you need to figure out what state the submodule should be in.
+Strangely, Git doesn’t really give you much information to help out here, not even the SHA-1s of the commits of both sides of the history.
+Fortunately, it’s simple to figure out.
+If you run git diff you can get the SHA-1s of the commits recorded in both branches you were trying to merge.
+
+
+
+
$ git diff
+diff --cc DbConnector
+index eb41d76,c771610..0000000
+--- a/DbConnector
++++ b/DbConnector
+
+
+
+
So, in this case, eb41d76 is the commit in our submodule that we had and c771610 is the commit that upstream had.
+If we go into our submodule directory, it should already be on eb41d76 as the merge would not have touched it.
+If for whatever reason it’s not, you can simply create and checkout a branch pointing to it.
+
+
+
What is important is the SHA-1 of the commit from the other side.
+This is what you’ll have to merge in and resolve.
+You can either just try the merge with the SHA-1 directly, or you can create a branch for it and then try to merge that in.
+We would suggest the latter, even if only to make a nicer merge commit message.
+
+
+
So, we will go into our submodule directory, create a branch based on that second SHA-1 from git diff and manually merge.
+
+
+
+
$ cd DbConnector
+
+$ git rev-parse HEAD
+eb41d764bccf88be77aced643c13a7fa86714135
+
+$ git branch try-merge c771610
+(DbConnector) $ git merge try-merge
+Auto-merging src/main.c
+CONFLICT (content): Merge conflict in src/main.c
+Recorded preimage for 'src/main.c'
+Automatic merge failed; fix conflicts and then commit the result.
+
+
+
+
We got an actual merge conflict here, so if we resolve that and commit it, then we can simply update the main project with the result.
+
+
+
+
$ vim src/main.c (1)
+$ git add src/main.c
+$ git commit -am 'merged our changes'
+Recorded resolution for 'src/main.c'.
+[master 9fd905e] merged our changes
+
+$ cd .. (2)
+$ git diff (3)
+diff --cc DbConnector
+index eb41d76,c771610..0000000
+--- a/DbConnector
++++ b/DbConnector
+@@@ -1,1 -1,1 +1,1 @@@
+- Subproject commit eb41d764bccf88be77aced643c13a7fa86714135
+ -Subproject commit c77161012afbbe1f58b5053316ead08f4b7e6d1d
+++Subproject commit 9fd905e5d7f45a0d4cbc43d1ee550f16a30e825a
+$ git add DbConnector (4)
+
+$ git commit -m "Merge Tom's Changes" (5)
+[master 10d2c60] Merge Tom's Changes
+
+
+
+
+-
+
First we resolve the conflict
+
+-
+
Then we go back to the main project directory
+
+-
+
We can check the SHA-1s again
+
+-
+
Resolve the conflicted submodule entry
+
+-
+
Commit our merge
+
+
+
+
+
It can be a bit confusing, but it’s really not very hard.
+
+
+
Interestingly, there is another case that Git handles.
+If a merge commit exists in the submodule directory that contains both commits in its history, Git will suggest it to you as a possible solution.
+It sees that at some point in the submodule project, someone merged branches containing these two commits, so maybe you’ll want that one.
+
+
+
This is why the error message from before was “merge following commits not found”, because it could not do this.
+It’s confusing because who would expect it to try to do this?
+
+
+
If it does find a single acceptable merge commit, you’ll see something like this:
+
+
+
+
$ git merge origin/master
+warning: Failed to merge submodule DbConnector (not fast-forward)
+Found a possible merge resolution for the submodule:
+ 9fd905e5d7f45a0d4cbc43d1ee550f16a30e825a: > merged our changes
+If this is correct simply add it to the index for example
+by using:
+
+ git update-index --cacheinfo 160000 9fd905e5d7f45a0d4cbc43d1ee550f16a30e825a "DbConnector"
+
+which will accept this suggestion.
+Auto-merging DbConnector
+CONFLICT (submodule): Merge conflict in DbConnector
+Automatic merge failed; fix conflicts and then commit the result.
+
+
+
+
The suggested command Git is providing will update the index as though you had run git add (which clears the conflict), then commit.
+You probably shouldn’t do this though.
+You can just as easily go into the submodule directory, see what the difference is, fast-forward to this commit, test it properly, and then commit it.
+
+
+
+
$ cd DbConnector/
+$ git merge 9fd905e
+Updating eb41d76..9fd905e
+Fast-forward
+
+$ cd ..
+$ git add DbConnector
+$ git commit -am 'Fast forward to a common submodule child'
+
+
+
+
This accomplishes the same thing, but at least this way you can verify that it works and you have the code in your submodule directory when you’re done.
+
+
+
+
Submodule Tips
+
+
There are a few things you can do to make working with submodules a little easier.
+
+
+
Submodule Foreach
+
+
There is a foreach submodule command to run some arbitrary command in each submodule.
+This can be really helpful if you have a number of submodules in the same project.
+
+
+
For example, let’s say we want to start a new feature or do a bugfix and we have work going on in several submodules.
+We can easily stash all the work in all our submodules.
+
+
+
+
$ git submodule foreach 'git stash'
+Entering 'CryptoLibrary'
+No local changes to save
+Entering 'DbConnector'
+Saved working directory and index state WIP on stable: 82d2ad3 Merge from origin/stable
+HEAD is now at 82d2ad3 Merge from origin/stable
+
+
+
+
Then we can create a new branch and switch to it in all our submodules.
+
+
+
+
$ git submodule foreach 'git checkout -b featureA'
+Entering 'CryptoLibrary'
+Switched to a new branch 'featureA'
+Entering 'DbConnector'
+Switched to a new branch 'featureA'
+
+
+
+
You get the idea.
+One really useful thing you can do is produce a nice unified diff of what is changed in your main project and all your subprojects as well.
+
+
+
+
$ git diff; git submodule foreach 'git diff'
+Submodule DbConnector contains modified content
+diff --git a/src/main.c b/src/main.c
+index 210f1ae..1f0acdc 100644
+--- a/src/main.c
++++ b/src/main.c
+@@ -245,6 +245,8 @@ static int handle_alias(int *argcp, const char ***argv)
+
+ commit_pager_choice();
+
++ url = url_decode(url_orig);
++
+ /* build alias_argv */
+ alias_argv = xmalloc(sizeof(*alias_argv) * (argc + 1));
+ alias_argv[0] = alias_string + 1;
+Entering 'DbConnector'
+diff --git a/src/db.c b/src/db.c
+index 1aaefb6..5297645 100644
+--- a/src/db.c
++++ b/src/db.c
+@@ -93,6 +93,11 @@ char *url_decode_mem(const char *url, int len)
+ return url_decode_internal(&url, len, NULL, &out, 0);
+ }
+
++char *url_decode(const char *url)
++{
++ return url_decode_mem(url, strlen(url));
++}
++
+ char *url_decode_parameter_name(const char **query)
+ {
+ struct strbuf out = STRBUF_INIT;
+
+
+
+
Here we can see that we’re defining a function in a submodule and calling it in the main project.
+This is obviously a simplified example, but hopefully it gives you an idea of how this may be useful.
+
+
+
+
Useful Aliases
+
+
You may want to set up some aliases for some of these commands as they can be quite long and you can’t set configuration options for most of them to make them defaults.
+We covered setting up Git aliases in نامهای مستعار در گیت, but here is an example of what you may want to set up if you plan on working with submodules in Git a lot.
+
+
+
+
$ git config alias.sdiff '!'"git diff && git submodule foreach 'git diff'"
+$ git config alias.spush 'push --recurse-submodules=on-demand'
+$ git config alias.supdate 'submodule update --remote --merge'
+
+
+
+
This way you can simply run git supdate when you want to update your submodules, or git spush to push with submodule dependency checking.
+
+
+
+
Issues with Submodules
+
+
Using submodules isn’t without hiccups, however.
+
+
+
Switching branches
+
+
For instance, switching branches with submodules in them can also be tricky with Git versions older than Git 2.13.
+If you create a new branch, add a submodule there, and then switch back to a branch without that submodule, you still have the submodule directory as an untracked directory:
+
+
+
+
$ git --version
+git version 2.12.2
+
+$ git checkout -b add-crypto
+Switched to a new branch 'add-crypto'
+
+$ git submodule add https://github.com/chaconinc/CryptoLibrary
+Cloning into 'CryptoLibrary'...
+...
+
+$ git commit -am 'Add crypto library'
+[add-crypto 4445836] Add crypto library
+ 2 files changed, 4 insertions(+)
+ create mode 160000 CryptoLibrary
+
+$ git checkout master
+warning: unable to rmdir CryptoLibrary: Directory not empty
+Switched to branch 'master'
+Your branch is up-to-date with 'origin/master'.
+
+$ git status
+On branch master
+Your branch is up-to-date with 'origin/master'.
+
+Untracked files:
+ (use "git add <file>..." to include in what will be committed)
+
+ CryptoLibrary/
+
+nothing added to commit but untracked files present (use "git add" to track)
+
+
+
+
Removing the directory isn’t difficult, but it can be a bit confusing to have that in there.
+If you do remove it and then switch back to the branch that has that submodule, you will need to run submodule update --init to repopulate it.
+
+
+
+
$ git clean -ffdx
+Removing CryptoLibrary/
+
+$ git checkout add-crypto
+Switched to branch 'add-crypto'
+
+$ ls CryptoLibrary/
+
+$ git submodule update --init
+Submodule path 'CryptoLibrary': checked out 'b8dda6aa182ea4464f3f3264b11e0268545172af'
+
+$ ls CryptoLibrary/
+Makefile includes scripts src
+
+
+
+
Again, not really very difficult, but it can be a little confusing.
+
+
+
Newer Git versions (Git >= 2.13) simplify all this by adding the --recurse-submodules flag to the git checkout command, which takes care of placing the submodules in the right state for the branch we are switching to.
+
+
+
+
$ git --version
+git version 2.13.3
+
+$ git checkout -b add-crypto
+Switched to a new branch 'add-crypto'
+
+$ git submodule add https://github.com/chaconinc/CryptoLibrary
+Cloning into 'CryptoLibrary'...
+...
+
+$ git commit -am 'Add crypto library'
+[add-crypto 4445836] Add crypto library
+ 2 files changed, 4 insertions(+)
+ create mode 160000 CryptoLibrary
+
+$ git checkout --recurse-submodules master
+Switched to branch 'master'
+Your branch is up-to-date with 'origin/master'.
+
+$ git status
+On branch master
+Your branch is up-to-date with 'origin/master'.
+
+nothing to commit, working tree clean
+
+
+
+
Using the --recurse-submodules flag of git checkout can also be useful when you work on several branches in the superproject, each having your submodule pointing at different commits.
+Indeed, if you switch between branches that record the submodule at different commits, upon executing git status the submodule will appear as “modified”, and indicate “new commits”. That is because the submodule state is by default not carried over when switching branches.
+
+
+
This can be really confusing, so it’s a good idea to always git checkout --recurse-submodules when your project has submodules.
+(For older Git versions that do not have the --recurse-submodules flag, after the checkout you can use git submodule update --init --recursive to put the submodules in the right state.)
+
+
+
Luckily, you can tell Git (>=2.14) to always use the --recurse-submodules flag by setting the configuration option submodule.recurse: git config submodule.recurse true.
+As noted above, this will also make Git recurse into submodules for every command that has a --recurse-submodules option (except git clone).
+
+
+
+
Switching from subdirectories to submodules
+
+
The other main caveat that many people run into involves switching from subdirectories to submodules.
+If you’ve been tracking files in your project and you want to move them out into a submodule, you must be careful or Git will get angry at you.
+Assume that you have files in a subdirectory of your project, and you want to switch it to a submodule.
+If you delete the subdirectory and then run submodule add, Git yells at you:
+
+
+
+
$ rm -Rf CryptoLibrary/
+$ git submodule add https://github.com/chaconinc/CryptoLibrary
+'CryptoLibrary' already exists in the index
+
+
+
+
You have to unstage the CryptoLibrary directory first.
+Then you can add the submodule:
+
+
+
+
$ git rm -r CryptoLibrary
+$ git submodule add https://github.com/chaconinc/CryptoLibrary
+Cloning into 'CryptoLibrary'...
+remote: Counting objects: 11, done.
+remote: Compressing objects: 100% (10/10), done.
+remote: Total 11 (delta 0), reused 11 (delta 0)
+Unpacking objects: 100% (11/11), done.
+Checking connectivity... done.
+
+
+
+
Now suppose you did that in a branch.
+If you try to switch back to a branch where those files are still in the actual tree rather than a submodule – you get this error:
+
+
+
+
$ git checkout master
+error: The following untracked working tree files would be overwritten by checkout:
+ CryptoLibrary/Makefile
+ CryptoLibrary/includes/crypto.h
+ ...
+Please move or remove them before you can switch branches.
+Aborting
+
+
+
+
You can force it to switch with checkout -f, but be careful that you don’t have unsaved changes in there as they could be overwritten with that command.
+
+
+
+
$ git checkout -f master
+warning: unable to rmdir CryptoLibrary: Directory not empty
+Switched to branch 'master'
+
+
+
+
Then, when you switch back, you get an empty CryptoLibrary directory for some reason and git submodule update may not fix it either.
+You may need to go into your submodule directory and run a git checkout . to get all your files back.
+You could run this in a submodule foreach script to run it for multiple submodules.
+
+
+
It’s important to note that submodules these days keep all their Git data in the top project’s .git directory, so unlike much older versions of Git, destroying a submodule directory won’t lose any commits or branches that you had.
+
+
+
With these tools, submodules can be a fairly simple and effective method for developing on several related but still separate projects simultaneously.
+
+
+
Summary
+
+
You’ve seen a number of advanced tools that allow you to manipulate your commits and staging area more precisely.
+When you notice issues, you should be able to easily figure out what commit introduced them, when, and by whom.
+If you want to use subprojects in your project, you’ve learned how to accommodate those needs.
+At this point, you should be able to do most of the things in Git that you’ll need on the command line day to day and feel comfortable doing so.
+
The world isn’t perfect.
+Usually, you can’t immediately switch every project you come in contact with to Git.
+Sometimes you’re stuck on a project using another VCS, and wish it was Git.
+We’ll spend the first part of this chapter learning about ways to use Git as a client when the project you’re working on is hosted in a different system.
At some point, you may want to convert your existing project to Git.
+The second part of this chapter covers how to migrate your project into Git from several specific systems, as well as a method that will work if no pre-built import tool exists.
+Git as a Client
+
+
+Git provides such a nice experience for developers that many people have figured out how to use it on their workstation, even if the rest of their team is using an entirely different VCS.
+There are a number of these adapters, called “bridges,” available.
+Here we’ll cover the ones you’re most likely to run into in the wild.
+
+
Git and Subversion
+
+
+A large fraction of open source development projects and a good number of corporate projects use Subversion to manage their source code.
+It’s been around for more than a decade, and for most of that time was the de facto VCS choice for open-source projects.
+It’s also very similar in many ways to CVS, which was the big boy of the source-control world before that.
+
+
+
+One of Git’s great features is a bidirectional bridge to Subversion called git svn.
+This tool allows you to use Git as a valid client to a Subversion server, so you can use all the local features of Git and then push to a Subversion server as if you were using Subversion locally.
+This means you can do local branching and merging, use the staging area, use rebasing and cherry-picking, and so on, while your collaborators continue to work in their dark and ancient ways.
+It’s a good way to sneak Git into the corporate environment and help your fellow developers become more efficient while you lobby to get the infrastructure changed to support Git fully.
+The Subversion bridge is the gateway drug to the DVCS world.
+
+
+
git svn
+
+
The base command in Git for all the Subversion bridging commands is git svn.
+It takes quite a few commands, so we’ll show the most common while going through a few simple workflows.
+
+
+
It’s important to note that when you’re using git svn, you’re interacting with Subversion, which is a system that works very differently from Git.
+Although you can do local branching and merging, it’s generally best to keep your history as linear as possible by rebasing your work, and avoiding doing things like simultaneously interacting with a Git remote repository.
+
+
+
Don’t rewrite your history and try to push again, and don’t push to a parallel Git repository to collaborate with fellow Git developers at the same time.
+Subversion can have only a single linear history, and confusing it is very easy.
+If you’re working with a team, and some are using SVN and others are using Git, make sure everyone is using the SVN server to collaborate – doing so will make your life easier.
+
+
+
+
Setting Up
+
+
To demonstrate this functionality, you need a typical SVN repository that you have write access to.
+If you want to copy these examples, you’ll have to make a writeable copy of an SVN test repository.
+In order to do that easily, you can use a tool called svnsync that comes with Subversion.
+
+
+
To follow along, you first need to create a new local Subversion repository:
+
+
+
+
$ mkdir /tmp/test-svn
+$ svnadmin create /tmp/test-svn
+
+
+
+
Then, enable all users to change revprops – the easy way is to add a pre-revprop-change script that always exits 0:
+
+
+
+
$ cat /tmp/test-svn/hooks/pre-revprop-change
+#!/bin/sh
+exit 0;
+$ chmod +x /tmp/test-svn/hooks/pre-revprop-change
+
+
+
+
You can now sync this project to your local machine by calling svnsync init with the to and from repositories.
+
+
+
+
$ svnsync init file:///tmp/test-svn \
+ http://your-svn-server.example.org/svn/
+
+
+
+
This sets up the properties to run the sync.
+You can then clone the code by running
+
+
+
+
$ svnsync sync file:///tmp/test-svn
+Committed revision 1.
+Copied properties for revision 1.
+Transmitting file data .............................[...]
+Committed revision 2.
+Copied properties for revision 2.
+[…]
+
+
+
+
Although this operation may take only a few minutes, if you try to copy the original repository to another remote repository instead of a local one, the process will take nearly an hour, even though there are fewer than 100 commits.
+Subversion has to clone one revision at a time and then push it back into another repository – it’s ridiculously inefficient, but it’s the only easy way to do this.
+
+
+
+
Getting Started
+
+
Now that you have a Subversion repository to which you have write access, you can go through a typical workflow.
+You’ll start with the git svn clone command, which imports an entire Subversion repository into a local Git repository.
+Remember that if you’re importing from a real hosted Subversion repository, you should replace the file:///tmp/test-svn here with the URL of your Subversion repository:
+
+
+
+
$ git svn clone file:///tmp/test-svn -T trunk -b branches -t tags
+Initialized empty Git repository in /private/tmp/progit/test-svn/.git/
+r1 = dcbfb5891860124cc2e8cc616cded42624897125 (refs/remotes/origin/trunk)
+ A m4/acx_pthread.m4
+ A m4/stl_hash.m4
+ A java/src/test/java/com/google/protobuf/UnknownFieldSetTest.java
+ A java/src/test/java/com/google/protobuf/WireFormatTest.java
+…
+r75 = 556a3e1e7ad1fde0a32823fc7e4d046bcfd86dae (refs/remotes/origin/trunk)
+Found possible branch point: file:///tmp/test-svn/trunk => file:///tmp/test-svn/branches/my-calc-branch, 75
+Found branch parent: (refs/remotes/origin/my-calc-branch) 556a3e1e7ad1fde0a32823fc7e4d046bcfd86dae
+Following parent with do_switch
+Successfully followed parent
+r76 = 0fb585761df569eaecd8146c71e58d70147460a2 (refs/remotes/origin/my-calc-branch)
+Checked out HEAD:
+ file:///tmp/test-svn/trunk r75
+
+
+
+
This runs the equivalent of two commands – git svn init followed by git svn fetch – on the URL you provide.
+This can take a while.
+If, for example, the test project has only about 75 commits and the codebase isn’t that big, Git nevertheless must check out each version, one at a time, and commit it individually.
+For a project with hundreds or thousands of commits, this can literally take hours or even days to finish.
+
+
+
The -T trunk -b branches -t tags part tells Git that this Subversion repository follows the basic branching and tagging conventions.
+If you name your trunk, branches, or tags differently, you can change these options.
+Because this is so common, you can replace this entire part with -s, which means standard layout and implies all those options.
+The following command is equivalent:
+
+
+
+
$ git svn clone file:///tmp/test-svn -s
+
+
+
+
At this point, you should have a valid Git repository that has imported your branches and tags:
+
+
+
+
$ git branch -a
+* master
+ remotes/origin/my-calc-branch
+ remotes/origin/tags/2.0.2
+ remotes/origin/tags/release-2.0.1
+ remotes/origin/tags/release-2.0.2
+ remotes/origin/tags/release-2.0.2rc1
+ remotes/origin/trunk
+
+
+
+
Note how this tool manages Subversion tags as remote refs.
+
+Let’s take a closer look with the Git plumbing command show-ref:
+
+
+
+
$ git show-ref
+556a3e1e7ad1fde0a32823fc7e4d046bcfd86dae refs/heads/master
+0fb585761df569eaecd8146c71e58d70147460a2 refs/remotes/origin/my-calc-branch
+bfd2d79303166789fc73af4046651a4b35c12f0b refs/remotes/origin/tags/2.0.2
+285c2b2e36e467dd4d91c8e3c0c0e1750b3fe8ca refs/remotes/origin/tags/release-2.0.1
+cbda99cb45d9abcb9793db1d4f70ae562a969f1e refs/remotes/origin/tags/release-2.0.2
+a9f074aa89e826d6f9d30808ce5ae3ffe711feda refs/remotes/origin/tags/release-2.0.2rc1
+556a3e1e7ad1fde0a32823fc7e4d046bcfd86dae refs/remotes/origin/trunk
+
+
+
+
Git doesn’t do this when it clones from a Git server; here’s what a repository with tags looks like after a fresh clone:
+
+
+
+
$ git show-ref
+c3dcbe8488c6240392e8a5d7553bbffcb0f94ef0 refs/remotes/origin/master
+32ef1d1c7cc8c603ab78416262cc421b80a8c2df refs/remotes/origin/branch-1
+75f703a3580a9b81ead89fe1138e6da858c5ba18 refs/remotes/origin/branch-2
+23f8588dde934e8f33c263c6d8359b2ae095f863 refs/tags/v0.1.0
+7064938bd5e7ef47bfd79a685a62c1e2649e2ce7 refs/tags/v0.2.0
+6dcb09b5b57875f334f61aebed695e2e4193db5e refs/tags/v1.0.0
+
+
+
+
Git fetches the tags directly into refs/tags, rather than treating them remote branches.
+
+
+
+
Committing Back to Subversion
+
+
Now that you have a working directory, you can do some work on the project and push your commits back upstream, using Git effectively as an SVN client.
+If you edit one of the files and commit it, you have a commit that exists in Git locally that doesn’t exist on the Subversion server:
+
+
+
+
$ git commit -am 'Adding git-svn instructions to the README'
+[master 4af61fd] Adding git-svn instructions to the README
+ 1 file changed, 5 insertions(+)
+
+
+
+
Next, you need to push your change upstream.
+Notice how this changes the way you work with Subversion – you can do several commits offline and then push them all at once to the Subversion server.
+To push to a Subversion server, you run the git svn dcommit command:
+
+
+
+
$ git svn dcommit
+Committing to file:///tmp/test-svn/trunk ...
+ M README.txt
+Committed r77
+ M README.txt
+r77 = 95e0222ba6399739834380eb10afcd73e0670bc5 (refs/remotes/origin/trunk)
+No changes between 4af61fd05045e07598c553167e0f31c84fd6ffe1 and refs/remotes/origin/trunk
+Resetting to the latest refs/remotes/origin/trunk
+
+
+
+
This takes all the commits you’ve made on top of the Subversion server code, does a Subversion commit for each, and then rewrites your local Git commit to include a unique identifier.
+This is important because it means that all the SHA-1 checksums for your commits change.
+Partly for this reason, working with Git-based remote versions of your projects concurrently with a Subversion server isn’t a good idea.
+If you look at the last commit, you can see the new git-svn-id that was added:
+
+
+
+
$ git log -1
+commit 95e0222ba6399739834380eb10afcd73e0670bc5
+Author: ben <ben@0b684db3-b064-4277-89d1-21af03df0a68>
+Date: Thu Jul 24 03:08:36 2014 +0000
+
+ Adding git-svn instructions to the README
+
+ git-svn-id: file:///tmp/test-svn/trunk@77 0b684db3-b064-4277-89d1-21af03df0a68
+
+
+
+
Notice that the SHA-1 checksum that originally started with 4af61fd when you committed now begins with 95e0222.
+If you want to push to both a Git server and a Subversion server, you have to push (dcommit) to the Subversion server first, because that action changes your commit data.
+
+
+
+
Pulling in New Changes
+
+
If you’re working with other developers, then at some point one of you will push, and then the other one will try to push a change that conflicts.
+That change will be rejected until you merge in their work.
+In git svn, it looks like this:
+
+
+
+
$ git svn dcommit
+Committing to file:///tmp/test-svn/trunk ...
+
+ERROR from SVN:
+Transaction is out of date: File '/trunk/README.txt' is out of date
+W: d5837c4b461b7c0e018b49d12398769d2bfc240a and refs/remotes/origin/trunk differ, using rebase:
+:100644 100644 f414c433af0fd6734428cf9d2a9fd8ba00ada145 c80b6127dd04f5fcda218730ddf3a2da4eb39138 M README.txt
+Current branch master is up to date.
+ERROR: Not all changes have been committed into SVN, however the committed
+ones (if any) seem to be successfully integrated into the working tree.
+Please see the above messages for details.
+
+
+
+
To resolve this situation, you can run git svn rebase, which pulls down any changes on the server that you don’t have yet and rebases any work you have on top of what is on the server:
+
+
+
+
$ git svn rebase
+Committing to file:///tmp/test-svn/trunk ...
+
+ERROR from SVN:
+Transaction is out of date: File '/trunk/README.txt' is out of date
+W: eaa029d99f87c5c822c5c29039d19111ff32ef46 and refs/remotes/origin/trunk differ, using rebase:
+:100644 100644 65536c6e30d263495c17d781962cfff12422693a b34372b25ccf4945fe5658fa381b075045e7702a M README.txt
+First, rewinding head to replay your work on top of it...
+Applying: update foo
+Using index info to reconstruct a base tree...
+M README.txt
+Falling back to patching base and 3-way merge...
+Auto-merging README.txt
+ERROR: Not all changes have been committed into SVN, however the committed
+ones (if any) seem to be successfully integrated into the working tree.
+Please see the above messages for details.
+
+
+
+
Now, all your work is on top of what is on the Subversion server, so you can successfully dcommit:
+
+
+
+
$ git svn dcommit
+Committing to file:///tmp/test-svn/trunk ...
+ M README.txt
+Committed r85
+ M README.txt
+r85 = 9c29704cc0bbbed7bd58160cfb66cb9191835cd8 (refs/remotes/origin/trunk)
+No changes between 5762f56732a958d6cfda681b661d2a239cc53ef5 and refs/remotes/origin/trunk
+Resetting to the latest refs/remotes/origin/trunk
+
+
+
+
Note that unlike Git, which requires you to merge upstream work you don’t yet have locally before you can push, git svn makes you do that only if the changes conflict (much like how Subversion works).
+If someone else pushes a change to one file and then you push a change to another file, your dcommit will work fine:
+
+
+
+
$ git svn dcommit
+Committing to file:///tmp/test-svn/trunk ...
+ M configure.ac
+Committed r87
+ M autogen.sh
+r86 = d8450bab8a77228a644b7dc0e95977ffc61adff7 (refs/remotes/origin/trunk)
+ M configure.ac
+r87 = f3653ea40cb4e26b6281cec102e35dcba1fe17c4 (refs/remotes/origin/trunk)
+W: a0253d06732169107aa020390d9fefd2b1d92806 and refs/remotes/origin/trunk differ, using rebase:
+:100755 100755 efa5a59965fbbb5b2b0a12890f1b351bb5493c18 e757b59a9439312d80d5d43bb65d4a7d0389ed6d M autogen.sh
+First, rewinding head to replay your work on top of it...
+
+
+
+
This is important to remember, because the outcome is a project state that didn’t exist on either of your computers when you pushed.
+If the changes are incompatible but don’t conflict, you may get issues that are difficult to diagnose.
+This is different than using a Git server – in Git, you can fully test the state on your client system before publishing it, whereas in SVN, you can’t ever be certain that the states immediately before commit and after commit are identical.
+
+
+
You should also run this command to pull in changes from the Subversion server, even if you’re not ready to commit yourself.
+You can run git svn fetch to grab the new data, but git svn rebase does the fetch and then updates your local commits.
+
+
+
+
$ git svn rebase
+ M autogen.sh
+r88 = c9c5f83c64bd755368784b444bc7a0216cc1e17b (refs/remotes/origin/trunk)
+First, rewinding head to replay your work on top of it...
+Fast-forwarded master to refs/remotes/origin/trunk.
+
+
+
+
Running git svn rebase every once in a while makes sure your code is always up to date.
+You need to be sure your working directory is clean when you run this, though.
+If you have local changes, you must either stash your work or temporarily commit it before running git svn rebase – otherwise, the command will stop if it sees that the rebase will result in a merge conflict.
+
+
+
+
Git Branching Issues
+
+
When you’ve become comfortable with a Git workflow, you’ll likely create topic branches, do work on them, and then merge them in.
+If you’re pushing to a Subversion server via git svn, you may want to rebase your work onto a single branch each time instead of merging branches together.
+The reason to prefer rebasing is that Subversion has a linear history and doesn’t deal with merges like Git does, so git svn follows only the first parent when converting the snapshots into Subversion commits.
+
+
+
Suppose your history looks like the following: you created an experiment branch, did two commits, and then merged them back into master.
+When you dcommit, you see output like this:
+
+
+
+
$ git svn dcommit
+Committing to file:///tmp/test-svn/trunk ...
+ M CHANGES.txt
+Committed r89
+ M CHANGES.txt
+r89 = 89d492c884ea7c834353563d5d913c6adf933981 (refs/remotes/origin/trunk)
+ M COPYING.txt
+ M INSTALL.txt
+Committed r90
+ M INSTALL.txt
+ M COPYING.txt
+r90 = cb522197870e61467473391799148f6721bcf9a0 (refs/remotes/origin/trunk)
+No changes between 71af502c214ba13123992338569f4669877f55fd and refs/remotes/origin/trunk
+Resetting to the latest refs/remotes/origin/trunk
+
+
+
+
Running dcommit on a branch with merged history works fine, except that when you look at your Git project history, it hasn’t rewritten either of the commits you made on the experiment branch – instead, all those changes appear in the SVN version of the single merge commit.
+
+
+
When someone else clones that work, all they see is the merge commit with all the work squashed into it, as though you ran git merge --squash; they don’t see the commit data about where it came from or when it was committed.
+
+
+
+
Subversion Branching
+
+
Branching in Subversion isn’t the same as branching in Git; if you can avoid using it much, that’s probably best.
+However, you can create and commit to branches in Subversion using git svn.
+
+
+
+
Creating a New SVN Branch
+
+
To create a new branch in Subversion, you run git svn branch [new-branch]:
+
+
+
+
$ git svn branch opera
+Copying file:///tmp/test-svn/trunk at r90 to file:///tmp/test-svn/branches/opera...
+Found possible branch point: file:///tmp/test-svn/trunk => file:///tmp/test-svn/branches/opera, 90
+Found branch parent: (refs/remotes/origin/opera) cb522197870e61467473391799148f6721bcf9a0
+Following parent with do_switch
+Successfully followed parent
+r91 = f1b64a3855d3c8dd84ee0ef10fa89d27f1584302 (refs/remotes/origin/opera)
+
+
+
+
This does the equivalent of the svn copy trunk branches/opera command in Subversion and operates on the Subversion server.
+It’s important to note that it doesn’t check you out into that branch; if you commit at this point, that commit will go to trunk on the server, not opera.
+
+
+
+
Switching Active Branches
+
+
Git figures out what branch your dcommits go to by looking for the tip of any of your Subversion branches in your history – you should have only one, and it should be the last one with a git-svn-id in your current branch history.
+
+
+
If you want to work on more than one branch simultaneously, you can set up local branches to dcommit to specific Subversion branches by starting them at the imported Subversion commit for that branch.
+If you want an opera branch that you can work on separately, you can run
+
+
+
+
$ git branch opera remotes/origin/opera
+
+
+
+
Now, if you want to merge your opera branch into trunk (your master branch), you can do so with a normal git merge.
+But you need to provide a descriptive commit message (via -m), or the merge will say “Merge branch opera” instead of something useful.
+
+
+
Remember that although you’re using git merge to do this operation, and the merge likely will be much easier than it would be in Subversion (because Git will automatically detect the appropriate merge base for you), this isn’t a normal Git merge commit.
+You have to push this data back to a Subversion server that can’t handle a commit that tracks more than one parent; so, after you push it up, it will look like a single commit that squashed in all the work of another branch under a single commit.
+After you merge one branch into another, you can’t easily go back and continue working on that branch, as you normally can in Git.
+The dcommit command that you run erases any information that says what branch was merged in, so subsequent merge-base calculations will be wrong – the dcommit makes your git merge result look like you ran git merge --squash.
+Unfortunately, there’s no good way to avoid this situation – Subversion can’t store this information, so you’ll always be crippled by its limitations while you’re using it as your server.
+To avoid issues, you should delete the local branch (in this case, opera) after you merge it into trunk.
+
+
+
+
Subversion Commands
+
+
The git svn toolset provides a number of commands to help ease the transition to Git by providing some functionality that’s similar to what you had in Subversion.
+Here are a few commands that give you what Subversion used to.
+
+
+
SVN Style History
+
+
If you’re used to Subversion and want to see your history in SVN output style, you can run git svn log to view your commit history in SVN formatting:
+
+
+
+
$ git svn log
+------------------------------------------------------------------------
+r87 | schacon | 2014-05-02 16:07:37 -0700 (Sat, 02 May 2014) | 2 lines
+
+autogen change
+
+------------------------------------------------------------------------
+r86 | schacon | 2014-05-02 16:00:21 -0700 (Sat, 02 May 2014) | 2 lines
+
+Merge branch 'experiment'
+
+------------------------------------------------------------------------
+r85 | schacon | 2014-05-02 16:00:09 -0700 (Sat, 02 May 2014) | 2 lines
+
+updated the changelog
+
+
+
+
You should know two important things about git svn log.
+First, it works offline, unlike the real svn log command, which asks the Subversion server for the data.
+Second, it only shows you commits that have been committed up to the Subversion server.
+Local Git commits that you haven’t dcommited don’t show up; neither do commits that people have made to the Subversion server in the meantime.
+It’s more like the last known state of the commits on the Subversion server.
+
+
+
+
SVN Annotation
+
+
Much as the git svn log command simulates the svn log command offline, you can get the equivalent of svn annotate by running git svn blame [FILE].
+The output looks like this:
+
+
+
+
$ git svn blame README.txt
+ 2 temporal Protocol Buffers - Google's data interchange format
+ 2 temporal Copyright 2008 Google Inc.
+ 2 temporal http://code.google.com/apis/protocolbuffers/
+ 2 temporal
+22 temporal C++ Installation - Unix
+22 temporal =======================
+ 2 temporal
+79 schacon Committing in git-svn.
+78 schacon
+ 2 temporal To build and install the C++ Protocol Buffer runtime and the Protocol
+ 2 temporal Buffer compiler (protoc) execute the following:
+ 2 temporal
+
+
+
+
Again, it doesn’t show commits that you did locally in Git or that have been pushed to Subversion in the meantime.
+
+
+
+
+
+
You can also get the same sort of information that svn info gives you by running git svn info:
+
+
+
+
$ git svn info
+Path: .
+URL: https://schacon-test.googlecode.com/svn/trunk
+Repository Root: https://schacon-test.googlecode.com/svn
+Repository UUID: 4c93b258-373f-11de-be05-5f7a86268029
+Revision: 87
+Node Kind: directory
+Schedule: normal
+Last Changed Author: schacon
+Last Changed Rev: 87
+Last Changed Date: 2009-05-02 16:07:37 -0700 (Sat, 02 May 2009)
+
+
+
+
This is like blame and log in that it runs offline and is up to date only as of the last time you communicated with the Subversion server.
+
+
+
+
Ignoring What Subversion Ignores
+
+
If you clone a Subversion repository that has svn:ignore properties set anywhere, you’ll likely want to set corresponding .gitignore files so you don’t accidentally commit files that you shouldn’t.
+git svn has two commands to help with this issue.
+The first is git svn create-ignore, which automatically creates corresponding .gitignore files for you so your next commit can include them.
+
+
+
The second command is git svn show-ignore, which prints to stdout the lines you need to put in a .gitignore file so you can redirect the output into your project exclude file:
+
+
+
+
$ git svn show-ignore > .git/info/exclude
+
+
+
+
That way, you don’t litter the project with .gitignore files.
+This is a good option if you’re the only Git user on a Subversion team, and your teammates don’t want .gitignore files in the project.
+
+
+
+
+
Git-Svn Summary
+
+
The git svn tools are useful if you’re stuck with a Subversion server, or are otherwise in a development environment that necessitates running a Subversion server.
+You should consider it crippled Git, however, or you’ll hit issues in translation that may confuse you and your collaborators.
+To stay out of trouble, try to follow these guidelines:
+
+
+
+-
+
Keep a linear Git history that doesn’t contain merge commits made by git merge.
+Rebase any work you do outside of your mainline branch back onto it; don’t merge it in.
+
+-
+
Don’t set up and collaborate on a separate Git server.
+Possibly have one to speed up clones for new developers, but don’t push anything to it that doesn’t have a git-svn-id entry.
+You may even want to add a pre-receive hook that checks each commit message for a git-svn-id and rejects pushes that contain commits without it.
+
+
+
+
+
If you follow those guidelines, working with a Subversion server can be more bearable.
+However, if it’s possible to move to a real Git server, doing so can gain your team a lot more.
+
+
+
+
Git and Mercurial
+
+
+
+The DVCS universe is larger than just Git.
+In fact, there are many other systems in this space, each with their own angle on how to do distributed version control correctly.
+Apart from Git, the most popular is Mercurial, and the two are very similar in many respects.
+
+
+
The good news, if you prefer Git’s client-side behavior but are working with a project whose source code is controlled with Mercurial, is that there’s a way to use Git as a client for a Mercurial-hosted repository.
+Since the way Git talks to server repositories is through remotes, it should come as no surprise that this bridge is implemented as a remote helper.
+The project’s name is git-remote-hg, and it can be found at https://github.com/felipec/git-remote-hg.
+
+
+
git-remote-hg
+
+
First, you need to install git-remote-hg.
+This basically entails dropping its file somewhere in your path, like so:
+
+
+
+
$ curl -o ~/bin/git-remote-hg \
+ https://raw.githubusercontent.com/felipec/git-remote-hg/master/git-remote-hg
+$ chmod +x ~/bin/git-remote-hg
+
+
+
+
…assuming ~/bin is in your $PATH.
+Git-remote-hg has one other dependency: the mercurial library for Python.
+If you have Python installed, this is as simple as:
+
+
+
+
$ pip install mercurial
+
+
+
+
+
+
Now you’re ready to rock.
+All you need is a Mercurial repository you can push to.
+Fortunately, every Mercurial repository can act this way, so we’ll just use the "hello world" repository everyone uses to learn Mercurial:
+
+
+
+
$ hg clone http://selenic.com/repo/hello /tmp/hello
+
+
+
+
+
Getting Started
+
+
Now that we have a suitable “server-side” repository, we can go through a typical workflow.
+As you’ll see, these two systems are similar enough that there isn’t much friction.
+
+
+
As always with Git, first we clone:
+
+
+
+
$ git clone hg::/tmp/hello /tmp/hello-git
+$ cd /tmp/hello-git
+$ git log --oneline --graph --decorate
+* ac7955c (HEAD, origin/master, origin/branches/default, origin/HEAD, refs/hg/origin/branches/default, refs/hg/origin/bookmarks/master, master) Create a makefile
+* 65bb417 Create a standard 'hello, world' program
+
+
+
+
You’ll notice that working with a Mercurial repository uses the standard git clone command.
+That’s because git-remote-hg is working at a fairly low level, using a similar mechanism to how Git’s HTTP/S protocol is implemented (remote helpers).
+Since Git and Mercurial are both designed for every client to have a full copy of the repository history, this command makes a full clone, including all the project’s history, and does it fairly quickly.
+
+
+
The log command shows two commits, the latest of which is pointed to by a whole slew of refs.
+It turns out some of these aren’t actually there.
+Let’s take a look at what’s actually in the .git directory:
+
+
+
+
$ tree .git/refs
+.git/refs
+├── heads
+│ └── master
+├── hg
+│ └── origin
+│ ├── bookmarks
+│ │ └── master
+│ └── branches
+│ └── default
+├── notes
+│ └── hg
+├── remotes
+│ └── origin
+│ └── HEAD
+└── tags
+
+9 directories, 5 files
+
+
+
+
Git-remote-hg is trying to make things more idiomatically Git-esque, but under the hood it’s managing the conceptual mapping between two slightly different systems.
+The refs/hg directory is where the actual remote refs are stored.
+For example, the refs/hg/origin/branches/default is a Git ref file that contains the SHA-1 starting with “ac7955c”, which is the commit that master points to.
+So the refs/hg directory is kind of like a fake refs/remotes/origin, but it has the added distinction between bookmarks and branches.
+
+
+
The notes/hg file is the starting point for how git-remote-hg maps Git commit hashes to Mercurial changeset IDs.
+Let’s explore a bit:
+
+
+
+
$ cat notes/hg
+d4c10386...
+
+$ git cat-file -p d4c10386...
+tree 1781c96...
+author remote-hg <> 1408066400 -0800
+committer remote-hg <> 1408066400 -0800
+
+Notes for master
+
+$ git ls-tree 1781c96...
+100644 blob ac9117f... 65bb417...
+100644 blob 485e178... ac7955c...
+
+$ git cat-file -p ac9117f
+0a04b987be5ae354b710cefeba0e2d9de7ad41a9
+
+
+
+
So refs/notes/hg points to a tree, which in the Git object database is a list of other objects with names.
+git ls-tree outputs the mode, type, object hash, and filename for items inside a tree.
+Once we dig down to one of the tree items, we find that inside it is a blob named “ac9117f” (the SHA-1 hash of the commit pointed to by master), with contents “0a04b98” (which is the ID of the Mercurial changeset at the tip of the default branch).
+
+
+
The good news is that we mostly don’t have to worry about all of this.
+The typical workflow won’t be very different from working with a Git remote.
+
+
+
There’s one more thing we should attend to before we continue: ignores.
+Mercurial and Git use a very similar mechanism for this, but it’s likely you don’t want to actually commit a .gitignore file into a Mercurial repository.
+Fortunately, Git has a way to ignore files that’s local to an on-disk repository, and the Mercurial format is compatible with Git, so you just have to copy it over:
+
+
+
+
$ cp .hgignore .git/info/exclude
+
+
+
+
The .git/info/exclude file acts just like a .gitignore, but isn’t included in commits.
+
+
+
+
Workflow
+
+
Let’s assume we’ve done some work and made some commits on the master branch, and you’re ready to push it to the remote repository.
+Here’s what our repository looks like right now:
+
+
+
+
$ git log --oneline --graph --decorate
+* ba04a2a (HEAD, master) Update makefile
+* d25d16f Goodbye
+* ac7955c (origin/master, origin/branches/default, origin/HEAD, refs/hg/origin/branches/default, refs/hg/origin/bookmarks/master) Create a makefile
+* 65bb417 Create a standard 'hello, world' program
+
+
+
+
Our master branch is two commits ahead of origin/master, but those two commits exist only on our local machine.
+Let’s see if anyone else has been doing important work at the same time:
+
+
+
+
$ git fetch
+From hg::/tmp/hello
+ ac7955c..df85e87 master -> origin/master
+ ac7955c..df85e87 branches/default -> origin/branches/default
+$ git log --oneline --graph --decorate --all
+* 7b07969 (refs/notes/hg) Notes for default
+* d4c1038 Notes for master
+* df85e87 (origin/master, origin/branches/default, origin/HEAD, refs/hg/origin/branches/default, refs/hg/origin/bookmarks/master) Add some documentation
+| * ba04a2a (HEAD, master) Update makefile
+| * d25d16f Goodbye
+|/
+* ac7955c Create a makefile
+* 65bb417 Create a standard 'hello, world' program
+
+
+
+
Since we used the --all flag, we see the “notes” refs that are used internally by git-remote-hg, but we can ignore them.
+The rest is what we expected; origin/master has advanced by one commit, and our history has now diverged.
+Unlike the other systems we work with in this chapter, Mercurial is capable of handling merges, so we’re not going to do anything fancy.
+
+
+
+
$ git merge origin/master
+Auto-merging hello.c
+Merge made by the 'recursive' strategy.
+ hello.c | 2 +-
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+$ git log --oneline --graph --decorate
+* 0c64627 (HEAD, master) Merge remote-tracking branch 'origin/master'
+|\
+| * df85e87 (origin/master, origin/branches/default, origin/HEAD, refs/hg/origin/branches/default, refs/hg/origin/bookmarks/master) Add some documentation
+* | ba04a2a Update makefile
+* | d25d16f Goodbye
+|/
+* ac7955c Create a makefile
+* 65bb417 Create a standard 'hello, world' program
+
+
+
+
Perfect.
+We run the tests and everything passes, so we’re ready to share our work with the rest of the team:
+
+
+
+
$ git push
+To hg::/tmp/hello
+ df85e87..0c64627 master -> master
+
+
+
+
That’s it!
+If you take a look at the Mercurial repository, you’ll see that this did what we’d expect:
+
+
+
+
$ hg log -G --style compact
+o 5[tip]:4,2 dc8fa4f932b8 2014-08-14 19:33 -0700 ben
+|\ Merge remote-tracking branch 'origin/master'
+| |
+| o 4 64f27bcefc35 2014-08-14 19:27 -0700 ben
+| | Update makefile
+| |
+| o 3:1 4256fc29598f 2014-08-14 19:27 -0700 ben
+| | Goodbye
+| |
+@ | 2 7db0b4848b3c 2014-08-14 19:30 -0700 ben
+|/ Add some documentation
+|
+o 1 82e55d328c8c 2005-08-26 01:21 -0700 mpm
+| Create a makefile
+|
+o 0 0a04b987be5a 2005-08-26 01:20 -0700 mpm
+ Create a standard 'hello, world' program
+
+
+
+
The changeset numbered 2 was made by Mercurial, and the changesets numbered 3 and 4 were made by git-remote-hg, by pushing commits made with Git.
+
+
+
+
Branches and Bookmarks
+
+
Git has only one kind of branch: a reference that moves when commits are made.
+In Mercurial, this kind of a reference is called a “bookmark,” and it behaves in much the same way as a Git branch.
+
+
+
Mercurial’s concept of a “branch” is more heavyweight.
+The branch that a changeset is made on is recorded with the changeset, which means it will always be in the repository history.
+Here’s an example of a commit that was made on the develop branch:
+
+
+
+
$ hg log -l 1
+changeset: 6:8f65e5e02793
+branch: develop
+tag: tip
+user: Ben Straub <ben@straub.cc>
+date: Thu Aug 14 20:06:38 2014 -0700
+summary: More documentation
+
+
+
+
Note the line that begins with “branch”.
+Git can’t really replicate this (and doesn’t need to; both types of branch can be represented as a Git ref), but git-remote-hg needs to understand the difference, because Mercurial cares.
+
+
+
Creating Mercurial bookmarks is as easy as creating Git branches.
+On the Git side:
+
+
+
+
$ git checkout -b featureA
+Switched to a new branch 'featureA'
+$ git push origin featureA
+To hg::/tmp/hello
+ * [new branch] featureA -> featureA
+
+
+
+
That’s all there is to it.
+On the Mercurial side, it looks like this:
+
+
+
+
$ hg bookmarks
+ featureA 5:bd5ac26f11f9
+$ hg log --style compact -G
+@ 6[tip] 8f65e5e02793 2014-08-14 20:06 -0700 ben
+| More documentation
+|
+o 5[featureA]:4,2 bd5ac26f11f9 2014-08-14 20:02 -0700 ben
+|\ Merge remote-tracking branch 'origin/master'
+| |
+| o 4 0434aaa6b91f 2014-08-14 20:01 -0700 ben
+| | update makefile
+| |
+| o 3:1 318914536c86 2014-08-14 20:00 -0700 ben
+| | goodbye
+| |
+o | 2 f098c7f45c4f 2014-08-14 20:01 -0700 ben
+|/ Add some documentation
+|
+o 1 82e55d328c8c 2005-08-26 01:21 -0700 mpm
+| Create a makefile
+|
+o 0 0a04b987be5a 2005-08-26 01:20 -0700 mpm
+ Create a standard 'hello, world' program
+
+
+
+
Note the new [featureA] tag on revision 5.
+These act exactly like Git branches on the Git side, with one exception: you can’t delete a bookmark from the Git side (this is a limitation of remote helpers).
+
+
+
You can work on a “heavyweight” Mercurial branch also: just put a branch in the branches namespace:
+
+
+
+
$ git checkout -b branches/permanent
+Switched to a new branch 'branches/permanent'
+$ vi Makefile
+$ git commit -am 'A permanent change'
+$ git push origin branches/permanent
+To hg::/tmp/hello
+ * [new branch] branches/permanent -> branches/permanent
+
+
+
+
Here’s what that looks like on the Mercurial side:
+
+
+
+
$ hg branches
+permanent 7:a4529d07aad4
+develop 6:8f65e5e02793
+default 5:bd5ac26f11f9 (inactive)
+$ hg log -G
+o changeset: 7:a4529d07aad4
+| branch: permanent
+| tag: tip
+| parent: 5:bd5ac26f11f9
+| user: Ben Straub <ben@straub.cc>
+| date: Thu Aug 14 20:21:09 2014 -0700
+| summary: A permanent change
+|
+| @ changeset: 6:8f65e5e02793
+|/ branch: develop
+| user: Ben Straub <ben@straub.cc>
+| date: Thu Aug 14 20:06:38 2014 -0700
+| summary: More documentation
+|
+o changeset: 5:bd5ac26f11f9
+|\ bookmark: featureA
+| | parent: 4:0434aaa6b91f
+| | parent: 2:f098c7f45c4f
+| | user: Ben Straub <ben@straub.cc>
+| | date: Thu Aug 14 20:02:21 2014 -0700
+| | summary: Merge remote-tracking branch 'origin/master'
+[...]
+
+
+
+
The branch name “permanent” was recorded with the changeset marked 7.
+
+
+
From the Git side, working with either of these branch styles is the same: just checkout, commit, fetch, merge, pull, and push as you normally would.
+One thing you should know is that Mercurial doesn’t support rewriting history, only adding to it.
+Here’s what our Mercurial repository looks like after an interactive rebase and a force-push:
+
+
+
+
$ hg log --style compact -G
+o 10[tip] 99611176cbc9 2014-08-14 20:21 -0700 ben
+| A permanent change
+|
+o 9 f23e12f939c3 2014-08-14 20:01 -0700 ben
+| Add some documentation
+|
+o 8:1 c16971d33922 2014-08-14 20:00 -0700 ben
+| goodbye
+|
+| o 7:5 a4529d07aad4 2014-08-14 20:21 -0700 ben
+| | A permanent change
+| |
+| | @ 6 8f65e5e02793 2014-08-14 20:06 -0700 ben
+| |/ More documentation
+| |
+| o 5[featureA]:4,2 bd5ac26f11f9 2014-08-14 20:02 -0700 ben
+| |\ Merge remote-tracking branch 'origin/master'
+| | |
+| | o 4 0434aaa6b91f 2014-08-14 20:01 -0700 ben
+| | | update makefile
+| | |
++---o 3:1 318914536c86 2014-08-14 20:00 -0700 ben
+| | goodbye
+| |
+| o 2 f098c7f45c4f 2014-08-14 20:01 -0700 ben
+|/ Add some documentation
+|
+o 1 82e55d328c8c 2005-08-26 01:21 -0700 mpm
+| Create a makefile
+|
+o 0 0a04b987be5a 2005-08-26 01:20 -0700 mpm
+ Create a standard "hello, world" program
+
+
+
+
Changesets 8, 9, and 10 have been created and belong to the permanent branch, but the old changesets are still there.
+This can be very confusing for your teammates who are using Mercurial, so try to avoid it.
+
+
+
+
Mercurial Summary
+
+
Git and Mercurial are similar enough that working across the boundary is fairly painless.
+If you avoid changing history that’s left your machine (as is generally recommended), you may not even be aware that the other end is Mercurial.
+
+
+
+
Git and Bazaar
+
+
Among the DVCS, another famous one is Bazaar.
+Bazaar is free and open source, and is part of the GNU Project.
+It behaves very differently from Git.
+Sometimes, to do the same thing as with Git, you have to use a different keyword, and some keywords that are common don’t have the same meaning.
+In particular, the branch management is very different and may cause confusion, especially when someone comes from Git’s universe.
+Nevertheless, it is possible to work on a Bazaar repository from a Git one.
+
+
+
There are many projects that allow you to use Git as a Bazaar client.
+Here we’ll use Felipe Contreras' project that you may find at https://github.com/felipec/git-remote-bzr.
+To install it, you just have to download the file git-remote-bzr in a folder contained in your $PATH:
+
+
+
+
$ wget https://raw.github.com/felipec/git-remote-bzr/master/git-remote-bzr -O ~/bin/git-remote-bzr
+$ chmod +x ~/bin/git-remote-bzr
+
+
+
+
You also need to have Bazaar installed.
+That’s all!
+
+
+
Create a Git repository from a Bazaar repository
+
+
It is simple to use.
+It is enough to clone a Bazaar repository prefixing it by bzr::.
+Since Git and Bazaar both do full clones to your machine, it’s possible to attach a Git clone to your local Bazaar clone, but it isn’t recommended.
+It’s much easier to attach your Git clone directly to the same place your Bazaar clone is attached to ‒ the central repository.
+
+
+
Let’s suppose that you worked with a remote repository which is at address bzr+ssh://developer@mybazaarserver:myproject.
+Then you must clone it in the following way:
+
+
+
+
$ git clone bzr::bzr+ssh://developer@mybazaarserver:myproject myProject-Git
+$ cd myProject-Git
+
+
+
+
At this point, your Git repository is created but it is not compacted for optimal disk use.
+That’s why you should also clean and compact your Git repository, especially if it is a big one:
+
+
+
+
+
Bazaar branches
+
+
Bazaar only allows you to clone branches, but a repository may contain several branches, and git-remote-bzr can clone both.
+For example, to clone a branch:
+
+
+
+
$ git clone bzr::bzr://bzr.savannah.gnu.org/emacs/trunk emacs-trunk
+
+
+
+
And to clone the whole repository:
+
+
+
+
$ git clone bzr::bzr://bzr.savannah.gnu.org/emacs emacs
+
+
+
+
The second command clones all the branches contained in the emacs repository; nevertheless, it is possible to point out some branches:
+
+
+
+
$ git config remote-bzr.branches 'trunk, xwindow'
+
+
+
+
Some remote repositories don’t allow you to list their branches, in which case you have to manually specify them, and even though you could specify the configuration in the cloning command, you may find this easier:
+
+
+
+
$ git init emacs
+$ git remote add origin bzr::bzr://bzr.savannah.gnu.org/emacs
+$ git config remote-bzr.branches 'trunk, xwindow'
+$ git fetch
+
+
+
+
+
Ignore what is ignored with .bzrignore
+
+
Since you are working on a project managed with Bazaar, you shouldn’t create a .gitignore file because you may accidentally set it under version control and the other people working with Bazaar would be disturbed.
+The solution is to create the .git/info/exclude file either as a symbolic link or as a regular file.
+We’ll see later on how to solve this question.
+
+
+
Bazaar uses the same model as Git to ignore files, but also has two features which don’t have an equivalent into Git.
+The complete description may be found in the documentation.
+The two features are:
+
+
+
+-
+
"!!" allows you to ignore certain file patterns even if they’re specified using a "!" rule.
+
+-
+
"RE:" at the beginning of a line allows you to specify a Python regular expression (Git only allows shell globs).
+
+
+
+
+
As a consequence, there are two different situations to consider:
+
+
+
+-
+
If the .bzrignore file does not contain any of these two specific prefixes, then you can simply make a symbolic link to it in the repository: ln -s .bzrignore .git/info/exclude
+
+-
+
Otherwise, you must create the .git/info/exclude file and adapt it to ignore exactly the same files in .bzrignore.
+
+
+
+
+
Whatever the case is, you will have to remain vigilant against any change of .bzrignore to make sure that the .git/info/exclude file always reflects .bzrignore.
+Indeed, if the .bzrignore file were to change and contained one or more lines starting with "!!" or "RE:", Git not being able to interpret these lines, you’ll have to adapt your .git/info/exclude file to ignore the same files as the ones ignored with .bzrignore.
+Moreover, if the .git/info/exclude file was a symbolic link, you’ll have to first delete the symbolic link, copy .bzrignore to .git/info/exclude and then adapt the latter.
+However, be careful with its creation because with Git it is impossible to re-include a file if a parent directory of that file is excluded.
+
+
+
+
Fetch the changes of the remote repository
+
+
To fetch the changes of the remote, you pull changes as usually, using Git commands.
+Supposing that your changes are on the master branch, you merge or rebase your work on the origin/master branch:
+
+
+
+
$ git pull --rebase origin
+
+
+
+
+
Push your work on the remote repository
+
+
Because Bazaar also has the concept of merge commits, there will be no problem if you push a merge commit.
+So you can work on a branch, merge the changes into master and push your work.
+Then, you create your branches, you test and commit your work as usual.
+You finally push your work to the Bazaar repository:
+
+
+
+
$ git push origin master
+
+
+
+
+
Caveats
+
+
Git’s remote-helpers framework has some limitations that apply.
+In particular, these commands don’t work:
+
+
+
+-
+
git push origin :branch-to-delete (Bazaar can’t accept ref deletions in this way.)
+
+-
+
git push origin old:new (it will push old)
+
+-
+
git push --dry-run origin branch (it will push)
+
+
+
+
+
+
Summary
+
+
Since Git’s and Bazaar’s models are similar, there isn’t a lot of resistance when working across the boundary.
+As long as you watch out for the limitations, and are always aware that the remote repository isn’t natively Git, you’ll be fine.
+
+
+
+
Git and Perforce
+
+
+
+Perforce is a very popular version-control system in corporate environments.
+It’s been around since 1995, which makes it the oldest system covered in this chapter.
+As such, it’s designed with the constraints of its day; it assumes you’re always connected to a single central server, and only one version is kept on the local disk.
+To be sure, its features and constraints are well-suited to several specific problems, but there are lots of projects using Perforce where Git would actually work better.
+
+
+
There are two options if you’d like to mix your use of Perforce and Git.
+The first one we’ll cover is the “Git Fusion” bridge from the makers of Perforce, which lets you expose subtrees of your Perforce depot as read-write Git repositories.
+The second is git-p4, a client-side bridge that lets you use Git as a Perforce client, without requiring any reconfiguration of the Perforce server.
+
+
+
Git Fusion
+
+
+Perforce provides a product called Git Fusion (available at http://www.perforce.com/git-fusion), which synchronizes a Perforce server with Git repositories on the server side.
+
+
+
Setting Up
+
+
For our examples, we’ll be using the easiest installation method for Git Fusion, which is downloading a virtual machine that runs the Perforce daemon and Git Fusion.
+You can get the virtual machine image from http://www.perforce.com/downloads/Perforce/20-User, and once it’s finished downloading, import it into your favorite virtualization software (we’ll use VirtualBox).
+
+
+
Upon first starting the machine, it asks you to customize the password for three Linux users (root, perforce, and git), and provide an instance name, which can be used to distinguish this installation from others on the same network.
+When that has all completed, you’ll see this:
+
+
+
+
}}" alt="The Git Fusion virtual machine boot screen.">
+
+
نمودار 146. The Git Fusion virtual machine boot screen.
+
+
+
You should take note of the IP address that’s shown here, we’ll be using it later on.
+Next, we’ll create a Perforce user.
+Select the “Login” option at the bottom and press enter (or SSH to the machine), and log in as root.
+Then use these commands to create a user:
+
+
+
+
$ p4 -p localhost:1666 -u super user -f john
+$ p4 -p localhost:1666 -u john passwd
+$ exit
+
+
+
+
The first one will open a VI editor to customize the user, but you can accept the defaults by typing :wq and hitting enter.
+The second one will prompt you to enter a password twice.
+That’s all we need to do with a shell prompt, so exit out of the session.
+
+
+
The next thing you’ll need to do to follow along is to tell Git not to verify SSL certificates.
+The Git Fusion image comes with a certificate, but it’s for a domain that won’t match your virtual machine’s IP address, so Git will reject the HTTPS connection.
+If this is going to be a permanent installation, consult the Perforce Git Fusion manual to install a different certificate; for our example purposes, this will suffice:
+
+
+
+
$ export GIT_SSL_NO_VERIFY=true
+
+
+
+
Now we can test that everything is working.
+
+
+
+
$ git clone https://10.0.1.254/Talkhouse
+Cloning into 'Talkhouse'...
+Username for 'https://10.0.1.254': john
+Password for 'https://john@10.0.1.254':
+remote: Counting objects: 630, done.
+remote: Compressing objects: 100% (581/581), done.
+remote: Total 630 (delta 172), reused 0 (delta 0)
+Receiving objects: 100% (630/630), 1.22 MiB | 0 bytes/s, done.
+Resolving deltas: 100% (172/172), done.
+Checking connectivity... done.
+
+
+
+
The virtual-machine image comes equipped with a sample project that you can clone.
+Here we’re cloning over HTTPS, with the john user that we created above; Git asks for credentials for this connection, but the credential cache will allow us to skip this step for any subsequent requests.
+
+
+
+
Fusion Configuration
+
+
Once you’ve got Git Fusion installed, you’ll want to tweak the configuration.
+This is actually fairly easy to do using your favorite Perforce client; just map the //.git-fusion directory on the Perforce server into your workspace.
+The file structure looks like this:
+
+
+
+
$ tree
+.
+├── objects
+│ ├── repos
+│ │ └── [...]
+│ └── trees
+│ └── [...]
+│
+├── p4gf_config
+├── repos
+│ └── Talkhouse
+│ └── p4gf_config
+└── users
+ └── p4gf_usermap
+
+498 directories, 287 files
+
+
+
+
The objects directory is used internally by Git Fusion to map Perforce objects to Git and vice versa, you won’t have to mess with anything in there.
+There’s a global p4gf_config file in this directory, as well as one for each repository – these are the configuration files that determine how Git Fusion behaves.
+Let’s take a look at the file in the root:
+
+
+
+
[repo-creation]
+charset = utf8
+
+[git-to-perforce]
+change-owner = author
+enable-git-branch-creation = yes
+enable-swarm-reviews = yes
+enable-git-merge-commits = yes
+enable-git-submodules = yes
+preflight-commit = none
+ignore-author-permissions = no
+read-permission-check = none
+git-merge-avoidance-after-change-num = 12107
+
+[perforce-to-git]
+http-url = none
+ssh-url = none
+
+[@features]
+imports = False
+chunked-push = False
+matrix2 = False
+parallel-push = False
+
+[authentication]
+email-case-sensitivity = no
+
+
+
+
We won’t go into the meanings of these flags here, but note that this is just an INI-formatted text file, much like Git uses for configuration.
+This file specifies the global options, which can then be overridden by repository-specific configuration files, like repos/Talkhouse/p4gf_config.
+If you open this file, you’ll see a [@repo] section with some settings that are different from the global defaults.
+You’ll also see sections that look like this:
+
+
+
+
[Talkhouse-master]
+git-branch-name = master
+view = //depot/Talkhouse/main-dev/... ...
+
+
+
+
This is a mapping between a Perforce branch and a Git branch.
+The section can be named whatever you like, so long as the name is unique.
+git-branch-name lets you convert a depot path that would be cumbersome under Git to a more friendly name.
+The view setting controls how Perforce files are mapped into the Git repository, using the standard view mapping syntax.
+More than one mapping can be specified, like in this example:
+
+
+
+
[multi-project-mapping]
+git-branch-name = master
+view = //depot/project1/main/... project1/...
+ //depot/project2/mainline/... project2/...
+
+
+
+
This way, if your normal workspace mapping includes changes in the structure of the directories, you can replicate that with a Git repository.
+
+
+
The last file we’ll discuss is users/p4gf_usermap, which maps Perforce users to Git users, and which you may not even need.
+When converting from a Perforce changeset to a Git commit, Git Fusion’s default behavior is to look up the Perforce user, and use the email address and full name stored there for the author/committer field in Git.
+When converting the other way, the default is to look up the Perforce user with the email address stored in the Git commit’s author field, and submit the changeset as that user (with permissions applying).
+In most cases, this behavior will do just fine, but consider the following mapping file:
+
+
+
+
john john@example.com "John Doe"
+john johnny@appleseed.net "John Doe"
+bob employeeX@example.com "Anon X. Mouse"
+joe employeeY@example.com "Anon Y. Mouse"
+
+
+
+
Each line is of the format <user> <email> "<full name>", and creates a single user mapping.
+The first two lines map two distinct email addresses to the same Perforce user account.
+This is useful if you’ve created Git commits under several different email addresses (or change email addresses), but want them to be mapped to the same Perforce user.
+When creating a Git commit from a Perforce changeset, the first line matching the Perforce user is used for Git authorship information.
+
+
+
The last two lines mask Bob and Joe’s actual names and email addresses from the Git commits that are created.
+This is nice if you want to open-source an internal project, but don’t want to publish your employee directory to the entire world.
+Note that the email addresses and full names should be unique, unless you want all the Git commits to be attributed to a single fictional author.
+
+
+
+
Workflow
+
+
Perforce Git Fusion is a two-way bridge between Perforce and Git version control.
+Let’s have a look at how it feels to work from the Git side.
+We’ll assume we’ve mapped in the “Jam” project using a configuration file as shown above, which we can clone like this:
+
+
+
+
$ git clone https://10.0.1.254/Jam
+Cloning into 'Jam'...
+Username for 'https://10.0.1.254': john
+Password for 'https://john@10.0.1.254':
+remote: Counting objects: 2070, done.
+remote: Compressing objects: 100% (1704/1704), done.
+Receiving objects: 100% (2070/2070), 1.21 MiB | 0 bytes/s, done.
+remote: Total 2070 (delta 1242), reused 0 (delta 0)
+Resolving deltas: 100% (1242/1242), done.
+Checking connectivity... done.
+$ git branch -a
+* master
+ remotes/origin/HEAD -> origin/master
+ remotes/origin/master
+ remotes/origin/rel2.1
+$ git log --oneline --decorate --graph --all
+* 0a38c33 (origin/rel2.1) Create Jam 2.1 release branch.
+| * d254865 (HEAD, origin/master, origin/HEAD, master) Upgrade to latest metrowerks on Beos -- the Intel one.
+| * bd2f54a Put in fix for jam's NT handle leak.
+| * c0f29e7 Fix URL in a jam doc
+| * cc644ac Radstone's lynx port.
+[...]
+
+
+
+
The first time you do this, it may take some time.
+What’s happening is that Git Fusion is converting all the applicable changesets in the Perforce history into Git commits.
+This happens locally on the server, so it’s relatively fast, but if you have a lot of history, it can still take some time.
+Subsequent fetches do incremental conversion, so it’ll feel more like Git’s native speed.
+
+
+
As you can see, our repository looks exactly like any other Git repository you might work with.
+There are three branches, and Git has helpfully created a local master branch that tracks origin/master.
+Let’s do a bit of work, and create a couple of new commits:
+
+
+
+
# ...
+$ git log --oneline --decorate --graph --all
+* cfd46ab (HEAD, master) Add documentation for new feature
+* a730d77 Whitespace
+* d254865 (origin/master, origin/HEAD) Upgrade to latest metrowerks on Beos -- the Intel one.
+* bd2f54a Put in fix for jam's NT handle leak.
+[...]
+
+
+
+
We have two new commits.
+Now let’s check if anyone else has been working:
+
+
+
+
$ git fetch
+remote: Counting objects: 5, done.
+remote: Compressing objects: 100% (3/3), done.
+remote: Total 3 (delta 2), reused 0 (delta 0)
+Unpacking objects: 100% (3/3), done.
+From https://10.0.1.254/Jam
+ d254865..6afeb15 master -> origin/master
+$ git log --oneline --decorate --graph --all
+* 6afeb15 (origin/master, origin/HEAD) Update copyright
+| * cfd46ab (HEAD, master) Add documentation for new feature
+| * a730d77 Whitespace
+|/
+* d254865 Upgrade to latest metrowerks on Beos -- the Intel one.
+* bd2f54a Put in fix for jam's NT handle leak.
+[...]
+
+
+
+
It looks like someone was!
+You wouldn’t know it from this view, but the 6afeb15 commit was actually created using a Perforce client.
+It just looks like another commit from Git’s point of view, which is exactly the point.
+Let’s see how the Perforce server deals with a merge commit:
+
+
+
+
$ git merge origin/master
+Auto-merging README
+Merge made by the 'recursive' strategy.
+ README | 2 +-
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+$ git push
+Counting objects: 9, done.
+Delta compression using up to 8 threads.
+Compressing objects: 100% (9/9), done.
+Writing objects: 100% (9/9), 917 bytes | 0 bytes/s, done.
+Total 9 (delta 6), reused 0 (delta 0)
+remote: Perforce: 100% (3/3) Loading commit tree into memory...
+remote: Perforce: 100% (5/5) Finding child commits...
+remote: Perforce: Running git fast-export...
+remote: Perforce: 100% (3/3) Checking commits...
+remote: Processing will continue even if connection is closed.
+remote: Perforce: 100% (3/3) Copying changelists...
+remote: Perforce: Submitting new Git commit objects to Perforce: 4
+To https://10.0.1.254/Jam
+ 6afeb15..89cba2b master -> master
+
+
+
+
Git thinks it worked.
+Let’s take a look at the history of the README file from Perforce’s point of view, using the revision graph feature of p4v:
+
+
+
+
}}" alt="Perforce revision graph resulting from Git push.">
+
+
نمودار 147. Perforce revision graph resulting from Git push.
+
+
+
If you’ve never seen this view before, it may seem confusing, but it shows the same concepts as a graphical viewer for Git history.
+We’re looking at the history of the README file, so the directory tree at top left only shows that file as it surfaces in various branches.
+At top right, we have a visual graph of how different revisions of the file are related, and the big-picture view of this graph is at bottom right.
+The rest of the view is given to the details view for the selected revision (2 in this case).
+
+
+
One thing to notice is that the graph looks exactly like the one in Git’s history.
+Perforce didn’t have a named branch to store the 1 and 2 commits, so it made an “anonymous” branch in the .git-fusion directory to hold it.
+This will also happen for named Git branches that don’t correspond to a named Perforce branch (and you can later map them to a Perforce branch using the configuration file).
+
+
+
Most of this happens behind the scenes, but the end result is that one person on a team can be using Git, another can be using Perforce, and neither of them will know about the other’s choice.
+
+
+
+
Git-Fusion Summary
+
+
If you have (or can get) access to your Perforce server, Git Fusion is a great way to make Git and Perforce talk to each other.
+There’s a bit of configuration involved, but the learning curve isn’t very steep.
+This is one of the few sections in this chapter where cautions about using Git’s full power will not appear.
+That’s not to say that Perforce will be happy with everything you throw at it – if you try to rewrite history that’s already been pushed, Git Fusion will reject it – but Git Fusion tries very hard to feel native.
+You can even use Git submodules (though they’ll look strange to Perforce users), and merge branches (this will be recorded as an integration on the Perforce side).
+
+
+
If you can’t convince the administrator of your server to set up Git Fusion, there is still a way to use these tools together.
+
+
+
+
+
Git-p4
+
+
+Git-p4 is a two-way bridge between Git and Perforce.
+It runs entirely inside your Git repository, so you won’t need any kind of access to the Perforce server (other than user credentials, of course).
+Git-p4 isn’t as flexible or complete a solution as Git Fusion, but it does allow you to do most of what you’d want to do without being invasive to the server environment.
+
+
+
+
Setting Up
+
+
For example purposes, we’ll be running the Perforce server from the Git Fusion OVA as shown above, but we’ll bypass the Git Fusion server and go directly to the Perforce version control.
+
+
+
In order to use the p4 command-line client (which git-p4 depends on), you’ll need to set a couple of environment variables:
+
+
+
+
$ export P4PORT=10.0.1.254:1666
+$ export P4USER=john
+
+
+
+
+
Getting Started
+
+
As with anything in Git, the first command is to clone:
+
+
+
+
$ git p4 clone //depot/www/live www-shallow
+Importing from //depot/www/live into www-shallow
+Initialized empty Git repository in /private/tmp/www-shallow/.git/
+Doing initial import of //depot/www/live/ from revision #head into refs/remotes/p4/master
+
+
+
+
This creates what in Git terms is a “shallow” clone; only the very latest Perforce revision is imported into Git; remember, Perforce isn’t designed to give every revision to every user.
+This is enough to use Git as a Perforce client, but for other purposes it’s not enough.
+
+
+
Once it’s finished, we have a fully-functional Git repository:
+
+
+
+
$ cd myproject
+$ git log --oneline --all --graph --decorate
+* 70eaf78 (HEAD, p4/master, p4/HEAD, master) Initial import of //depot/www/live/ from the state at revision #head
+
+
+
+
Note how there’s a “p4” remote for the Perforce server, but everything else looks like a standard clone.
+Actually, that’s a bit misleading; there isn’t actually a remote there.
+
+
+
+
No remotes exist in this repository at all.
+Git-p4 has created some refs to represent the state of the server, and they look like remote refs to git log, but they’re not managed by Git itself, and you can’t push to them.
+
+
+
+
Workflow
+
+
Okay, let’s do some work.
+Let’s assume you’ve made some progress on a very important feature, and you’re ready to show it to the rest of your team.
+
+
+
+
$ git log --oneline --all --graph --decorate
+* 018467c (HEAD, master) Change page title
+* c0fb617 Update link
+* 70eaf78 (p4/master, p4/HEAD) Initial import of //depot/www/live/ from the state at revision #head
+
+
+
+
We’ve made two new commits that we’re ready to submit to the Perforce server.
+Let’s check if anyone else was working today:
+
+
+
+
$ git p4 sync
+git p4 sync
+Performing incremental import into refs/remotes/p4/master git branch
+Depot paths: //depot/www/live/
+Import destination: refs/remotes/p4/master
+Importing revision 12142 (100%)
+$ git log --oneline --all --graph --decorate
+* 75cd059 (p4/master, p4/HEAD) Update copyright
+| * 018467c (HEAD, master) Change page title
+| * c0fb617 Update link
+|/
+* 70eaf78 Initial import of //depot/www/live/ from the state at revision #head
+
+
+
+
Looks like they were, and master and p4/master have diverged.
+Perforce’s branching system is nothing like Git’s, so submitting merge commits doesn’t make any sense.
+Git-p4 recommends that you rebase your commits, and even comes with a shortcut to do so:
+
+
+
+
$ git p4 rebase
+Performing incremental import into refs/remotes/p4/master git branch
+Depot paths: //depot/www/live/
+No changes to import!
+Rebasing the current branch onto remotes/p4/master
+First, rewinding head to replay your work on top of it...
+Applying: Update link
+Applying: Change page title
+ index.html | 2 +-
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+
+
+
+
You can probably tell from the output, but git p4 rebase is a shortcut for git p4 sync followed by git rebase p4/master.
+It’s a bit smarter than that, especially when working with multiple branches, but this is a good approximation.
+
+
+
Now our history is linear again, and we’re ready to contribute our changes back to Perforce.
+The git p4 submit command will try to create a new Perforce revision for every Git commit between p4/master and master.
+Running it drops us into our favorite editor, and the contents of the file look something like this:
+
+
+
+
# A Perforce Change Specification.
+#
+# Change: The change number. 'new' on a new changelist.
+# Date: The date this specification was last modified.
+# Client: The client on which the changelist was created. Read-only.
+# User: The user who created the changelist.
+# Status: Either 'pending' or 'submitted'. Read-only.
+# Type: Either 'public' or 'restricted'. Default is 'public'.
+# Description: Comments about the changelist. Required.
+# Jobs: What opened jobs are to be closed by this changelist.
+# You may delete jobs from this list. (New changelists only.)
+# Files: What opened files from the default changelist are to be added
+# to this changelist. You may delete files from this list.
+# (New changelists only.)
+
+Change: new
+
+Client: john_bens-mbp_8487
+
+User: john
+
+Status: new
+
+Description:
+ Update link
+
+Files:
+ //depot/www/live/index.html # edit
+
+
+######## git author ben@straub.cc does not match your p4 account.
+######## Use option --preserve-user to modify authorship.
+######## Variable git-p4.skipUserNameCheck hides this message.
+######## everything below this line is just the diff #######
+--- //depot/www/live/index.html 2014-08-31 18:26:05.000000000 0000
++++ /Users/ben/john_bens-mbp_8487/john_bens-mbp_8487/depot/www/live/index.html 2014-08-31 18:26:05.000000000 0000
+@@ -60,7 +60,7 @@
+ </td>
+ <td valign=top>
+ Source and documentation for
+-<a href="http://www.perforce.com/jam/jam.html">
++<a href="jam.html">
+ Jam/MR</a>,
+ a software build tool.
+ </td>
+
+
+
+
This is mostly the same content you’d see by running p4 submit, except the stuff at the end which git-p4 has helpfully included.
+Git-p4 tries to honor your Git and Perforce settings individually when it has to provide a name for a commit or changeset, but in some cases you want to override it.
+For example, if the Git commit you’re importing was written by a contributor who doesn’t have a Perforce user account, you may still want the resulting changeset to look like they wrote it (and not you).
+
+
+
Git-p4 has helpfully imported the message from the Git commit as the content for this Perforce changeset, so all we have to do is save and quit, twice (once for each commit).
+The resulting shell output will look something like this:
+
+
+
+
$ git p4 submit
+Perforce checkout for depot path //depot/www/live/ located at /Users/ben/john_bens-mbp_8487/john_bens-mbp_8487/depot/www/live/
+Synchronizing p4 checkout...
+... - file(s) up-to-date.
+Applying dbac45b Update link
+//depot/www/live/index.html#4 - opened for edit
+Change 12143 created with 1 open file(s).
+Submitting change 12143.
+Locking 1 files ...
+edit //depot/www/live/index.html#5
+Change 12143 submitted.
+Applying 905ec6a Change page title
+//depot/www/live/index.html#5 - opened for edit
+Change 12144 created with 1 open file(s).
+Submitting change 12144.
+Locking 1 files ...
+edit //depot/www/live/index.html#6
+Change 12144 submitted.
+All commits applied!
+Performing incremental import into refs/remotes/p4/master git branch
+Depot paths: //depot/www/live/
+Import destination: refs/remotes/p4/master
+Importing revision 12144 (100%)
+Rebasing the current branch onto remotes/p4/master
+First, rewinding head to replay your work on top of it...
+$ git log --oneline --all --graph --decorate
+* 775a46f (HEAD, p4/master, p4/HEAD, master) Change page title
+* 05f1ade Update link
+* 75cd059 Update copyright
+* 70eaf78 Initial import of //depot/www/live/ from the state at revision #head
+
+
+
+
The result is as though we just did a git push, which is the closest analogy to what actually did happen.
+
+
+
Note that during this process every Git commit is turned into a Perforce changeset; if you want to squash them down into a single changeset, you can do that with an interactive rebase before running git p4 submit.
+Also note that the SHA-1 hashes of all the commits that were submitted as changesets have changed; this is because git-p4 adds a line to the end of each commit it converts:
+
+
+
+
$ git log -1
+commit 775a46f630d8b46535fc9983cf3ebe6b9aa53145
+Author: John Doe <john@example.com>
+Date: Sun Aug 31 10:31:44 2014 -0800
+
+ Change page title
+
+ [git-p4: depot-paths = "//depot/www/live/": change = 12144]
+
+
+
+
What happens if you try to submit a merge commit?
+Let’s give it a try.
+Here’s the situation we’ve gotten ourselves into:
+
+
+
+
$ git log --oneline --all --graph --decorate
+* 3be6fd8 (HEAD, master) Correct email address
+* 1dcbf21 Merge remote-tracking branch 'p4/master'
+|\
+| * c4689fc (p4/master, p4/HEAD) Grammar fix
+* | cbacd0a Table borders: yes please
+* | b4959b6 Trademark
+|/
+* 775a46f Change page title
+* 05f1ade Update link
+* 75cd059 Update copyright
+* 70eaf78 Initial import of //depot/www/live/ from the state at revision #head
+
+
+
+
The Git and Perforce history diverge after 775a46f.
+The Git side has two commits, then a merge commit with the Perforce head, then another commit.
+We’re going to try to submit these on top of a single changeset on the Perforce side.
+Let’s see what would happen if we tried to submit now:
+
+
+
+
$ git p4 submit -n
+Perforce checkout for depot path //depot/www/live/ located at /Users/ben/john_bens-mbp_8487/john_bens-mbp_8487/depot/www/live/
+Would synchronize p4 checkout in /Users/ben/john_bens-mbp_8487/john_bens-mbp_8487/depot/www/live/
+Would apply
+ b4959b6 Trademark
+ cbacd0a Table borders: yes please
+ 3be6fd8 Correct email address
+
+
+
+
The -n flag is short for --dry-run, which tries to report what would happen if the submit command were run for real.
+In this case, it looks like we’d be creating three Perforce changesets, which correspond to the three non-merge commits that don’t yet exist on the Perforce server.
+That sounds like exactly what we want, let’s see how it turns out:
+
+
+
+
$ git p4 submit
+[…]
+$ git log --oneline --all --graph --decorate
+* dadbd89 (HEAD, p4/master, p4/HEAD, master) Correct email address
+* 1b79a80 Table borders: yes please
+* 0097235 Trademark
+* c4689fc Grammar fix
+* 775a46f Change page title
+* 05f1ade Update link
+* 75cd059 Update copyright
+* 70eaf78 Initial import of //depot/www/live/ from the state at revision #head
+
+
+
+
Our history became linear, just as though we had rebased before submitting (which is in fact exactly what happened).
+This means you can be free to create, work on, throw away, and merge branches on the Git side without fear that your history will somehow become incompatible with Perforce.
+If you can rebase it, you can contribute it to a Perforce server.
+
+
+
+
Branching
+
+
If your Perforce project has multiple branches, you’re not out of luck; git-p4 can handle that in a way that makes it feel like Git.
+Let’s say your Perforce depot is laid out like this:
+
+
+
+
//depot
+ └── project
+ ├── main
+ └── dev
+
+
+
+
And let’s say you have a dev branch, which has a view spec that looks like this:
+
+
+
+
//depot/project/main/... //depot/project/dev/...
+
+
+
+
Git-p4 can automatically detect that situation and do the right thing:
+
+
+
+
$ git p4 clone --detect-branches //depot/project@all
+Importing from //depot/project@all into project
+Initialized empty Git repository in /private/tmp/project/.git/
+Importing revision 20 (50%)
+ Importing new branch project/dev
+
+ Resuming with change 20
+Importing revision 22 (100%)
+Updated branches: main dev
+$ cd project; git log --oneline --all --graph --decorate
+* eae77ae (HEAD, p4/master, p4/HEAD, master) main
+| * 10d55fb (p4/project/dev) dev
+| * a43cfae Populate //depot/project/main/... //depot/project/dev/....
+|/
+* 2b83451 Project init
+
+
+
+
Note the “@all” specifier in the depot path; that tells git-p4 to clone not just the latest changeset for that subtree, but all changesets that have ever touched those paths.
+This is closer to Git’s concept of a clone, but if you’re working on a project with a long history, it could take a while.
+
+
+
The --detect-branches flag tells git-p4 to use Perforce’s branch specs to map the branches to Git refs.
+If these mappings aren’t present on the Perforce server (which is a perfectly valid way to use Perforce), you can tell git-p4 what the branch mappings are, and you get the same result:
+
+
+
+
$ git init project
+Initialized empty Git repository in /tmp/project/.git/
+$ cd project
+$ git config git-p4.branchList main:dev
+$ git clone --detect-branches //depot/project@all .
+
+
+
+
Setting the git-p4.branchList configuration variable to main:dev tells git-p4 that “main” and “dev” are both branches, and the second one is a child of the first one.
+
+
+
If we now git checkout -b dev p4/project/dev and make some commits, git-p4 is smart enough to target the right branch when we do git p4 submit.
+Unfortunately, git-p4 can’t mix shallow clones and multiple branches; if you have a huge project and want to work on more than one branch, you’ll have to git p4 clone once for each branch you want to submit to.
+
+
+
For creating or integrating branches, you’ll have to use a Perforce client.
+Git-p4 can only sync and submit to existing branches, and it can only do it one linear changeset at a time.
+If you merge two branches in Git and try to submit the new changeset, all that will be recorded is a bunch of file changes; the metadata about which branches are involved in the integration will be lost.
+
+
+
+
+
Git and Perforce Summary
+
+
Git-p4 makes it possible to use a Git workflow with a Perforce server, and it’s pretty good at it.
+However, it’s important to remember that Perforce is in charge of the source, and you’re only using Git to work locally.
+Just be really careful about sharing Git commits; if you have a remote that other people use, don’t push any commits that haven’t already been submitted to the Perforce server.
+
+
+
If you want to freely mix the use of Perforce and Git as clients for source control, and you can convince the server administrator to install it, Git Fusion makes using Git a first-class version-control client for a Perforce server.
+
+
+
+
Git and TFS
+
+
+
+Git is becoming popular with Windows developers, and if you’re writing code on Windows, there’s a good chance you’re using Microsoft’s Team Foundation Server (TFS).
+TFS is a collaboration suite that includes defect and work-item tracking, process support for Scrum and others, code review, and version control.
+There’s a bit of confusion ahead: TFS is the server, which supports controlling source code using both Git and their own custom VCS, which they’ve dubbed TFVC (Team Foundation Version Control).
+Git support is a somewhat new feature for TFS (shipping with the 2013 version), so all of the tools that predate that refer to the version-control portion as “TFS”, even though they’re mostly working with TFVC.
+
+
+
If you find yourself on a team that’s using TFVC but you’d rather use Git as your version-control client, there’s a project for you.
+
+
+
+
+
+In fact, there are two: git-tf and git-tfs.
+
+
+
Git-tfs (found at https://github.com/git-tfs/git-tfs) is a .NET project, and (as of this writing) it only runs on Windows.
+To work with Git repositories, it uses the .NET bindings for libgit2, a library-oriented implementation of Git which is highly performant and allows a lot of flexibility with the guts of a Git repository.
+Libgit2 is not a complete implementation of Git, so to cover the difference git-tfs will actually call the command-line Git client for some operations, so there are no artificial limits on what it can do with Git repositories.
+Its support of TFVC features is very mature, since it uses the Visual Studio assemblies for operations with servers.
+This does mean you’ll need access to those assemblies, which means you need to install a recent version of Visual Studio (any edition since version 2010, including Express since version 2012), or the Visual Studio SDK.
+
+
+
+
+|
+ گوشزد
+ |
+
+
+ Git-tf is End-of-Life (EOL), it will not get any updates.
+It is also no longer supported by Microsoft.
+ |
+
+
+
+
+
Git-tf (whose home is at https://archive.codeplex.com/?p=gittf) is a Java project, and as such runs on any computer with a Java runtime environment.
+It interfaces with Git repositories through JGit (a JVM implementation of Git), which means it has virtually no limitations in terms of Git functions.
+However, its support for TFVC is limited as compared to git-tfs – it does not support branches, for instance.
+
+
+
So each tool has pros and cons, and there are plenty of situations that favor one over the other.
+We’ll cover the basic usage of both of them in this book.
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ You’ll need access to a TFVC-based repository to follow along with these instructions.
+These aren’t as plentiful in the wild as Git or Subversion repositories, so you may need to create one of your own.
+Codeplex (https://archive.codeplex.com/) or Visual Studio Online (https://visualstudio.microsoft.com) are both good choices for this.
+ |
+
+
+
+
+
+
Getting Started: git-tf
+
+
+
The first thing you do, just as with any Git project, is clone.
+Here’s what that looks like with git-tf:
+
+
+
+
$ git tf clone https://tfs.codeplex.com:443/tfs/TFS13 $/myproject/Main project_git
+
+
+
+
The first argument is the URL of a TFVC collection, the second is of the form $/project/branch, and the third is the path to the local Git repository that is to be created (this last one is optional).
+Git-tf can only work with one branch at a time; if you want to make checkins on a different TFVC branch, you’ll have to make a new clone from that branch.
+
+
+
This creates a fully functional Git repository:
+
+
+
+
$ cd project_git
+$ git log --all --oneline --decorate
+512e75a (HEAD, tag: TFS_C35190, origin_tfs/tfs, master) Checkin message
+
+
+
+
This is called a shallow clone, meaning that only the latest changeset has been downloaded.
+TFVC isn’t designed for each client to have a full copy of the history, so git-tf defaults to only getting the latest version, which is much faster.
+
+
+
If you have some time, it’s probably worth it to clone the entire project history, using the --deep option:
+
+
+
+
$ git tf clone https://tfs.codeplex.com:443/tfs/TFS13 $/myproject/Main \
+ project_git --deep
+Username: domain\user
+Password:
+Connecting to TFS...
+Cloning $/myproject into /tmp/project_git: 100%, done.
+Cloned 4 changesets. Cloned last changeset 35190 as d44b17a
+$ cd project_git
+$ git log --all --oneline --decorate
+d44b17a (HEAD, tag: TFS_C35190, origin_tfs/tfs, master) Goodbye
+126aa7b (tag: TFS_C35189)
+8f77431 (tag: TFS_C35178) FIRST
+0745a25 (tag: TFS_C35177) Created team project folder $/tfvctest via the \
+ Team Project Creation Wizard
+
+
+
+
Notice the tags with names like TFS_C35189; this is a feature that helps you know which Git commits are associated with TFVC changesets.
+This is a nice way to represent it, since you can see with a simple log command which of your commits is associated with a snapshot that also exists in TFVC.
+They aren’t necessary (and in fact you can turn them off with git config git-tf.tag false) – git-tf keeps the real commit-changeset mappings in the .git/git-tf file.
+
+
+
+
Getting Started: git-tfs
+
+
+
Git-tfs cloning behaves a bit differently.
+Observe:
+
+
+
+
PS> git tfs clone --with-branches \
+ https://username.visualstudio.com/DefaultCollection \
+ $/project/Trunk project_git
+Initialized empty Git repository in C:/Users/ben/project_git/.git/
+C15 = b75da1aba1ffb359d00e85c52acb261e4586b0c9
+C16 = c403405f4989d73a2c3c119e79021cb2104ce44a
+Tfs branches found:
+- $/tfvc-test/featureA
+The name of the local branch will be : featureA
+C17 = d202b53f67bde32171d5078968c644e562f1c439
+C18 = 44cd729d8df868a8be20438fdeeefb961958b674
+
+
+
+
Notice the --with-branches flag.
+Git-tfs is capable of mapping TFVC branches to Git branches, and this flag tells it to set up a local Git branch for every TFVC branch.
+This is highly recommended if you’ve ever branched or merged in TFS, but it won’t work with a server older than TFS 2010 – before that release, “branches” were just folders, so git-tfs can’t tell them from regular folders.
+
+
+
Let’s take a look at the resulting Git repository:
+
+
+
+
PS> git log --oneline --graph --decorate --all
+* 44cd729 (tfs/featureA, featureA) Goodbye
+* d202b53 Branched from $/tfvc-test/Trunk
+* c403405 (HEAD, tfs/default, master) Hello
+* b75da1a New project
+PS> git log -1
+commit c403405f4989d73a2c3c119e79021cb2104ce44a
+Author: Ben Straub <ben@straub.cc>
+Date: Fri Aug 1 03:41:59 2014 +0000
+
+ Hello
+
+ git-tfs-id: [https://username.visualstudio.com/DefaultCollection]$/myproject/Trunk;C16
+
+
+
+
There are two local branches, master and featureA, which represent the initial starting point of the clone (Trunk in TFVC) and a child branch (featureA in TFVC).
+You can also see that the tfs “remote” has a couple of refs too: default and featureA, which represent TFVC branches.
+Git-tfs maps the branch you cloned from to tfs/default, and others get their own names.
+
+
+
Another thing to notice is the git-tfs-id: lines in the commit messages.
+Instead of tags, git-tfs uses these markers to relate TFVC changesets to Git commits.
+This has the implication that your Git commits will have a different SHA-1 hash before and after they have been pushed to TFVC.
+
+
+
+
Git-tf[s] Workflow
+
+
+
+|
+ یادداشت
+ |
+
+
+ Regardless of which tool you’re using, you should set a couple of Git configuration values to avoid running into issues.
+
+
+ $ git config set --local core.ignorecase=true
+$ git config set --local core.autocrlf=false
+
+ |
+
+
+
+
+
The obvious next thing you’re going to want to do is work on the project.
+TFVC and TFS have several features that may add complexity to your workflow:
+
+
+
+-
+
Feature branches that aren’t represented in TFVC add a bit of complexity.
+This has to do with the very different ways that TFVC and Git represent branches.
+
+-
+
Be aware that TFVC allows users to “checkout” files from the server, locking them so nobody else can edit them.
+This obviously won’t stop you from editing them in your local repository, but it could get in the way when it comes time to push your changes up to the TFVC server.
+
+-
+
TFS has the concept of “gated” checkins, where a TFS build-test cycle has to complete successfully before the checkin is allowed.
+This uses the “shelve” function in TFVC, which we don’t cover in detail here.
+ You can fake this in a manual fashion with git-tf, and git-tfs provides the checkintool command which is gate-aware.
+
+
+
+
+
In the interest of brevity, what we’ll cover here is the happy path, which sidesteps or avoids most of these issues.
+
+
+
+
Workflow: git-tf
+
+
+
Let’s say you’ve done some work, made a couple of Git commits on master, and you’re ready to share your progress on the TFVC server.
+Here’s our Git repository:
+
+
+
+
$ git log --oneline --graph --decorate --all
+* 4178a82 (HEAD, master) update code
+* 9df2ae3 update readme
+* d44b17a (tag: TFS_C35190, origin_tfs/tfs) Goodbye
+* 126aa7b (tag: TFS_C35189)
+* 8f77431 (tag: TFS_C35178) FIRST
+* 0745a25 (tag: TFS_C35177) Created team project folder $/tfvctest via the \
+ Team Project Creation Wizard
+
+
+
+
We want to take the snapshot that’s in the 4178a82 commit and push it up to the TFVC server.
+First things first: let’s see if any of our teammates did anything since we last connected:
+
+
+
+
$ git tf fetch
+Username: domain\user
+Password:
+Connecting to TFS...
+Fetching $/myproject at latest changeset: 100%, done.
+Downloaded changeset 35320 as commit 8ef06a8. Updated FETCH_HEAD.
+$ git log --oneline --graph --decorate --all
+* 8ef06a8 (tag: TFS_C35320, origin_tfs/tfs) just some text
+| * 4178a82 (HEAD, master) update code
+| * 9df2ae3 update readme
+|/
+* d44b17a (tag: TFS_C35190) Goodbye
+* 126aa7b (tag: TFS_C35189)
+* 8f77431 (tag: TFS_C35178) FIRST
+* 0745a25 (tag: TFS_C35177) Created team project folder $/tfvctest via the \
+ Team Project Creation Wizard
+
+
+
+
Looks like someone else is working, too, and now we have divergent history.
+This is where Git shines, but we have two choices of how to proceed:
+
+
+
+-
+
Making a merge commit feels natural as a Git user (after all, that’s what git pull does), and git-tf can do this for you with a simple git tf pull.
+Be aware, however, that TFVC doesn’t think this way, and if you push merge commits your history will start to look different on both sides, which can be confusing.
+However, if you plan on submitting all of your changes as one changeset, this is probably the easiest choice.
+
+-
+
Rebasing makes our commit history linear, which means we have the option of converting each of our Git commits into a TFVC changeset.
+Since this leaves the most options open, we recommend you do it this way; git-tf even makes it easy for you with git tf pull --rebase.
+
+
+
+
+
The choice is yours.
+For this example, we’ll be rebasing:
+
+
+
+
$ git rebase FETCH_HEAD
+First, rewinding head to replay your work on top of it...
+Applying: update readme
+Applying: update code
+$ git log --oneline --graph --decorate --all
+* 5a0e25e (HEAD, master) update code
+* 6eb3eb5 update readme
+* 8ef06a8 (tag: TFS_C35320, origin_tfs/tfs) just some text
+* d44b17a (tag: TFS_C35190) Goodbye
+* 126aa7b (tag: TFS_C35189)
+* 8f77431 (tag: TFS_C35178) FIRST
+* 0745a25 (tag: TFS_C35177) Created team project folder $/tfvctest via the \
+ Team Project Creation Wizard
+
+
+
+
Now we’re ready to make a checkin to the TFVC server.
+Git-tf gives you the choice of making a single changeset that represents all the changes since the last one (--shallow, which is the default) and creating a new changeset for each Git commit (--deep).
+For this example, we’ll just create one changeset:
+
+
+
+
$ git tf checkin -m 'Updating readme and code'
+Username: domain\user
+Password:
+Connecting to TFS...
+Checking in to $/myproject: 100%, done.
+Checked commit 5a0e25e in as changeset 35348
+$ git log --oneline --graph --decorate --all
+* 5a0e25e (HEAD, tag: TFS_C35348, origin_tfs/tfs, master) update code
+* 6eb3eb5 update readme
+* 8ef06a8 (tag: TFS_C35320) just some text
+* d44b17a (tag: TFS_C35190) Goodbye
+* 126aa7b (tag: TFS_C35189)
+* 8f77431 (tag: TFS_C35178) FIRST
+* 0745a25 (tag: TFS_C35177) Created team project folder $/tfvctest via the \
+ Team Project Creation Wizard
+
+
+
+
There’s a new TFS_C35348 tag, indicating that TFVC is storing the exact same snapshot as the 5a0e25e commit.
+It’s important to note that not every Git commit needs to have an exact counterpart in TFVC; the 6eb3eb5 commit, for example, doesn’t exist anywhere on the server.
+
+
+
That’s the main workflow.
+There are a couple of other considerations you’ll want to keep in mind:
+
+
+
+-
+
There is no branching.
+Git-tf can only create Git repositories from one TFVC branch at a time.
+
+-
+
Collaborate using either TFVC or Git, but not both.
+Different git-tf clones of the same TFVC repository may have different commit SHA-1 hashes, which will cause no end of headaches.
+
+-
+
If your team’s workflow includes collaborating in Git and syncing periodically with TFVC, only connect to TFVC with one of the Git repositories.
+
+
+
+
+
+
Workflow: git-tfs
+
+
+
Let’s walk through the same scenario using git-tfs.
+Here are the new commits we’ve made to the master branch in our Git repository:
+
+
+
+
PS> git log --oneline --graph --all --decorate
+* c3bd3ae (HEAD, master) update code
+* d85e5a2 update readme
+| * 44cd729 (tfs/featureA, featureA) Goodbye
+| * d202b53 Branched from $/tfvc-test/Trunk
+|/
+* c403405 (tfs/default) Hello
+* b75da1a New project
+
+
+
+
Now let’s see if anyone else has done work while we were hacking away:
+
+
+
+
PS> git tfs fetch
+C19 = aea74a0313de0a391940c999e51c5c15c381d91d
+PS> git log --all --oneline --graph --decorate
+* aea74a0 (tfs/default) update documentation
+| * c3bd3ae (HEAD, master) update code
+| * d85e5a2 update readme
+|/
+| * 44cd729 (tfs/featureA, featureA) Goodbye
+| * d202b53 Branched from $/tfvc-test/Trunk
+|/
+* c403405 Hello
+* b75da1a New project
+
+
+
+
Yes, it turns out our coworker has added a new TFVC changeset, which shows up as the new aea74a0 commit, and the tfs/default remote branch has moved.
+
+
+
As with git-tf, we have two fundamental options for how to resolve this divergent history:
+
+
+
+-
+
Rebase to preserve a linear history.
+
+-
+
Merge to preserve what actually happened.
+
+
+
+
+
In this case, we’re going to do a “deep” checkin, where every Git commit becomes a TFVC changeset, so we want to rebase.
+
+
+
+
PS> git rebase tfs/default
+First, rewinding head to replay your work on top of it...
+Applying: update readme
+Applying: update code
+PS> git log --all --oneline --graph --decorate
+* 10a75ac (HEAD, master) update code
+* 5cec4ab update readme
+* aea74a0 (tfs/default) update documentation
+| * 44cd729 (tfs/featureA, featureA) Goodbye
+| * d202b53 Branched from $/tfvc-test/Trunk
+|/
+* c403405 Hello
+* b75da1a New project
+
+
+
+
Now we’re ready to complete our contribution by checking in our code to the TFVC server.
+We’ll use the rcheckin command here to create a TFVC changeset for each Git commit in the path from HEAD to the first tfs remote branch found (the checkin command would only create one changeset, sort of like squashing Git commits).
+
+
+
+
PS> git tfs rcheckin
+Working with tfs remote: default
+Fetching changes from TFS to minimize possibility of late conflict...
+Starting checkin of 5cec4ab4 'update readme'
+ add README.md
+C20 = 71a5ddce274c19f8fdc322b4f165d93d89121017
+Done with 5cec4ab4b213c354341f66c80cd650ab98dcf1ed, rebasing tail onto new TFS-commit...
+Rebase done successfully.
+Starting checkin of b1bf0f99 'update code'
+ edit .git\tfs\default\workspace\ConsoleApplication1/ConsoleApplication1/Program.cs
+C21 = ff04e7c35dfbe6a8f94e782bf5e0031cee8d103b
+Done with b1bf0f9977b2d48bad611ed4a03d3738df05ea5d, rebasing tail onto new TFS-commit...
+Rebase done successfully.
+No more to rcheckin.
+PS> git log --all --oneline --graph --decorate
+* ff04e7c (HEAD, tfs/default, master) update code
+* 71a5ddc update readme
+* aea74a0 update documentation
+| * 44cd729 (tfs/featureA, featureA) Goodbye
+| * d202b53 Branched from $/tfvc-test/Trunk
+|/
+* c403405 Hello
+* b75da1a New project
+
+
+
+
Notice how after every successful checkin to the TFVC server, git-tfs is rebasing the remaining work onto what it just did.
+That’s because it’s adding the git-tfs-id field to the bottom of the commit messages, which changes the SHA-1 hashes.
+This is exactly as designed, and there’s nothing to worry about, but you should be aware that it’s happening, especially if you’re sharing Git commits with others.
+
+
+
TFS has many features that integrate with its version control system, such as work items, designated reviewers, gated checkins, and so on.
+It can be cumbersome to work with these features using only a command-line tool, but fortunately git-tfs lets you launch a graphical checkin tool very easily:
+
+
+
+
PS> git tfs checkintool
+PS> git tfs ct
+
+
+
+
It looks a bit like this:
+
+
+
+
}}" alt="The git-tfs checkin tool.">
+
+
نمودار 148. The git-tfs checkin tool.
+
+
+
This will look familiar to TFS users, as it’s the same dialog that’s launched from within Visual Studio.
+
+
+
Git-tfs also lets you control TFVC branches from your Git repository.
+As an example, let’s create one:
+
+
+
+
PS> git tfs branch $/tfvc-test/featureBee
+The name of the local branch will be : featureBee
+C26 = 1d54865c397608c004a2cadce7296f5edc22a7e5
+PS> git log --oneline --graph --decorate --all
+* 1d54865 (tfs/featureBee) Creation branch $/myproject/featureBee
+* ff04e7c (HEAD, tfs/default, master) update code
+* 71a5ddc update readme
+* aea74a0 update documentation
+| * 44cd729 (tfs/featureA, featureA) Goodbye
+| * d202b53 Branched from $/tfvc-test/Trunk
+|/
+* c403405 Hello
+* b75da1a New project
+
+
+
+
Creating a branch in TFVC means adding a changeset where that branch now exists, and this is projected as a Git commit.
+Note also that git-tfs created the tfs/featureBee remote branch, but HEAD is still pointing to master.
+If you want to work on the newly-minted branch, you’ll want to base your new commits on the 1d54865 commit, perhaps by creating a topic branch from that commit.
+
+
+
+
Git and TFS Summary
+
+
Git-tf and Git-tfs are both great tools for interfacing with a TFVC server.
+They allow you to use the power of Git locally, avoid constantly having to round-trip to the central TFVC server, and make your life as a developer much easier, without forcing your entire team to migrate to Git.
+If you’re working on Windows (which is likely if your team is using TFS), you’ll probably want to use git-tfs, since its feature set is more complete, but if you’re working on another platform, you’ll be using git-tf, which is more limited.
+As with most of the tools in this chapter, you should choose one of these version-control systems to be canonical, and use the other one in a subordinate fashion – either Git or TFVC should be the center of collaboration, but not both.
+
+
+
Migrating to Git
+
+
+If you have an existing codebase in another VCS but you’ve decided to start using Git, you must migrate your project one way or another.
+This section goes over some importers for common systems, and then demonstrates how to develop your own custom importer.
+You’ll learn how to import data from several of the bigger professionally used SCM systems, because they make up the majority of users who are switching, and because high-quality tools for them are easy to come by.
+
+
Subversion
+
+
+
+If you read the previous section about using git svn, you can easily use those instructions to git svn clone a repository; then, stop using the Subversion server, push to a new Git server, and start using that.
+If you want the history, you can accomplish that as quickly as you can pull the data out of the Subversion server (which may take a while).
+
+
+
However, the import isn’t perfect; and because it will take so long, you may as well do it right.
+The first problem is the author information.
+In Subversion, each person committing has a user on the system who is recorded in the commit information.
+The examples in the previous section show schacon in some places, such as the blame output and the git svn log.
+If you want to map this to better Git author data, you need a mapping from the Subversion users to the Git authors.
+Create a file called users.txt that has this mapping in a format like this:
+
+
+
+
schacon = Scott Chacon <schacon@geemail.com>
+selse = Someo Nelse <selse@geemail.com>
+
+
+
+
To get a list of the author names that SVN uses, you can run this:
+
+
+
+
$ svn log --xml --quiet | grep author | sort -u | \
+ perl -pe 's/.*>(.*?)<.*/$1 = /'
+
+
+
+
That generates the log output in XML format, then keeps only the lines with author information, discards duplicates, strips out the XML tags.
+Obviously this only works on a machine with grep, sort, and perl installed.
+Then, redirect that output into your users.txt file so you can add the equivalent Git user data next to each entry.
+
+
+
+
You can provide this file to git svn to help it map the author data more accurately.
+You can also tell git svn not to include the metadata that Subversion normally imports, by passing --no-metadata to the clone or init command.
+The metadata includes a git-svn-id inside each commit message that Git will generate during import.
+This can bloat your Git log and might make it a bit unclear.
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ You need to keep the metadata when you want to mirror commits made in the Git repository back into the original SVN repository.
+If you don’t want the synchronization in your commit log, feel free to omit the --no-metadata parameter.
+ |
+
+
+
+
+
This makes your import command look like this:
+
+
+
+
$ git svn clone http://my-project.googlecode.com/svn/ \
+ --authors-file=users.txt --no-metadata --prefix "" -s my_project
+$ cd my_project
+
+
+
+
Now you should have a nicer Subversion import in your my_project directory.
+Instead of commits that look like this
+
+
+
+
commit 37efa680e8473b615de980fa935944215428a35a
+Author: schacon <schacon@4c93b258-373f-11de-be05-5f7a86268029>
+Date: Sun May 3 00:12:22 2009 +0000
+
+ fixed install - go to trunk
+
+ git-svn-id: https://my-project.googlecode.com/svn/trunk@94 4c93b258-373f-11de-
+ be05-5f7a86268029
+
+
+
+
+
+
commit 03a8785f44c8ea5cdb0e8834b7c8e6c469be2ff2
+Author: Scott Chacon <schacon@geemail.com>
+Date: Sun May 3 00:12:22 2009 +0000
+
+ fixed install - go to trunk
+
+
+
+
Not only does the Author field look a lot better, but the git-svn-id is no longer there, either.
+
+
+
You should also do a bit of post-import cleanup.
+For one thing, you should clean up the weird references that git svn set up.
+First you’ll move the tags so they’re actual tags rather than strange remote branches, and then you’ll move the rest of the branches so they’re local.
+
+
+
To move the tags to be proper Git tags, run:
+
+
+
+
$ for t in $(git for-each-ref --format='%(refname:short)' refs/remotes/tags); do git tag ${t/tags\//} $t && git branch -D -r $t; done
+
+
+
+
This takes the references that were remote branches that started with refs/remotes/tags/ and makes them real (lightweight) tags.
+
+
+
Next, move the rest of the references under refs/remotes to be local branches:
+
+
+
+
$ for b in $(git for-each-ref --format='%(refname:short)' refs/remotes); do git branch $b refs/remotes/$b && git branch -D -r $b; done
+
+
+
+
It may happen that you’ll see some extra branches which are suffixed by @xxx (where xxx is a number), while in Subversion you only see one branch.
+This is actually a Subversion feature called “peg-revisions”, which is something that Git simply has no syntactical counterpart for.
+Hence, git svn simply adds the svn version number to the branch name just in the same way as you would have written it in svn to address the peg-revision of that branch.
+If you do not care anymore about the peg-revisions, simply remove them:
+
+
+
+
$ for p in $(git for-each-ref --format='%(refname:short)' | grep @); do git branch -D $p; done
+
+
+
+
Now all the old branches are real Git branches and all the old tags are real Git tags.
+
+
+
There’s one last thing to clean up.
+Unfortunately, git svn creates an extra branch named trunk, which maps to Subversion’s default branch, but the trunk ref points to the same place as master.
+Since master is more idiomatically Git, here’s how to remove the extra branch:
+
+
+
+
The last thing to do is add your new Git server as a remote and push to it.
+Here is an example of adding your server as a remote:
+
+
+
+
$ git remote add origin git@my-git-server:myrepository.git
+
+
+
+
Because you want all your branches and tags to go up, you can now run this:
+
+
+
+
$ git push origin --all
+$ git push origin --tags
+
+
+
+
All your branches and tags should be on your new Git server in a nice, clean import.
+
+
+
Mercurial
+
+
+Since Mercurial and Git have fairly similar models for representing versions, and since Git is a bit more flexible, converting a repository from Mercurial to Git is fairly straightforward, using a tool called "hg-fast-export", which you’ll need a copy of:
+
+
+
+
$ git clone https://github.com/frej/fast-export.git
+
+
+
+
The first step in the conversion is to get a full clone of the Mercurial repository you want to convert:
+
+
+
+
$ hg clone <remote repo URL> /tmp/hg-repo
+
+
+
+
The next step is to create an author mapping file.
+Mercurial is a bit more forgiving than Git for what it will put in the author field for changesets, so this is a good time to clean house.
+Generating this is a one-line command in a bash shell:
+
+
+
+
$ cd /tmp/hg-repo
+$ hg log | grep user: | sort | uniq | sed 's/user: *//' > ../authors
+
+
+
+
This will take a few seconds, depending on how long your project’s history is, and afterwards the /tmp/authors file will look something like this:
+
+
+
+
bob
+bob@localhost
+bob <bob@company.com>
+bob jones <bob <AT> company <DOT> com>
+Bob Jones <bob@company.com>
+Joe Smith <joe@company.com>
+
+
+
+
In this example, the same person (Bob) has created changesets under four different names, one of which actually looks correct, and one of which would be completely invalid for a Git commit.
+Hg-fast-export lets us fix this by turning each line into a rule: "<input>"="<output>", mapping an <input> to an <output>.
+Inside the <input> and <output> strings, all escape sequences understood by the python string_escape encoding are supported.
+If the author mapping file does not contain a matching <input>, that author will be sent on to Git unmodified.
+If all the usernames look fine, we won’t need this file at all.
+In this example, we want our file to look like this:
+
+
+
+
"bob"="Bob Jones <bob@company.com>"
+"bob@localhost"="Bob Jones <bob@company.com>"
+"bob <bob@company.com>"="Bob Jones <bob@company.com>"
+"bob jones <bob <AT> company <DOT> com>"="Bob Jones <bob@company.com>"
+
+
+
+
The same kind of mapping file can be used to rename branches and tags when the Mercurial name is not allowed by Git.
+
+
+
The next step is to create our new Git repository, and run the export script:
+
+
+
+
$ git init /tmp/converted
+$ cd /tmp/converted
+$ /tmp/fast-export/hg-fast-export.sh -r /tmp/hg-repo -A /tmp/authors
+
+
+
+
The -r flag tells hg-fast-export where to find the Mercurial repository we want to convert, and the -A flag tells it where to find the author-mapping file (branch and tag mapping files are specified by the -B and -T flags respectively).
+The script parses Mercurial changesets and converts them into a script for Git’s "fast-import" feature (which we’ll discuss in detail a bit later on).
+This takes a bit (though it’s much faster than it would be over the network), and the output is fairly verbose:
+
+
+
+
$ /tmp/fast-export/hg-fast-export.sh -r /tmp/hg-repo -A /tmp/authors
+Loaded 4 authors
+master: Exporting full revision 1/22208 with 13/0/0 added/changed/removed files
+master: Exporting simple delta revision 2/22208 with 1/1/0 added/changed/removed files
+master: Exporting simple delta revision 3/22208 with 0/1/0 added/changed/removed files
+[…]
+master: Exporting simple delta revision 22206/22208 with 0/4/0 added/changed/removed files
+master: Exporting simple delta revision 22207/22208 with 0/2/0 added/changed/removed files
+master: Exporting thorough delta revision 22208/22208 with 3/213/0 added/changed/removed files
+Exporting tag [0.4c] at [hg r9] [git :10]
+Exporting tag [0.4d] at [hg r16] [git :17]
+[…]
+Exporting tag [3.1-rc] at [hg r21926] [git :21927]
+Exporting tag [3.1] at [hg r21973] [git :21974]
+Issued 22315 commands
+git-fast-import statistics:
+---------------------------------------------------------------------
+Alloc'd objects: 120000
+Total objects: 115032 ( 208171 duplicates )
+ blobs : 40504 ( 205320 duplicates 26117 deltas of 39602 attempts)
+ trees : 52320 ( 2851 duplicates 47467 deltas of 47599 attempts)
+ commits: 22208 ( 0 duplicates 0 deltas of 0 attempts)
+ tags : 0 ( 0 duplicates 0 deltas of 0 attempts)
+Total branches: 109 ( 2 loads )
+ marks: 1048576 ( 22208 unique )
+ atoms: 1952
+Memory total: 7860 KiB
+ pools: 2235 KiB
+ objects: 5625 KiB
+---------------------------------------------------------------------
+pack_report: getpagesize() = 4096
+pack_report: core.packedGitWindowSize = 1073741824
+pack_report: core.packedGitLimit = 8589934592
+pack_report: pack_used_ctr = 90430
+pack_report: pack_mmap_calls = 46771
+pack_report: pack_open_windows = 1 / 1
+pack_report: pack_mapped = 340852700 / 340852700
+---------------------------------------------------------------------
+
+$ git shortlog -sn
+ 369 Bob Jones
+ 365 Joe Smith
+
+
+
+
That’s pretty much all there is to it.
+All of the Mercurial tags have been converted to Git tags, and Mercurial branches and bookmarks have been converted to Git branches.
+Now you’re ready to push the repository up to its new server-side home:
+
+
+
+
$ git remote add origin git@my-git-server:myrepository.git
+$ git push origin --all
+
+
+
+
Bazaar
+
+
+
Bazaar is a DVCS tool much like Git, and as a result it’s pretty straightforward to convert a Bazaar repository into a Git one.
+To accomplish this, you’ll need to import the bzr-fastimport plugin.
+
+
+
Getting the bzr-fastimport plugin
+
+
The procedure for installing the fastimport plugin is different on UNIX-like operating systems and on Windows.
+In the first case, the simplest is to install the bzr-fastimport package that will install all the required dependencies.
+
+
+
For example, with Debian and derived, you would do the following:
+
+
+
+
$ sudo apt-get install bzr-fastimport
+
+
+
+
With RHEL, you would do the following:
+
+
+
+
$ sudo yum install bzr-fastimport
+
+
+
+
With Fedora, since release 22, the new package manager is dnf:
+
+
+
+
$ sudo dnf install bzr-fastimport
+
+
+
+
If the package is not available, you may install it as a plugin:
+
+
+
+
$ mkdir --parents ~/.bazaar/plugins # creates the necessary folders for the plugins
+$ cd ~/.bazaar/plugins
+$ bzr branch lp:bzr-fastimport fastimport # imports the fastimport plugin
+$ cd fastimport
+$ sudo python setup.py install --record=files.txt # installs the plugin
+
+
+
+
For this plugin to work, you’ll also need the fastimport Python module.
+You can check whether it is present or not and install it with the following commands:
+
+
+
+
$ python -c "import fastimport"
+Traceback (most recent call last):
+ File "<string>", line 1, in <module>
+ImportError: No module named fastimport
+$ pip install fastimport
+
+
+
+
+
In the second case (on Windows), bzr-fastimport is automatically installed with the standalone version and the default installation (let all the checkboxes checked).
+So in this case you have nothing to do.
+
+
+
At this point, the way to import a Bazaar repository differs according to that you have a single branch or you are working with a repository that has several branches.
+
+
+
+
Project with a single branch
+
+
Now cd in the directory that contains your Bazaar repository and initialize the Git repository:
+
+
+
+
$ cd /path/to/the/bzr/repository
+$ git init
+
+
+
+
Now, you can simply export your Bazaar repository and convert it into a Git repository using the following command:
+
+
+
+
$ bzr fast-export --plain . | git fast-import
+
+
+
+
Depending on the size of the project, your Git repository is built in a lapse from a few seconds to a few minutes.
+
+
+
+
Case of a project with a main branch and a working branch
+
+
You can also import a Bazaar repository that contains branches.
+Let us suppose that you have two branches: one represents the main branch (myProject.trunk), the other one is the working branch (myProject.work).
+
+
+
+
$ ls
+myProject.trunk myProject.work
+
+
+
+
Create the Git repository and cd into it:
+
+
+
+
$ git init git-repo
+$ cd git-repo
+
+
+
+
Pull the master branch into git:
+
+
+
+
$ bzr fast-export --export-marks=../marks.bzr ../myProject.trunk | \
+git fast-import --export-marks=../marks.git
+
+
+
+
Pull the working branch into Git:
+
+
+
+
$ bzr fast-export --marks=../marks.bzr --git-branch=work ../myProject.work | \
+git fast-import --import-marks=../marks.git --export-marks=../marks.git
+
+
+
+
Now git branch shows you the master branch as well as the work branch.
+Check the logs to make sure they’re complete and get rid of the marks.bzr and marks.git files.
+
+
+
+
Synchronizing the staging area
+
+
Whatever the number of branches you had and the import method you used, your staging area is not synchronized with HEAD, and with the import of several branches, your working directory is not synchronized either.
+This situation is easily solved by the following command:
+
+
+
+
$ git reset --hard HEAD
+
+
+
+
+
Ignoring the files that were ignored with .bzrignore
+
+
Now let’s have a look at the files to ignore.
+The first thing to do is to rename .bzrignore into .gitignore.
+If the .bzrignore file contains one or several lines starting with "!!" or "RE:", you’ll have to modify it and perhaps create several .gitignore files in order to ignore exactly the same files that Bazaar was ignoring.
+
+
+
Finally, you will have to create a commit that contains this modification for the migration:
+
+
+
+
$ git mv .bzrignore .gitignore
+$ # modify .gitignore if needed
+$ git commit -am 'Migration from Bazaar to Git'
+
+
+
+
+
Sending your repository to the server
+
+
Here we are!
+Now you can push the repository onto its new home server:
+
+
+
+
$ git remote add origin git@my-git-server:mygitrepository.git
+$ git push origin --all
+$ git push origin --tags
+
+
+
+
Your Git repository is ready to use.
+
+
+
+
Perforce
+
+
+The next system you’ll look at importing from is Perforce.
+As we discussed above, there are two ways to let Git and Perforce talk to each other: git-p4 and Perforce Git Fusion.
+
+
+
Perforce Git Fusion
+
+
Git Fusion makes this process fairly painless.
+Just configure your project settings, user mappings, and branches using a configuration file (as discussed in Git Fusion), and clone the repository.
+Git Fusion leaves you with what looks like a native Git repository, which is then ready to push to a native Git host if you desire.
+You could even use Perforce as your Git host if you like.
+
+
+
+
Git-p4
+
+
Git-p4 can also act as an import tool.
+As an example, we’ll import the Jam project from the Perforce Public Depot.
+To set up your client, you must export the P4PORT environment variable to point to the Perforce depot:
+
+
+
+
$ export P4PORT=public.perforce.com:1666
+
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ In order to follow along, you’ll need a Perforce depot to connect with.
+We’ll be using the public depot at public.perforce.com for our examples, but you can use any depot you have access to.
+ |
+
+
+
+
+
+Run the git p4 clone command to import the Jam project from the Perforce server, supplying the depot and project path and the path into which you want to import the project:
+
+
+
+
$ git-p4 clone //guest/perforce_software/jam@all p4import
+Importing from //guest/perforce_software/jam@all into p4import
+Initialized empty Git repository in /private/tmp/p4import/.git/
+Import destination: refs/remotes/p4/master
+Importing revision 9957 (100%)
+
+
+
+
This particular project has only one branch, but if you have branches that are configured with branch views (or just a set of directories), you can use the --detect-branches flag to git p4 clone to import all the project’s branches as well.
+See Branching for a bit more detail on this.
+
+
+
At this point you’re almost done.
+If you go to the p4import directory and run git log, you can see your imported work:
+
+
+
+
$ git log -2
+commit e5da1c909e5db3036475419f6379f2c73710c4e6
+Author: giles <giles@giles@perforce.com>
+Date: Wed Feb 8 03:13:27 2012 -0800
+
+ Correction to line 355; change </UL> to </OL>.
+
+ [git-p4: depot-paths = "//public/jam/src/": change = 8068]
+
+commit aa21359a0a135dda85c50a7f7cf249e4f7b8fd98
+Author: kwirth <kwirth@perforce.com>
+Date: Tue Jul 7 01:35:51 2009 -0800
+
+ Fix spelling error on Jam doc page (cummulative -> cumulative).
+
+ [git-p4: depot-paths = "//public/jam/src/": change = 7304]
+
+
+
+
You can see that git-p4 has left an identifier in each commit message.
+It’s fine to keep that identifier there, in case you need to reference the Perforce change number later.
+However, if you’d like to remove the identifier, now is the time to do so – before you start doing work on the new repository.
+
+You can use git filter-branch to remove the identifier strings en masse:
+
+
+
+
$ git filter-branch --msg-filter 'sed -e "/^\[git-p4:/d"'
+Rewrite e5da1c909e5db3036475419f6379f2c73710c4e6 (125/125)
+Ref 'refs/heads/master' was rewritten
+
+
+
+
If you run git log, you can see that all the SHA-1 checksums for the commits have changed, but the git-p4 strings are no longer in the commit messages:
+
+
+
+
$ git log -2
+commit b17341801ed838d97f7800a54a6f9b95750839b7
+Author: giles <giles@giles@perforce.com>
+Date: Wed Feb 8 03:13:27 2012 -0800
+
+ Correction to line 355; change </UL> to </OL>.
+
+commit 3e68c2e26cd89cb983eb52c024ecdfba1d6b3fff
+Author: kwirth <kwirth@perforce.com>
+Date: Tue Jul 7 01:35:51 2009 -0800
+
+ Fix spelling error on Jam doc page (cummulative -> cumulative).
+
+
+
+
Your import is ready to push up to your new Git server.
+
+
+
+
TFS
+
+
+If your team is converting their source control from TFVC to Git, you’ll want the highest-fidelity conversion you can get.
+This means that, while we covered both git-tfs and git-tf for the interop section, we’ll only be covering git-tfs for this part, because git-tfs supports branches, and this is prohibitively difficult using git-tf.
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ This is a one-way conversion.
+The resulting Git repository won’t be able to connect with the original TFVC project.
+ |
+
+
+
+
+
The first thing to do is map usernames.
+TFVC is fairly liberal with what goes into the author field for changesets, but Git wants a human-readable name and email address.
+You can get this information from the tf command-line client, like so:
+
+
+
+
PS> tf history $/myproject -recursive > AUTHORS_TMP
+
+
+
+
This grabs all of the changesets in the history of the project and put it in the AUTHORS_TMP file that we will process to extract the data of the User column (the 2nd one).
+Open the file and find at which characters start and end the column and replace, in the following command-line, the parameters 11-20 of the cut command with the ones found:
+
+
+
+
PS> cat AUTHORS_TMP | cut -b 11-20 | tail -n+3 | sort | uniq > AUTHORS
+
+
+
+
The cut command keeps only the characters between 11 and 20 from each line.
+The tail command skips the first two lines, which are field headers and ASCII-art underlines.
+The result of all of this is piped to sort and uniq to eliminate duplicates, and saved to a file named AUTHORS.
+The next step is manual; in order for git-tfs to make effective use of this file, each line must be in this format:
+
+
+
+
DOMAIN\username = User Name <email@address.com>
+
+
+
+
The portion on the left is the “User” field from TFVC, and the portion on the right side of the equals sign is the user name that will be used for Git commits.
+
+
+
Once you have this file, the next thing to do is make a full clone of the TFVC project you’re interested in:
+
+
+
+
PS> git tfs clone --with-branches --authors=AUTHORS https://username.visualstudio.com/DefaultCollection $/project/Trunk project_git
+
+
+
+
Next you’ll want to clean the git-tfs-id sections from the bottom of the commit messages.
+The following command will do that:
+
+
+
+
PS> git filter-branch -f --msg-filter 'sed "s/^git-tfs-id:.*$//g"' '--' --all
+
+
+
+
That uses the sed command from the Git-bash environment to replace any line starting with “git-tfs-id:” with emptiness, which Git will then ignore.
+
+
+
Once that’s all done, you’re ready to add a new remote, push all your branches up, and have your team start working from Git.
+
+
+
A Custom Importer
+
+
+
+If your system isn’t one of the above, you should look for an importer online – quality importers are available for many other systems, including CVS, Clear Case, Visual Source Safe, even a directory of archives.
+If none of these tools works for you, you have a more obscure tool, or you otherwise need a more custom importing process, you should use git fast-import.
+This command reads simple instructions from stdin to write specific Git data.
+It’s much easier to create Git objects this way than to run the raw Git commands or try to write the raw objects (see Git Internals for more information).
+This way, you can write an import script that reads the necessary information out of the system you’re importing from and prints straightforward instructions to stdout.
+You can then run this program and pipe its output through git fast-import.
+
+
+
To quickly demonstrate, you’ll write a simple importer.
+Suppose you work in current, you back up your project by occasionally copying the directory into a time-stamped back_YYYY_MM_DD backup directory, and you want to import this into Git.
+Your directory structure looks like this:
+
+
+
+
$ ls /opt/import_from
+back_2014_01_02
+back_2014_01_04
+back_2014_01_14
+back_2014_02_03
+current
+
+
+
+
In order to import a Git directory, you need to review how Git stores its data.
+As you may remember, Git is fundamentally a linked list of commit objects that point to a snapshot of content.
+All you have to do is tell fast-import what the content snapshots are, what commit data points to them, and the order they go in.
+Your strategy will be to go through the snapshots one at a time and create commits with the contents of each directory, linking each commit back to the previous one.
+
+
+
As we did in An Example Git-Enforced Policy, we’ll write this in Ruby, because it’s what we generally work with and it tends to be easy to read.
+You can write this example pretty easily in anything you’re familiar with – it just needs to print the appropriate information to stdout.
+And, if you are running on Windows, this means you’ll need to take special care to not introduce carriage returns at the end your lines – git fast-import is very particular about just wanting line feeds (LF) not the carriage return line feeds (CRLF) that Windows uses.
+
+
+
To begin, you’ll change into the target directory and identify every subdirectory, each of which is a snapshot that you want to import as a commit.
+You’ll change into each subdirectory and print the commands necessary to export it.
+Your basic main loop looks like this:
+
+
+
+
last_mark = nil
+
+# loop through the directories
+Dir.chdir(ARGV[0]) do
+ Dir.glob("*").each do |dir|
+ next if File.file?(dir)
+
+ # move into the target directory
+ Dir.chdir(dir) do
+ last_mark = print_export(dir, last_mark)
+ end
+ end
+end
+
+
+
+
You run print_export inside each directory, which takes the manifest and mark of the previous snapshot and returns the manifest and mark of this one; that way, you can link them properly.
+“Mark” is the fast-import term for an identifier you give to a commit; as you create commits, you give each one a mark that you can use to link to it from other commits.
+So, the first thing to do in your print_export method is generate a mark from the directory name:
+
+
+
+
mark = convert_dir_to_mark(dir)
+
+
+
+
You’ll do this by creating an array of directories and using the index value as the mark, because a mark must be an integer.
+Your method looks like this:
+
+
+
+
$marks = []
+def convert_dir_to_mark(dir)
+ if !$marks.include?(dir)
+ $marks << dir
+ end
+ ($marks.index(dir) + 1).to_s
+end
+
+
+
+
Now that you have an integer representation of your commit, you need a date for the commit metadata.
+Because the date is expressed in the name of the directory, you’ll parse it out.
+The next line in your print_export file is:
+
+
+
+
date = convert_dir_to_date(dir)
+
+
+
+
where convert_dir_to_date is defined as:
+
+
+
+
def convert_dir_to_date(dir)
+ if dir == 'current'
+ return Time.now().to_i
+ else
+ dir = dir.gsub('back_', '')
+ (year, month, day) = dir.split('_')
+ return Time.local(year, month, day).to_i
+ end
+end
+
+
+
+
That returns an integer value for the date of each directory.
+The last piece of meta-information you need for each commit is the committer data, which you hardcode in a global variable:
+
+
+
+
$author = 'John Doe <john@example.com>'
+
+
+
+
Now you’re ready to begin printing out the commit data for your importer.
+The initial information states that you’re defining a commit object and what branch it’s on, followed by the mark you’ve generated, the committer information and commit message, and then the previous commit, if any.
+The code looks like this:
+
+
+
+
# print the import information
+puts 'commit refs/heads/master'
+puts 'mark :' + mark
+puts "committer #{$author} #{date} -0700"
+export_data('imported from ' + dir)
+puts 'from :' + last_mark if last_mark
+
+
+
+
You hardcode the time zone (-0700) because doing so is easy.
+If you’re importing from another system, you must specify the time zone as an offset.
+The commit message must be expressed in a special format:
+
+
+
+
data (size)\n(contents)
+
+
+
+
The format consists of the word data, the size of the data to be read, a newline, and finally the data.
+Because you need to use the same format to specify the file contents later, you create a helper method, export_data:
+
+
+
+
def export_data(string)
+ print "data #{string.size}\n#{string}"
+end
+
+
+
+
All that’s left is to specify the file contents for each snapshot.
+This is easy, because you have each one in a directory – you can print out the deleteall command followed by the contents of each file in the directory.
+Git will then record each snapshot appropriately:
+
+
+
+
puts 'deleteall'
+Dir.glob("**/*").each do |file|
+ next if !File.file?(file)
+ inline_data(file)
+end
+
+
+
+
Note: Because many systems think of their revisions as changes from one commit to another, fast-import can also take commands with each commit to specify which files have been added, removed, or modified and what the new contents are.
+You could calculate the differences between snapshots and provide only this data, but doing so is more complex – you may as well give Git all the data and let it figure it out.
+If this is better suited to your data, check the fast-import man page for details about how to provide your data in this manner.
+
+
+
The format for listing the new file contents or specifying a modified file with the new contents is as follows:
+
+
+
+
M 644 inline path/to/file
+data (size)
+(file contents)
+
+
+
+
Here, 644 is the mode (if you have executable files, you need to detect and specify 755 instead), and inline says you’ll list the contents immediately after this line.
+Your inline_data method looks like this:
+
+
+
+
def inline_data(file, code = 'M', mode = '644')
+ content = File.read(file)
+ puts "#{code} #{mode} inline #{file}"
+ export_data(content)
+end
+
+
+
+
You reuse the export_data method you defined earlier, because it’s the same as the way you specified your commit message data.
+
+
+
The last thing you need to do is to return the current mark so it can be passed to the next iteration:
+
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ If you are running on Windows you’ll need to make sure that you add one extra step.
+As mentioned before, Windows uses CRLF for new line characters while git fast-import expects only LF.
+To get around this problem and make git fast-import happy, you need to tell ruby to use LF instead of CRLF:
+ |
+
+
+
+
+
That’s it.
+Here’s the script in its entirety:
+
+
+
+
#!/usr/bin/env ruby
+
+$stdout.binmode
+$author = "John Doe <john@example.com>"
+
+$marks = []
+def convert_dir_to_mark(dir)
+ if !$marks.include?(dir)
+ $marks << dir
+ end
+ ($marks.index(dir)+1).to_s
+end
+
+def convert_dir_to_date(dir)
+ if dir == 'current'
+ return Time.now().to_i
+ else
+ dir = dir.gsub('back_', '')
+ (year, month, day) = dir.split('_')
+ return Time.local(year, month, day).to_i
+ end
+end
+
+def export_data(string)
+ print "data #{string.size}\n#{string}"
+end
+
+def inline_data(file, code='M', mode='644')
+ content = File.read(file)
+ puts "#{code} #{mode} inline #{file}"
+ export_data(content)
+end
+
+def print_export(dir, last_mark)
+ date = convert_dir_to_date(dir)
+ mark = convert_dir_to_mark(dir)
+
+ puts 'commit refs/heads/master'
+ puts "mark :#{mark}"
+ puts "committer #{$author} #{date} -0700"
+ export_data("imported from #{dir}")
+ puts "from :#{last_mark}" if last_mark
+
+ puts 'deleteall'
+ Dir.glob("**/*").each do |file|
+ next if !File.file?(file)
+ inline_data(file)
+ end
+ mark
+end
+
+# Loop through the directories
+last_mark = nil
+Dir.chdir(ARGV[0]) do
+ Dir.glob("*").each do |dir|
+ next if File.file?(dir)
+
+ # move into the target directory
+ Dir.chdir(dir) do
+ last_mark = print_export(dir, last_mark)
+ end
+ end
+end
+
+
+
+
If you run this script, you’ll get content that looks something like this:
+
+
+
+
$ ruby import.rb /opt/import_from
+commit refs/heads/master
+mark :1
+committer John Doe <john@example.com> 1388649600 -0700
+data 29
+imported from back_2014_01_02deleteall
+M 644 inline README.md
+data 28
+# Hello
+
+This is my readme.
+commit refs/heads/master
+mark :2
+committer John Doe <john@example.com> 1388822400 -0700
+data 29
+imported from back_2014_01_04from :1
+deleteall
+M 644 inline main.rb
+data 34
+#!/bin/env ruby
+
+puts "Hey there"
+M 644 inline README.md
+(...)
+
+
+
+
To run the importer, pipe this output through git fast-import while in the Git directory you want to import into.
+You can create a new directory and then run git init in it for a starting point, and then run your script:
+
+
+
+
$ git init
+Initialized empty Git repository in /opt/import_to/.git/
+$ ruby import.rb /opt/import_from | git fast-import
+git-fast-import statistics:
+---------------------------------------------------------------------
+Alloc'd objects: 5000
+Total objects: 13 ( 6 duplicates )
+ blobs : 5 ( 4 duplicates 3 deltas of 5 attempts)
+ trees : 4 ( 1 duplicates 0 deltas of 4 attempts)
+ commits: 4 ( 1 duplicates 0 deltas of 0 attempts)
+ tags : 0 ( 0 duplicates 0 deltas of 0 attempts)
+Total branches: 1 ( 1 loads )
+ marks: 1024 ( 5 unique )
+ atoms: 2
+Memory total: 2344 KiB
+ pools: 2110 KiB
+ objects: 234 KiB
+---------------------------------------------------------------------
+pack_report: getpagesize() = 4096
+pack_report: core.packedGitWindowSize = 1073741824
+pack_report: core.packedGitLimit = 8589934592
+pack_report: pack_used_ctr = 10
+pack_report: pack_mmap_calls = 5
+pack_report: pack_open_windows = 2 / 2
+pack_report: pack_mapped = 1457 / 1457
+---------------------------------------------------------------------
+
+
+
+
As you can see, when it completes successfully, it gives you a bunch of statistics about what it accomplished.
+In this case, you imported 13 objects total for 4 commits into 1 branch.
+Now, you can run git log to see your new history:
+
+
+
+
$ git log -2
+commit 3caa046d4aac682a55867132ccdfbe0d3fdee498
+Author: John Doe <john@example.com>
+Date: Tue Jul 29 19:39:04 2014 -0700
+
+ imported from current
+
+commit 4afc2b945d0d3c8cd00556fbe2e8224569dc9def
+Author: John Doe <john@example.com>
+Date: Mon Feb 3 01:00:00 2014 -0700
+
+ imported from back_2014_02_03
+
+
+
+
There you go – a nice, clean Git repository.
+It’s important to note that nothing is checked out – you don’t have any files in your working directory at first.
+To get them, you must reset your branch to where master is now:
+
+
+
+
$ ls
+$ git reset --hard master
+HEAD is now at 3caa046 imported from current
+$ ls
+README.md main.rb
+
+
+
+
You can do a lot more with the fast-import tool – handle different modes, binary data, multiple branches and merging, tags, progress indicators, and more.
+A number of examples of more complex scenarios are available in the contrib/fast-import directory of the Git source code.
+
+
Summary
+
+
You should feel comfortable using Git as a client for other version-control systems, or importing nearly any existing repository into Git without losing data.
+In the next chapter, we’ll cover the raw internals of Git so you can craft every single byte, if need be.
+
+GitHub is the single largest host for Git repositories, and is the central point of collaboration for millions of developers and projects.
+A large percentage of all Git repositories are hosted on GitHub, and many open-source projects use it for Git hosting, issue tracking, code review, and other things.
+So while it’s not a direct part of the Git open source project, there’s a good chance that you’ll want or need to interact with GitHub at some point while using Git professionally.
This chapter is about using GitHub effectively.
+We’ll cover signing up for and managing an account, creating and using Git repositories, common workflows to contribute to projects and to accept contributions to yours, GitHub’s programmatic interface and lots of little tips to make your life easier in general.
If you are not interested in using GitHub to host your own projects or to collaborate with other projects that are hosted on GitHub, you can safely skip to Git Tools.
+Account Setup and Configuration
+
+
+The first thing you need to do is set up a free user account.
+Simply visit https://github.com, choose a user name that isn’t already taken, provide an email address and a password, and click the big green “Sign up for GitHub” button.
+
+
+
}}" alt="The GitHub sign-up form.">
+
+
نمودار 82. The GitHub sign-up form.
+
+
The next thing you’ll see is the pricing page for upgraded plans, but it’s safe to ignore this for now.
+GitHub will send you an email to verify the address you provided.
+Go ahead and do this; it’s pretty important (as we’ll see later).
+
+
+
+|
+ یادداشت
+ |
+
+
+ GitHub provides almost all of its functionality with free accounts, except some advanced features.
+Additionally, private repositories are limited to 3 collaborators.
+
+ GitHub’s paid plans include advanced tools and features as well as increased limits for free services, but we won’t be covering those in this book.
+To get more information about available plans and their comparison, visit https://github.com/pricing.
+ |
+
+
+
+
Clicking the Octocat logo at the top-left of the screen will take you to your dashboard page.
+You’re now ready to use GitHub.
+
+
SSH Access
+
+
+As of right now, you’re fully able to connect with Git repositories using the https:// protocol, authenticating with the username and password you just set up.
+However, to simply clone public projects, you don’t even need to sign up - the account we just created comes into play when we fork projects and push to our forks a bit later.
+
+
+
If you’d like to use SSH remotes, you’ll need to configure a public key.
+(If you don’t already have one, see ساختن کلید عمومی SSH.)
+Open up your account settings using the link at the top-right of the window:
+
+
+
+
}}" alt="The ``Account settings'' link.">
+
+
نمودار 83. The “Account settings” link.
+
+
+
Then select the “SSH keys” section along the left-hand side.
+
+
+
+
}}" alt="The ``SSH keys'' link.">
+
+
نمودار 84. The “SSH keys” link.
+
+
+
From there, click the "Add an SSH key" button, give your key a name, paste the contents of your ~/.ssh/id_rsa.pub (or whatever you named it) public-key file into the text area, and click “Add key”.
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ Be sure to name your SSH key something you can remember.
+You can name each of your keys (e.g. "My Laptop" or "Work Account") so that if you need to revoke a key later, you can easily tell which one you’re looking for.
+ |
+
+
+
+
+
Your Avatar
+
+
Next, if you wish, you can replace the avatar that is generated for you with an image of your choosing.
+First go to the “Profile” tab (above the SSH Keys tab) and click “Upload new picture”.
+
+
+
+
}}" alt="The ``Profile'' link.">
+
+
نمودار 85. The “Profile” link.
+
+
+
We’ll choose a copy of the Git logo that is on our hard drive and then we get a chance to crop it.
+
+
+
+
}}" alt="Crop your uploaded avatar.">
+
+
نمودار 86. Crop your avatar
+
+
+
Now anywhere you interact on the site, people will see your avatar next to your username.
+
+
+
If you happen to have uploaded an avatar to the popular Gravatar service (often used for Wordpress accounts), that avatar will be used by default and you don’t need to do this step.
+
+
+
Your Email Addresses
+
+
The way that GitHub maps your Git commits to your user is by email address.
+If you use multiple email addresses in your commits and you want GitHub to link them up properly, you need to add all the email addresses you have used to the Emails section of the admin section.
+
+
+
+
}}" alt="Add all your email addresses.">
+
+
نمودار 87. Add email addresses
+
+
+
In Add email addresses we can see some of the different states that are possible.
+The top address is verified and set as the primary address, meaning that is where you’ll get any notifications and receipts.
+The second address is verified and so can be set as the primary if you wish to switch them.
+The final address is unverified, meaning that you can’t make it your primary address.
+If GitHub sees any of these in commit messages in any repository on the site, it will be linked to your user now.
+
+
+
Two Factor Authentication
+
+
Finally, for extra security, you should definitely set up Two-factor Authentication or “2FA”.
+Two-factor Authentication is an authentication mechanism that is becoming more and more popular recently to mitigate the risk of your account being compromised if your password is stolen somehow.
+Turning it on will make GitHub ask you for two different methods of authentication, so that if one of them is compromised, an attacker will not be able to access your account.
+
+
+
You can find the Two-factor Authentication setup under the Security tab of your Account settings.
+
+
+
+
}}" alt="2FA in the Security Tab">
+
+
نمودار 88. 2FA in the Security Tab
+
+
+
If you click on the “Set up two-factor authentication” button, it will take you to a configuration page where you can choose to use a phone app to generate your secondary code (a “time based one-time password”), or you can have GitHub send you a code via SMS each time you need to log in.
+
+
+
After you choose which method you prefer and follow the instructions for setting up 2FA, your account will then be a little more secure and you will have to provide a code in addition to your password whenever you log into GitHub.
+
+
Contributing to a Project
+
+
Now that our account is set up, let’s walk through some details that could be useful in helping you contribute to an existing project.
+
+
Forking Projects
+
+
+If you want to contribute to an existing project to which you don’t have push access, you can “fork” the project.
+When you “fork” a project, GitHub will make a copy of the project that is entirely yours; it lives in your namespace, and you can push to it.
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ Historically, the term “fork” has been somewhat negative in context, meaning that someone took an open source project in a different direction, sometimes creating a competing project and splitting the contributors.
+In GitHub, a “fork” is simply the same project in your own namespace, allowing you to make changes to a project publicly as a way to contribute in a more open manner.
+ |
+
+
+
+
+
This way, projects don’t have to worry about adding users as collaborators to give them push access.
+People can fork a project, push to it, and contribute their changes back to the original repository by creating what’s called a Pull Request, which we’ll cover next.
+This opens up a discussion thread with code review, and the owner and the contributor can then communicate about the change until the owner is happy with it, at which point the owner can merge it in.
+
+
+
To fork a project, visit the project page and click the “Fork” button at the top-right of the page.
+
+
+
+
}}" alt="The ``Fork'' button.">
+
+
نمودار 89. The “Fork” button.
+
+
+
After a few seconds, you’ll be taken to your new project page, with your own writeable copy of the code.
+
+
+
The GitHub Flow
+
+
+GitHub is designed around a particular collaboration workflow, centered on Pull Requests.
+This flow works whether you’re collaborating with a tightly-knit team in a single shared repository, or a globally-distributed company or network of strangers contributing to a project through dozens of forks.
+It is centered on the شاخههای موضوعی workflow covered in شاخهسازی در گیت.
+
+
+
Here’s how it generally works:
+
+
+
+-
+
Fork the project
+
+-
+
Create a topic branch from master.
+
+-
+
Make some commits to improve the project.
+
+-
+
Push this branch to your GitHub project.
+
+-
+
Open a Pull Request on GitHub.
+
+-
+
Discuss, and optionally continue committing.
+
+-
+
The project owner merges or closes the Pull Request.
+
+-
+
Sync the updated master back to your fork.
+
+
+
+
+
This is basically the Integration Manager workflow covered in روند کاری مدیر-یکپارچهسازی, but instead of using email to communicate and review changes, teams use GitHub’s web based tools.
+
+
+
Let’s walk through an example of proposing a change to an open source project hosted on GitHub using this flow.
+
+
+
Creating a Pull Request
+
+
Tony is looking for code to run on his Arduino programmable microcontroller and has found a great program file on GitHub at https://github.com/schacon/blink.
+
+
+
+
}}" alt="The project we want to contribute to.">
+
+
نمودار 90. The project we want to contribute to.
+
+
+
The only problem is that the blinking rate is too fast.
+We think it’s much nicer to wait 3 seconds instead of 1 in between each state change.
+So let’s improve the program and submit it back to the project as a proposed change.
+
+
+
First, we click the Fork button as mentioned earlier to get our own copy of the project.
+Our user name here is “tonychacon” so our copy of this project is at https://github.com/tonychacon/blink and that’s where we can edit it.
+We will clone it locally, create a topic branch, make the code change and finally push that change back up to GitHub.
+
+
+
+
$ git clone https://github.com/tonychacon/blink (1)
+Cloning into 'blink'...
+
+$ cd blink
+$ git checkout -b slow-blink (2)
+Switched to a new branch 'slow-blink'
+
+$ sed -i '' 's/1000/3000/' blink.ino (macOS) (3)
+# If you're on a Linux system, do this instead:
+# $ sed -i 's/1000/3000/' blink.ino (3)
+
+$ git diff --word-diff (4)
+diff --git a/blink.ino b/blink.ino
+index 15b9911..a6cc5a5 100644
+--- a/blink.ino
++++ b/blink.ino
+@@ -18,7 +18,7 @@ void setup() {
+// the loop routine runs over and over again forever:
+void loop() {
+ digitalWrite(led, HIGH); // turn the LED on (HIGH is the voltage level)
+ [-delay(1000);-]{+delay(3000);+} // wait for a second
+ digitalWrite(led, LOW); // turn the LED off by making the voltage LOW
+ [-delay(1000);-]{+delay(3000);+} // wait for a second
+}
+
+$ git commit -a -m 'Change delay to 3 seconds' (5)
+[slow-blink 5ca509d] Change delay to 3 seconds
+ 1 file changed, 2 insertions(+), 2 deletions(-)
+
+$ git push origin slow-blink (6)
+Username for 'https://github.com': tonychacon
+Password for 'https://tonychacon@github.com':
+Counting objects: 5, done.
+Delta compression using up to 8 threads.
+Compressing objects: 100% (3/3), done.
+Writing objects: 100% (3/3), 340 bytes | 0 bytes/s, done.
+Total 3 (delta 1), reused 0 (delta 0)
+To https://github.com/tonychacon/blink
+ * [new branch] slow-blink -> slow-blink
+
+
+
+
+-
+
Clone our fork of the project locally
+
+-
+
Create a descriptive topic branch
+
+-
+
Make our change to the code
+
+-
+
Check that the change is good
+
+-
+
Commit our change to the topic branch
+
+-
+
Push our new topic branch back up to our GitHub fork
+
+
+
+
+
Now if we go back to our fork on GitHub, we can see that GitHub noticed that we pushed a new topic branch up and presents us with a big green button to check out our changes and open a Pull Request to the original project.
+
+
+
You can alternatively go to the “Branches” page at https://github.com/<user>/<project>/branches to locate your branch and open a new Pull Request from there.
+
+
+
+
}}" alt="Pull Request button">
+
+
نمودار 91. Pull Request button
+
+
+
+If we click that green button, we’ll see a screen that asks us to give our Pull Request a title and description.
+It is almost always worthwhile to put some effort into this, since a good description helps the owner of the original project determine what you were trying to do, whether your proposed changes are correct, and whether accepting the changes would improve the original project.
+
+
+
We also see a list of the commits in our topic branch that are “ahead” of the master branch (in this case, just the one) and a unified diff of all the changes that will be made should this branch get merged by the project owner.
+
+
+
+
}}" alt="Pull Request creation">
+
+
نمودار 92. Pull Request creation page
+
+
+
When you hit the Create pull request button on this screen, the owner of the project you forked will get a notification that someone is suggesting a change and will link to a page that has all of this information on it.
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ Though Pull Requests are used commonly for public projects like this when the contributor has a complete change ready to be made, it’s also often used in internal projects at the beginning of the development cycle.
+Since you can keep pushing to the topic branch even after the Pull Request is opened, it’s often opened early and used as a way to iterate on work as a team within a context, rather than opened at the very end of the process.
+ |
+
+
+
+
+
+
Iterating on a Pull Request
+
+
At this point, the project owner can look at the suggested change and merge it, reject it or comment on it.
+Let’s say that he likes the idea, but would prefer a slightly longer time for the light to be off than on.
+
+
+
Where this conversation may take place over email in the workflows presented in گیت توزیعشده, on GitHub this happens online.
+The project owner can review the unified diff and leave a comment by clicking on any of the lines.
+
+
+
+
}}" alt="PR line comment">
+
+
نمودار 93. Comment on a specific line of code in a Pull Request
+
+
+
Once the maintainer makes this comment, the person who opened the Pull Request (and indeed, anyone else watching the repository) will get a notification.
+We’ll go over customizing this later, but if he had email notifications turned on, Tony would get an email like this:
+
+
+
+
}}" alt="Email notification">
+
+
نمودار 94. Comments sent as email notifications
+
+
+
Anyone can also leave general comments on the Pull Request.
+In Pull Request discussion page we can see an example of the project owner both commenting on a line of code and then leaving a general comment in the discussion section.
+You can see that the code comments are brought into the conversation as well.
+
+
+
+
}}" alt="PR discussion page">
+
+
نمودار 95. Pull Request discussion page
+
+
+
Now the contributor can see what they need to do in order to get their change accepted.
+Luckily this is very straightforward.
+Where over email you may have to re-roll your series and resubmit it to the mailing list, with GitHub you simply commit to the topic branch again and push, which will automatically update the Pull Request.
+In Pull Request final you can also see that the old code comment has been collapsed in the updated Pull Request, since it was made on a line that has since been changed.
+
+
+
Adding commits to an existing Pull Request doesn’t trigger a notification, so once Tony has pushed his corrections he decides to leave a comment to inform the project owner that he made the requested change.
+
+
+
+
}}" alt="PR final">
+
+
نمودار 96. Pull Request final
+
+
+
An interesting thing to notice is that if you click on the “Files Changed” tab on this Pull Request, you’ll get the “unified” diff — that is, the total aggregate difference that would be introduced to your main branch if this topic branch was merged in.
+In git diff terms, it basically automatically shows you git diff master...<branch> for the branch this Pull Request is based on.
+See تشخیص تغییرات معرفی شده for more about this type of diff.
+
+
+
The other thing you’ll notice is that GitHub checks to see if the Pull Request merges cleanly and provides a button to do the merge for you on the server.
+This button only shows up if you have write access to the repository and a trivial merge is possible.
+If you click it GitHub will perform a “non-fast-forward” merge, meaning that even if the merge could be a fast-forward, it will still create a merge commit.
+
+
+
If you would prefer, you can simply pull the branch down and merge it locally.
+If you merge this branch into the master branch and push it to GitHub, the Pull Request will automatically be closed.
+
+
+
This is the basic workflow that most GitHub projects use.
+Topic branches are created, Pull Requests are opened on them, a discussion ensues, possibly more work is done on the branch and eventually the request is either closed or merged.
+
+
+
+
+|
+ یادداشت
+ |
+
+ Not Only Forks
+
+ It’s important to note that you can also open a Pull Request between two branches in the same repository.
+If you’re working on a feature with someone and you both have write access to the project, you can push a topic branch to the repository and open a Pull Request on it to the master branch of that same project to initiate the code review and discussion process.
+No forking necessary.
+ |
+
+
+
+
+
+
Advanced Pull Requests
+
+
Now that we’ve covered the basics of contributing to a project on GitHub, let’s cover a few interesting tips and tricks about Pull Requests so you can be more effective in using them.
+
+
+
Pull Requests as Patches
+
+
It’s important to understand that many projects don’t really think of Pull Requests as queues of perfect patches that should apply cleanly in order, as most mailing list-based projects think of patch series contributions.
+Most GitHub projects think about Pull Request branches as iterative conversations around a proposed change, culminating in a unified diff that is applied by merging.
+
+
+
This is an important distinction, because generally the change is suggested before the code is thought to be perfect, which is far more rare with mailing list based patch series contributions.
+This enables an earlier conversation with the maintainers so that arriving at the proper solution is more of a community effort.
+When code is proposed with a Pull Request and the maintainers or community suggest a change, the patch series is generally not re-rolled, but instead the difference is pushed as a new commit to the branch, moving the conversation forward with the context of the previous work intact.
+
+
+
For instance, if you go back and look again at Pull Request final, you’ll notice that the contributor did not rebase his commit and send another Pull Request.
+Instead they added new commits and pushed them to the existing branch.
+This way if you go back and look at this Pull Request in the future, you can easily find all of the context of why decisions were made.
+Pushing the “Merge” button on the site purposefully creates a merge commit that references the Pull Request so that it’s easy to go back and research the original conversation if necessary.
+
+
+
+
Keeping up with Upstream
+
+
If your Pull Request becomes out of date or otherwise doesn’t merge cleanly, you will want to fix it so the maintainer can easily merge it.
+GitHub will test this for you and let you know at the bottom of every Pull Request if the merge is trivial or not.
+
+
+
+
}}" alt="PR merge failure">
+
+
نمودار 97. Pull Request does not merge cleanly
+
+
+
+
You have two main options in order to do this.
+You can either rebase your branch on top of whatever the target branch is (normally the master branch of the repository you forked), or you can merge the target branch into your branch.
+
+
+
Most developers on GitHub will choose to do the latter, for the same reasons we just went over in the previous section.
+What matters is the history and the final merge, so rebasing isn’t getting you much other than a slightly cleaner history and in return is far more difficult and error prone.
+
+
+
If you want to merge in the target branch to make your Pull Request mergeable, you would add the original repository as a new remote, fetch from it, merge the main branch of that repository into your topic branch, fix any issues and finally push it back up to the same branch you opened the Pull Request on.
+
+
+
For example, let’s say that in the “tonychacon” example we were using before, the original author made a change that would create a conflict in the Pull Request.
+Let’s go through those steps.
+
+
+
+
$ git remote add upstream https://github.com/schacon/blink (1)
+
+$ git fetch upstream (2)
+remote: Counting objects: 3, done.
+remote: Compressing objects: 100% (3/3), done.
+Unpacking objects: 100% (3/3), done.
+remote: Total 3 (delta 0), reused 0 (delta 0)
+From https://github.com/schacon/blink
+ * [new branch] master -> upstream/master
+
+$ git merge upstream/master (3)
+Auto-merging blink.ino
+CONFLICT (content): Merge conflict in blink.ino
+Automatic merge failed; fix conflicts and then commit the result.
+
+$ vim blink.ino (4)
+$ git add blink.ino
+$ git commit
+[slow-blink 3c8d735] Merge remote-tracking branch 'upstream/master' \
+ into slower-blink
+
+$ git push origin slow-blink (5)
+Counting objects: 6, done.
+Delta compression using up to 8 threads.
+Compressing objects: 100% (6/6), done.
+Writing objects: 100% (6/6), 682 bytes | 0 bytes/s, done.
+Total 6 (delta 2), reused 0 (delta 0)
+To https://github.com/tonychacon/blink
+ ef4725c..3c8d735 slower-blink -> slow-blink
+
+
+
+
+-
+
Add the original repository as a remote named “upstream”
+
+-
+
Fetch the newest work from that remote
+
+-
+
Merge the main branch of that repository into your topic branch
+
+-
+
Fix the conflict that occurred
+
+-
+
Push back up to the same topic branch
+
+
+
+
+
Once you do that, the Pull Request will be automatically updated and re-checked to see if it merges cleanly.
+
+
+
+
}}" alt="PR fixed">
+
+
نمودار 98. Pull Request now merges cleanly
+
+
+
One of the great things about Git is that you can do that continuously.
+If you have a very long-running project, you can easily merge from the target branch over and over again and only have to deal with conflicts that have arisen since the last time that you merged, making the process very manageable.
+
+
+
If you absolutely wish to rebase the branch to clean it up, you can certainly do so, but it is highly encouraged to not force push over the branch that the Pull Request is already opened on.
+If other people have pulled it down and done more work on it, you run into all of the issues outlined in خطرات ریبیسکردن.
+Instead, push the rebased branch to a new branch on GitHub and open a brand new Pull Request referencing the old one, then close the original.
+
+
+
+
References
+
+
Your next question may be “How do I reference the old Pull Request?”.
+It turns out there are many, many ways to reference other things almost anywhere you can write in GitHub.
+
+
+
Let’s start with how to cross-reference another Pull Request or an Issue.
+All Pull Requests and Issues are assigned numbers and they are unique within the project.
+For example, you can’t have Pull Request #3 and Issue #3.
+If you want to reference any Pull Request or Issue from any other one, you can simply put #<num> in any comment or description.
+You can also be more specific if the Issue or Pull request lives somewhere else; write username#<num> if you’re referring to an Issue or Pull Request in a fork of the repository you’re in, or username/repo#<num> to reference something in another repository.
+
+
+
Let’s look at an example.
+Say we rebased the branch in the previous example, created a new pull request for it, and now we want to reference the old pull request from the new one.
+We also want to reference an issue in the fork of the repository and an issue in a completely different project.
+We can fill out the description just like Cross references in a Pull Request..
+
+
+
+
}}" alt="PR references">
+
+
نمودار 99. Cross references in a Pull Request.
+
+
+
+
+
}}" alt="PR references rendered">
+
+
نمودار 100. Cross references rendered in a Pull Request.
+
+
+
Notice that the full GitHub URL we put in there was shortened to just the information needed.
+
+
+
Now if Tony goes back and closes out the original Pull Request, we can see that by mentioning it in the new one, GitHub has automatically created a trackback event in the Pull Request timeline.
+This means that anyone who visits this Pull Request and sees that it is closed can easily link back to the one that superseded it.
+The link will look something like Link back to the new Pull Request in the closed Pull Request timeline..
+
+
+
+
}}" alt="PR closed">
+
+
نمودار 101. Link back to the new Pull Request in the closed Pull Request timeline.
+
+
+
In addition to issue numbers, you can also reference a specific commit by SHA-1.
+You have to specify a full 40 character SHA-1, but if GitHub sees that in a comment, it will link directly to the commit.
+Again, you can reference commits in forks or other repositories in the same way you did with issues.
+
+
+
+
GitHub Flavored Markdown
+
+
Linking to other Issues is just the beginning of interesting things you can do with almost any text box on GitHub.
+In Issue and Pull Request descriptions, comments, code comments and more, you can use what is called “GitHub Flavored Markdown”.
+Markdown is like writing in plain text but which is rendered richly.
+
+
+
+
+
}}" alt="Example Markdown">
+
+
نمودار 102. An example of GitHub Flavored Markdown as written and as rendered.
+
+
+
The GitHub flavor of Markdown adds more things you can do beyond the basic Markdown syntax.
+These can all be really useful when creating useful Pull Request or Issue comments or descriptions.
+
+
+
Task Lists
+
+
The first really useful GitHub specific Markdown feature, especially for use in Pull Requests, is the Task List.
+A task list is a list of checkboxes of things you want to get done.
+Putting them into an Issue or Pull Request normally indicates things that you want to get done before you consider the item complete.
+
+
+
You can create a task list like this:
+
+
+
+
- [X] Write the code
+- [ ] Write all the tests
+- [ ] Document the code
+
+
+
+
+
+
}}" alt="Example Task List">
+
+
نمودار 103. Task lists rendered in a Markdown comment.
+
+
+
This is often used in Pull Requests to indicate what all you would like to get done on the branch before the Pull Request will be ready to merge.
+The really cool part is that you can simply click the checkboxes to update the comment — you don’t have to edit the Markdown directly to check tasks off.
+
+
+
What’s more, GitHub will look for task lists in your Issues and Pull Requests and show them as metadata on the pages that list them out.
+For example, if you have a Pull Request with tasks and you look at the overview page of all Pull Requests, you can see how far done it is.
+This helps people break down Pull Requests into subtasks and helps other people track the progress of the branch.
+You can see an example of this in Task list summary in the Pull Request list..
+
+
+
+
}}" alt="Example Task List">
+
+
نمودار 104. Task list summary in the Pull Request list.
+
+
+
These are incredibly useful when you open a Pull Request early and use it to track your progress through the implementation of the feature.
+
+
+
+
Code Snippets
+
+
You can also add code snippets to comments.
+This is especially useful if you want to present something that you could try to do before actually implementing it as a commit on your branch.
+This is also often used to add example code of what is not working or what this Pull Request could implement.
+
+
+
To add a snippet of code you have to “fence” it in backticks.
+
+
+
+
```java
+for(int i=0 ; i < 5 ; i++)
+{
+ System.out.println("i is : " + i);
+}
+```
+
+
+
+
If you add a language name like we did there with java, GitHub will also try to syntax highlight the snippet.
+In the case of the above example, it would end up rendering like Rendered fenced code example..
+
+
+
+
}}" alt="Rendered fenced code">
+
+
نمودار 105. Rendered fenced code example.
+
+
+
+
Quoting
+
+
If you’re responding to a small part of a long comment, you can selectively quote out of the other comment by preceding the lines with the > character.
+In fact, this is so common and so useful that there is a keyboard shortcut for it.
+If you highlight text in a comment that you want to directly reply to and hit the r key, it will quote that text in the comment box for you.
+
+
+
The quotes look something like this:
+
+
+
+
> Whether 'tis Nobler in the mind to suffer
+> The Slings and Arrows of outrageous Fortune,
+
+How big are these slings and in particular, these arrows?
+
+
+
+
+
+
}}" alt="Rendered quoting">
+
+
نمودار 106. Rendered quoting example.
+
+
+
+
Emoji
+
+
Finally, you can also use emoji in your comments.
+This is actually used quite extensively in comments you see on many GitHub Issues and Pull Requests.
+There is even an emoji helper in GitHub.
+If you are typing a comment and you start with a : character, an autocompleter will help you find what you’re looking for.
+
+
+
+
}}" alt="Emoji autocompleter">
+
+
نمودار 107. Emoji autocompleter in action.
+
+
+
Emojis take the form of :<name>: anywhere in the comment.
+For instance, you could write something like this:
+
+
+
+
I :eyes: that :bug: and I :cold_sweat:.
+
+:trophy: for :microscope: it.
+
+:+1: and :sparkles: on this :ship:, it's :fire::poop:!
+
+:clap::tada::panda_face:
+
+
+
+
+
+
}}" alt="Emoji">
+
+
نمودار 108. Heavy emoji commenting.
+
+
+
Not that this is incredibly useful, but it does add an element of fun and emotion to a medium that is otherwise hard to convey emotion in.
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ There are actually quite a number of web services that make use of emoji characters these days.
+A great cheat sheet to reference to find emoji that expresses what you want to say can be found at:
+ |
+
+
+
+
+
+
Images
+
+
This isn’t technically GitHub Flavored Markdown, but it is incredibly useful.
+In addition to adding Markdown image links to comments, which can be difficult to find and embed URLs for, GitHub allows you to drag and drop images into text areas to embed them.
+
+
+
+
}}" alt="Drag and drop images">
+
+
نمودار 109. Drag and drop images to upload them and auto-embed them.
+
+
+
+
+
Keep your GitHub public repository up-to-date
+
+
Once you’ve forked a GitHub repository, your repository (your "fork") exists independently from the original.
+In particular, when the original repository has new commits, GitHub informs you by a message like:
+
+
+
+
This branch is 5 commits behind progit:master.
+
+
+
+
But your GitHub repository will never be automatically updated by GitHub; this is something that you must do yourself.
+Fortunately, this is very easy to do.
+
+
+
One possibility to do this requires no configuration.
+For example, if you forked from https://github.com/progit/progit2.git, you can keep your master branch up-to-date like this:
+
+
+
+
$ git checkout master (1)
+$ git pull https://github.com/progit/progit2.git (2)
+$ git push origin master (3)
+
+
+
+
+-
+
If you were on another branch, return to master.
+
+-
+
Fetch changes from https://github.com/progit/progit2.git and merge them into master.
+
+-
+
Push your master branch to origin.
+
+
+
+
+
This works, but it is a little tedious having to spell out the fetch URL every time.
+You can automate this work with a bit of configuration:
+
+
+
+
$ git remote add progit https://github.com/progit/progit2.git (1)
+$ git branch --set-upstream-to=progit/master master (2)
+$ git config --local remote.pushDefault origin (3)
+
+
+
+
+-
+
Add the source repository and give it a name.
+Here, I have chosen to call it progit.
+
+-
+
Set your master branch to fetch from the progit remote.
+
+-
+
Define the default push repository to origin.
+
+
+
+
+
Once this is done, the workflow becomes much simpler:
+
+
+
+
$ git checkout master (1)
+$ git pull (2)
+$ git push (3)
+
+
+
+
+-
+
If you were on another branch, return to master.
+
+-
+
Fetch changes from progit and merge changes into master.
+
+-
+
Push your master branch to origin.
+
+
+
+
+
This approach can be useful, but it’s not without downsides.
+Git will happily do this work for you silently, but it won’t warn you if you make a commit to master, pull from progit, then push to origin — all of those operations are valid with this setup.
+So you’ll have to take care never to commit directly to master, since that branch effectively belongs to the upstream repository.
+
+
Maintaining a Project
+
+
Now that we’re comfortable contributing to a project, let’s look at the other side: creating, maintaining and administering your own project.
+
+
Creating a New Repository
+
+
Let’s create a new repository to share our project code with.
+Start by clicking the “New repository” button on the right-hand side of the dashboard, or from the + button in the top toolbar next to your username as seen in The “New repository” dropdown..
+
+
+
+
}}" alt="The ``Your repositories'' area.">
+
+
نمودار 110. The “Your repositories” area.
+
+
+
+
}}" alt="The ``new repository'' dropdown.">
+
+
نمودار 111. The “New repository” dropdown.
+
+
+
This takes you to the “new repository” form:
+
+
+
+
}}" alt="The ``new repository'' form.">
+
+
نمودار 112. The “new repository” form.
+
+
+
All you really have to do here is provide a project name; the rest of the fields are completely optional.
+For now, just click the “Create Repository” button, and boom – you have a new repository on GitHub, named <user>/<project_name>.
+
+
+
Since you have no code there yet, GitHub will show you instructions for how to create a brand-new Git repository, or connect an existing Git project.
+We won’t belabor this here; if you need a refresher, check out مقدمات گیت.
+
+
+
Now that your project is hosted on GitHub, you can give the URL to anyone you want to share your project with.
+Every project on GitHub is accessible over HTTPS as https://github.com/<user>/<project_name>, and over SSH as git@github.com:<user>/<project_name>.
+Git can fetch from and push to both of these URLs, but they are access-controlled based on the credentials of the user connecting to them.
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ It is often preferable to share the HTTPS based URL for a public project, since the user does not have to have a GitHub account to access it for cloning.
+Users will have to have an account and an uploaded SSH key to access your project if you give them the SSH URL.
+The HTTPS one is also exactly the same URL they would paste into a browser to view the project there.
+ |
+
+
+
+
+
Adding Collaborators
+
+
If you’re working with other people who you want to give commit access to, you need to add them as “collaborators”.
+If Ben, Jeff, and Louise all sign up for accounts on GitHub, and you want to give them push access to your repository, you can add them to your project.
+Doing so will give them “push” access, which means they have both read and write access to the project and Git repository.
+
+
+
Click the “Settings” link at the bottom of the right-hand sidebar.
+
+
+
+
}}" alt="The repository settings link.">
+
+
نمودار 113. The repository settings link.
+
+
+
Then select “Collaborators” from the menu on the left-hand side.
+Then, just type a username into the box, and click “Add collaborator.”
+You can repeat this as many times as you like to grant access to everyone you like.
+If you need to revoke access, just click the “X” on the right-hand side of their row.
+
+
+
+
}}" alt="The repository collaborators box.">
+
+
نمودار 114. Repository collaborators.
+
+
+
Managing Pull Requests
+
+
Now that you have a project with some code in it and maybe even a few collaborators who also have push access, let’s go over what to do when you get a Pull Request yourself.
+
+
+
Pull Requests can either come from a branch in a fork of your repository or they can come from another branch in the same repository.
+The only difference is that the ones in a fork are often from people where you can’t push to their branch and they can’t push to yours, whereas with internal Pull Requests generally both parties can access the branch.
+
+
+
For these examples, let’s assume you are “tonychacon” and you’ve created a new Arduino code project named “fade”.
+
+
+
Email Notifications
+
+
Someone comes along and makes a change to your code and sends you a Pull Request.
+You should get an email notifying you about the new Pull Request and it should look something like Email notification of a new Pull Request..
+
+
+
+
}}" alt="Pull Request email notification">
+
+
نمودار 115. Email notification of a new Pull Request.
+
+
+
There are a few things to notice about this email.
+It will give you a small diffstat — a list of files that have changed in the Pull Request and by how much.
+It gives you a link to the Pull Request on GitHub.
+It also gives you a few URLs that you can use from the command line.
+
+
+
If you notice the line that says git pull <url> patch-1, this is a simple way to merge in a remote branch without having to add a remote.
+We went over this quickly in چکاوت کردن برنچهای ریموت.
+If you wish, you can create and switch to a topic branch and then run this command to merge in the Pull Request changes.
+
+
+
The other interesting URLs are the .diff and .patch URLs, which as you may guess, provide unified diff and patch versions of the Pull Request.
+You could technically merge in the Pull Request work with something like this:
+
+
+
+
$ curl https://github.com/tonychacon/fade/pull/1.patch | git am
+
+
+
+
+
Collaborating on the Pull Request
+
+
As we covered in The GitHub Flow, you can now have a conversation with the person who opened the Pull Request.
+You can comment on specific lines of code, comment on whole commits or comment on the entire Pull Request itself, using GitHub Flavored Markdown everywhere.
+
+
+
Every time someone else comments on the Pull Request you will continue to get email notifications so you know there is activity happening.
+They will each have a link to the Pull Request where the activity is happening and you can also directly respond to the email to comment on the Pull Request thread.
+
+
+
+
}}" alt="Email response">
+
+
نمودار 116. Responses to emails are included in the thread.
+
+
+
Once the code is in a place you like and want to merge it in, you can either pull the code down and merge it locally, either with the git pull <url> <branch> syntax we saw earlier, or by adding the fork as a remote and fetching and merging.
+
+
+
If the merge is trivial, you can also just hit the “Merge” button on the GitHub site.
+This will do a “non-fast-forward” merge, creating a merge commit even if a fast-forward merge was possible.
+This means that no matter what, every time you hit the merge button, a merge commit is created.
+As you can see in Merge button and instructions for merging a Pull Request manually., GitHub gives you all of this information if you click the hint link.
+
+
+
+
If you decide you don’t want to merge it, you can also just close the Pull Request and the person who opened it will be notified.
+
+
+
+
Pull Request Refs
+
+
If you’re dealing with a lot of Pull Requests and don’t want to add a bunch of remotes or do one time pulls every time, there is a neat trick that GitHub allows you to do.
+This is a bit of an advanced trick and we’ll go over the details of this a bit more in The Refspec, but it can be pretty useful.
+
+
+
GitHub actually advertises the Pull Request branches for a repository as sort of pseudo-branches on the server.
+By default you don’t get them when you clone, but they are there in an obscured way and you can access them pretty easily.
+
+
+
To demonstrate this, we’re going to use a low-level command (often referred to as a “plumbing” command, which we’ll read about more in Plumbing and Porcelain) called ls-remote.
+This command is generally not used in day-to-day Git operations but it’s useful to show us what references are present on the server.
+
+
+
If we run this command against the “blink” repository we were using earlier, we will get a list of all the branches and tags and other references in the repository.
+
+
+
+
$ git ls-remote https://github.com/schacon/blink
+10d539600d86723087810ec636870a504f4fee4d HEAD
+10d539600d86723087810ec636870a504f4fee4d refs/heads/master
+6a83107c62950be9453aac297bb0193fd743cd6e refs/pull/1/head
+afe83c2d1a70674c9505cc1d8b7d380d5e076ed3 refs/pull/1/merge
+3c8d735ee16296c242be7a9742ebfbc2665adec1 refs/pull/2/head
+15c9f4f80973a2758462ab2066b6ad9fe8dcf03d refs/pull/2/merge
+a5a7751a33b7e86c5e9bb07b26001bb17d775d1a refs/pull/4/head
+31a45fc257e8433c8d8804e3e848cf61c9d3166c refs/pull/4/merge
+
+
+
+
Of course, if you’re in your repository and you run git ls-remote origin or whatever remote you want to check, it will show you something similar to this.
+
+
+
If the repository is on GitHub and you have any Pull Requests that have been opened, you’ll get these references that are prefixed with refs/pull/.
+These are basically branches, but since they’re not under refs/heads/ you don’t get them normally when you clone or fetch from the server — the process of fetching ignores them normally.
+
+
+
There are two references per Pull Request - the one that ends in /head points to exactly the same commit as the last commit in the Pull Request branch.
+So if someone opens a Pull Request in our repository and their branch is named bug-fix and it points to commit a5a775, then in our repository we will not have a bug-fix branch (since that’s in their fork), but we will have pull/<pr#>/head that points to a5a775.
+This means that we can pretty easily pull down every Pull Request branch in one go without having to add a bunch of remotes.
+
+
+
Now, you could do something like fetching the reference directly.
+
+
+
+
$ git fetch origin refs/pull/958/head
+From https://github.com/libgit2/libgit2
+ * branch refs/pull/958/head -> FETCH_HEAD
+
+
+
+
This tells Git, “Connect to the origin remote, and download the ref named refs/pull/958/head.”
+Git happily obeys, and downloads everything you need to construct that ref, and puts a pointer to the commit you want under .git/FETCH_HEAD.
+You can follow that up with git merge FETCH_HEAD into a branch you want to test it in, but that merge commit message looks a bit weird.
+Also, if you’re reviewing a lot of pull requests, this gets tedious.
+
+
+
There’s also a way to fetch all of the pull requests, and keep them up to date whenever you connect to the remote.
+Open up .git/config in your favorite editor, and look for the origin remote.
+It should look a bit like this:
+
+
+
+
[remote "origin"]
+ url = https://github.com/libgit2/libgit2
+ fetch = +refs/heads/*:refs/remotes/origin/*
+
+
+
+
That line that begins with fetch = is a “refspec.”
+It’s a way of mapping names on the remote with names in your local .git directory.
+This particular one tells Git, "the things on the remote that are under refs/heads should go in my local repository under refs/remotes/origin."
+You can modify this section to add another refspec:
+
+
+
+
[remote "origin"]
+ url = https://github.com/libgit2/libgit2.git
+ fetch = +refs/heads/*:refs/remotes/origin/*
+ fetch = +refs/pull/*/head:refs/remotes/origin/pr/*
+
+
+
+
That last line tells Git, “All the refs that look like refs/pull/123/head should be stored locally like refs/remotes/origin/pr/123.”
+Now, if you save that file, and do a git fetch:
+
+
+
+
$ git fetch
+# …
+ * [new ref] refs/pull/1/head -> origin/pr/1
+ * [new ref] refs/pull/2/head -> origin/pr/2
+ * [new ref] refs/pull/4/head -> origin/pr/4
+# …
+
+
+
+
Now all of the remote pull requests are represented locally with refs that act much like tracking branches; they’re read-only, and they update when you do a fetch.
+This makes it super easy to try the code from a pull request locally:
+
+
+
+
$ git checkout pr/2
+Checking out files: 100% (3769/3769), done.
+Branch pr/2 set up to track remote branch pr/2 from origin.
+Switched to a new branch 'pr/2'
+
+
+
+
The eagle-eyed among you would note the head on the end of the remote portion of the refspec.
+There’s also a refs/pull/#/merge ref on the GitHub side, which represents the commit that would result if you push the “merge” button on the site.
+This can allow you to test the merge before even hitting the button.
+
+
+
+
Pull Requests on Pull Requests
+
+
Not only can you open Pull Requests that target the main or master branch, you can actually open a Pull Request targeting any branch in the network.
+In fact, you can even target another Pull Request.
+
+
+
If you see a Pull Request that is moving in the right direction and you have an idea for a change that depends on it or you’re not sure is a good idea, or you just don’t have push access to the target branch, you can open a Pull Request directly to it.
+
+
+
When you go to open a Pull Request, there is a box at the top of the page that specifies which branch you’re requesting to pull to and which you’re requesting to pull from.
+If you hit the “Edit” button at the right of that box you can change not only the branches but also which fork.
+
+
+
+
}}" alt="PR targets">
+
+
نمودار 118. Manually change the Pull Request target fork and branch.
+
+
+
Here you can fairly easily specify to merge your new branch into another Pull Request or another fork of the project.
+
+
+
+
Mentions and Notifications
+
+
GitHub also has a pretty nice notifications system built in that can come in handy when you have questions or need feedback from specific individuals or teams.
+
+
+
In any comment you can start typing a @ character and it will begin to autocomplete with the names and usernames of people who are collaborators or contributors in the project.
+
+
+
+
}}" alt="Mentions">
+
+
نمودار 119. Start typing @ to mention someone.
+
+
+
You can also mention a user who is not in that dropdown, but often the autocompleter can make it faster.
+
+
+
Once you post a comment with a user mention, that user will be notified.
+This means that this can be a really effective way of pulling people into conversations rather than making them poll.
+Very often in Pull Requests on GitHub people will pull in other people on their teams or in their company to review an Issue or Pull Request.
+
+
+
If someone gets mentioned on a Pull Request or Issue, they will be “subscribed” to it and will continue getting notifications any time some activity occurs on it.
+You will also be subscribed to something if you opened it, if you’re watching the repository or if you comment on something.
+If you no longer wish to receive notifications, there is an “Unsubscribe” button on the page you can click to stop receiving updates on it.
+
+
+
+
}}" alt="Unsubscribe">
+
+
نمودار 120. Unsubscribe from an Issue or Pull Request.
+
+
+
The Notifications Page
+
+
When we mention “notifications” here with respect to GitHub, we mean a specific way that GitHub tries to get in touch with you when events happen and there are a few different ways you can configure them.
+If you go to the “Notification center” tab from the settings page, you can see some of the options you have.
+
+
+
+
}}" alt="Notification center">
+
+
نمودار 121. Notification center options.
+
+
+
The two choices are to get notifications over “Email” and over “Web” and you can choose either, neither or both for when you actively participate in things and for activity on repositories you are watching.
+
+
+
Web Notifications
+
+
Web notifications only exist on GitHub and you can only check them on GitHub.
+If you have this option selected in your preferences and a notification is triggered for you, you will see a small blue dot over your notifications icon at the top of your screen as seen in Notification center..
+
+
+
+
}}" alt="Notification center">
+
+
نمودار 122. Notification center.
+
+
+
If you click on that, you will see a list of all the items you have been notified about, grouped by project.
+You can filter to the notifications of a specific project by clicking on its name in the left hand sidebar.
+You can also acknowledge the notification by clicking the checkmark icon next to any notification, or acknowledge all of the notifications in a project by clicking the checkmark at the top of the group.
+There is also a mute button next to each checkmark that you can click to not receive any further notifications on that item.
+
+
+
All of these tools are very useful for handling large numbers of notifications.
+Many GitHub power users will simply turn off email notifications entirely and manage all of their notifications through this screen.
+
+
+
+
Email Notifications
+
+
+
There is also a fair amount of metadata embedded in the headers of the emails that GitHub sends you, which can be really helpful for setting up custom filters and rules.
+
+
+
+
+
To: tonychacon/fade <fade@noreply.github.com>
+Message-ID: <tonychacon/fade/pull/1@github.com>
+Subject: [fade] Wait longer to see the dimming effect better (#1)
+X-GitHub-Recipient: tonychacon
+List-ID: tonychacon/fade <fade.tonychacon.github.com>
+List-Archive: https://github.com/tonychacon/fade
+List-Post: <mailto:reply+i-4XXX@reply.github.com>
+List-Unsubscribe: <mailto:unsub+i-XXX@reply.github.com>,...
+X-GitHub-Recipient-Address: tchacon@example.com
+
+
+
+
There are a couple of interesting things here.
+If you want to highlight or re-route emails to this particular project or even Pull Request, the information in Message-ID gives you all the data in <user>/<project>/<type>/<id> format.
+If this were an issue, for example, the <type> field would have been “issues” rather than “pull”.
+
+
+
The List-Post and List-Unsubscribe fields mean that if you have a mail client that understands those, you can easily post to the list or “Unsubscribe” from the thread.
+That would be essentially the same as clicking the “mute” button on the web version of the notification or “Unsubscribe” on the Issue or Pull Request page itself.
+
+
+
It’s also worth noting that if you have both email and web notifications enabled and you read the email version of the notification, the web version will be marked as read as well if you have images allowed in your mail client.
+
+
+
+
+
Special Files
+
+
There are a couple of special files that GitHub will notice if they are present in your repository.
+
+
+
README
+
+
The first is the README file, which can be of nearly any format that GitHub recognizes as prose.
+For example, it could be README, README.md, README.asciidoc, etc.
+If GitHub sees a README file in your source, it will render it on the landing page of the project.
+
+
+
Many teams use this file to hold all the relevant project information for someone who might be new to the repository or project.
+This generally includes things like:
+
+
+
+-
+
What the project is for
+
+-
+
How to configure and install it
+
+-
+
An example of how to use it or get it running
+
+-
+
The license that the project is offered under
+
+-
+
How to contribute to it
+
+
+
+
+
Since GitHub will render this file, you can embed images or links in it for added ease of understanding.
+
+
+
CONTRIBUTING
+
+
+
+
}}" alt="Contributing notice">
+
+
نمودار 123. Opening a Pull Request when a CONTRIBUTING file exists.
+
+
+
The idea here is that you can specify specific things you want or don’t want in a Pull Request sent to your project.
+This way people may actually read the guidelines before opening the Pull Request.
+
+
+
Project Administration
+
+
Generally there are not a lot of administrative things you can do with a single project, but there are a couple of items that might be of interest.
+
+
+
Changing the Default Branch
+
+
If you are using a branch other than “master” as your default branch that you want people to open Pull Requests on or see by default, you can change that in your repository’s settings page under the “Options” tab.
+
+
+
+
}}" alt="Default branch">
+
+
نمودار 124. Change the default branch for a project.
+
+
+
Simply change the default branch in the dropdown and that will be the default for all major operations from then on, including which branch is checked out by default when someone clones the repository.
+
+
+
+
Transferring a Project
+
+
If you would like to transfer a project to another user or an organization in GitHub, there is a “Transfer ownership” option at the bottom of the same “Options” tab of your repository settings page that allows you to do this.
+
+
+
+
}}" alt="Transfer">
+
+
نمودار 125. Transfer a project to another GitHub user or Organization.
+
+
+
This is helpful if you are abandoning a project and someone wants to take it over, or if your project is getting bigger and want to move it into an organization.
+
+
+
Not only does this move the repository along with all its watchers and stars to another place, it also sets up a redirect from your URL to the new place.
+It will also redirect clones and fetches from Git, not just web requests.
+
+
+
Managing an organization
+
+
+In addition to single-user accounts, GitHub has what are called Organizations.
+Like personal accounts, Organizational accounts have a namespace where all their projects exist, but many other things are different.
+These accounts represent a group of people with shared ownership of projects, and there are many tools to manage subgroups of those people.
+Normally these accounts are used for Open Source groups (such as “perl” or “rails”) or companies (such as “google” or “twitter”).
+
+
Organization Basics
+
+
An organization is pretty easy to create; just click on the “+” icon at the top-right of any GitHub page, and select “New organization” from the menu.
+
+
+
+
}}" alt="The ``New organization'' menu item.">
+
+
نمودار 126. The “New organization” menu item.
+
+
+
First you’ll need to name your organization and provide an email address for a main point of contact for the group.
+Then you can invite other users to be co-owners of the account if you want to.
+
+
+
Follow these steps and you’ll soon be the owner of a brand-new organization.
+Like personal accounts, organizations are free if everything you plan to store there will be open source.
+
+
+
As an owner in an organization, when you fork a repository, you’ll have the choice of forking it to your organization’s namespace.
+When you create new repositories you can create them either under your personal account or under any of the organizations that you are an owner in.
+You also automatically “watch” any new repository created under these organizations.
+
+
+
Just like in Your Avatar, you can upload an avatar for your organization to personalize it a bit.
+Also just like personal accounts, you have a landing page for the organization that lists all of your repositories and can be viewed by other people.
+
+
+
Now let’s cover some of the things that are a bit different with an organizational account.
+
+
+
Teams
+
+
Organizations are associated with individual people by way of teams, which are simply a grouping of individual user accounts and repositories within the organization and what kind of access those people have in those repositories.
+
+
+
For example, say your company has three repositories: frontend, backend, and deployscripts.
+You’d want your HTML/CSS/JavaScript developers to have access to frontend and maybe backend, and your Operations people to have access to backend and deployscripts.
+Teams make this easy, without having to manage the collaborators for every individual repository.
+
+
+
The Organization page shows you a simple dashboard of all the repositories, users and teams that are under this organization.
+
+
+
+
}}" alt="orgs 01 page">
+
+
نمودار 127. The Organization page.
+
+
+
To manage your Teams, you can click on the Teams sidebar on the right hand side of the page in The Organization page..
+This will bring you to a page you can use to add members to the team, add repositories to the team or manage the settings and access control levels for the team.
+Each team can have read only, read/write or administrative access to the repositories.
+You can change that level by clicking the “Settings” button in The Team page..
+
+
+
+
}}" alt="orgs 02 teams">
+
+
نمودار 128. The Team page.
+
+
+
When you invite someone to a team, they will get an email letting them know they’ve been invited.
+
+
+
Additionally, team @mentions (such as @acmecorp/frontend) work much the same as they do with individual users, except that all members of the team are then subscribed to the thread.
+This is useful if you want the attention from someone on a team, but you don’t know exactly who to ask.
+
+
+
A user can belong to any number of teams, so don’t limit yourself to only access-control teams.
+Special-interest teams like ux, css, or refactoring are useful for certain kinds of questions, and others like legal and colorblind for an entirely different kind.
+
+
+
Audit Log
+
+
Organizations also give owners access to all the information about what went on under the organization.
+You can go to the Audit Log tab and see what events have happened at an organization level, who did them and where in the world they were done.
+
+
+
+
}}" alt="orgs 03 audit">
+
+
نمودار 129. The Audit log.
+
+
+
You can also filter down to specific types of events, specific places or specific people.
+
+
Scripting GitHub
+
+
So now we’ve covered all of the major features and workflows of GitHub, but any large group or project will have customizations they may want to make or external services they may want to integrate.
+
+
Luckily for us, GitHub is really quite hackable in many ways.
+In this section we’ll cover how to use the GitHub hooks system and its API to make GitHub work how we want it to.
+
+
Services and Hooks
+
+
The Hooks and Services section of GitHub repository administration is the easiest way to have GitHub interact with external systems.
+
+
+
Services
+
+
First we’ll take a look at Services.
+Both the Hooks and Services integrations can be found in the Settings section of your repository, where we previously looked at adding Collaborators and changing the default branch of your project.
+Under the “Webhooks and Services” tab you will see something like Services and Hooks configuration section..
+
+
+
+
}}" alt="Services and hooks">
+
+
نمودار 130. Services and Hooks configuration section.
+
+
+
There are dozens of services you can choose from, most of them integrations into other commercial and open source systems.
+Most of them are for Continuous Integration services, bug and issue trackers, chat room systems and documentation systems.
+We’ll walk through setting up a very simple one, the Email hook.
+If you choose “email” from the “Add Service” dropdown, you’ll get a configuration screen like Email service configuration..
+
+
+
+
}}" alt="Email service">
+
+
نمودار 131. Email service configuration.
+
+
+
In this case, if we hit the “Add service” button, the email address we specified will get an email every time someone pushes to the repository.
+Services can listen for lots of different types of events, but most only listen for push events and then do something with that data.
+
+
+
If there is a system you are using that you would like to integrate with GitHub, you should check here to see if there is an existing service integration available.
+For example, if you’re using Jenkins to run tests on your codebase, you can enable the Jenkins builtin service integration to kick off a test run every time someone pushes to your repository.
+
+
+
+
Hooks
+
+
If you need something more specific or you want to integrate with a service or site that is not included in this list, you can instead use the more generic hooks system.
+GitHub repository hooks are pretty simple.
+You specify a URL and GitHub will post an HTTP payload to that URL on any event you want.
+
+
+
Generally the way this works is you can setup a small web service to listen for a GitHub hook payload and then do something with the data when it is received.
+
+
+
+
+
}}" alt="Web hook">
+
+
نمودار 132. Web hook configuration.
+
+
+
The configuration for a web hook is pretty simple.
+In most cases you simply enter a URL and a secret key and hit “Add webhook”.
+There are a few options for which events you want GitHub to send you a payload for — the default is to only get a payload for the push event, when someone pushes new code to any branch of your repository.
+
+
+
Let’s see a small example of a web service you may set up to handle a web hook.
+We’ll use the Ruby web framework Sinatra since it’s fairly concise and you should be able to easily see what we’re doing.
+
+
+
Let’s say we want to get an email if a specific person pushes to a specific branch of our project modifying a specific file.
+We could fairly easily do that with code like this:
+
+
+
+
require 'sinatra'
+require 'json'
+require 'mail'
+
+post '/payload' do
+ push = JSON.parse(request.body.read) # parse the JSON
+
+ # gather the data we're looking for
+ pusher = push["pusher"]["name"]
+ branch = push["ref"]
+
+ # get a list of all the files touched
+ files = push["commits"].map do |commit|
+ commit['added'] + commit['modified'] + commit['removed']
+ end
+ files = files.flatten.uniq
+
+ # check for our criteria
+ if pusher == 'schacon' &&
+ branch == 'ref/heads/special-branch' &&
+ files.include?('special-file.txt')
+
+ Mail.deliver do
+ from 'tchacon@example.com'
+ to 'tchacon@example.com'
+ subject 'Scott Changed the File'
+ body "ALARM"
+ end
+ end
+end
+
+
+
+
Here we’re taking the JSON payload that GitHub delivers us and looking up who pushed it, what branch they pushed to and what files were touched in all the commits that were pushed.
+Then we check that against our criteria and send an email if it matches.
+
+
+
In order to develop and test something like this, you have a nice developer console in the same screen where you set the hook up.
+You can see the last few deliveries that GitHub has tried to make for that webhook.
+For each hook you can dig down into when it was delivered, if it was successful and the body and headers for both the request and the response.
+This makes it incredibly easy to test and debug your hooks.
+
+
+
+
}}" alt="Webhook debug">
+
+
نمودار 133. Web hook debugging information.
+
+
+
The other great feature of this is that you can redeliver any of the payloads to test your service easily.
+
+
+
+
+
The GitHub API
+
+
+Services and hooks give you a way to receive push notifications about events that happen on your repositories, but what if you need more information about these events?
+What if you need to automate something like adding collaborators or labeling issues?
+
+
+
This is where the GitHub API comes in handy.
+GitHub has tons of API endpoints for doing nearly anything you can do on the website in an automated fashion.
+In this section we’ll learn how to authenticate and connect to the API, how to comment on an issue and how to change the status of a Pull Request through the API.
+
+
+
Basic Usage
+
+
The most basic thing you can do is a simple GET request on an endpoint that doesn’t require authentication.
+This could be a user or read-only information on an open source project.
+For example, if we want to know more about a user named “schacon”, we can run something like this:
+
+
+
+
$ curl https://api.github.com/users/schacon
+{
+ "login": "schacon",
+ "id": 70,
+ "avatar_url": "https://avatars.githubusercontent.com/u/70",
+# …
+ "name": "Scott Chacon",
+ "company": "GitHub",
+ "following": 19,
+ "created_at": "2008-01-27T17:19:28Z",
+ "updated_at": "2014-06-10T02:37:23Z"
+}
+
+
+
+
There are tons of endpoints like this to get information about organizations, projects, issues, commits — just about anything you can publicly see on GitHub.
+You can even use the API to render arbitrary Markdown or find a .gitignore template.
+
+
+
+
$ curl https://api.github.com/gitignore/templates/Java
+{
+ "name": "Java",
+ "source": "*.class
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.ear
+
+# virtual machine crash logs, see https://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+"
+}
+
+
+
+
+
+
However, if you want to do an action on the website such as comment on an Issue or Pull Request or if you want to view or interact with private content, you’ll need to authenticate.
+
+
+
There are several ways to authenticate.
+You can use basic authentication with just your username and password, but generally it’s a better idea to use a personal access token.
+You can generate this from the “Applications” tab of your settings page.
+
+
+
+
}}" alt="Access Token">
+
+
نمودار 134. Generate your access token from the “Applications” tab of your settings page.
+
+
+
It will ask you which scopes you want for this token and a description.
+Make sure to use a good description so you feel comfortable removing the token when your script or application is no longer used.
+
+
+
GitHub will only show you the token once, so be sure to copy it.
+You can now use this to authenticate in your script instead of using a username and password.
+This is nice because you can limit the scope of what you want to do and the token is revocable.
+
+
+
This also has the added advantage of increasing your rate limit.
+Without authenticating, you will be limited to 60 requests per hour.
+If you authenticate you can make up to 5,000 requests per hour.
+
+
+
So let’s use it to make a comment on one of our issues.
+Let’s say we want to leave a comment on a specific issue, Issue #6.
+To do so we have to do an HTTP POST request to repos/<user>/<repo>/issues/<num>/comments with the token we just generated as an Authorization header.
+
+
+
+
$ curl -H "Content-Type: application/json" \
+ -H "Authorization: token TOKEN" \
+ --data '{"body":"A new comment, :+1:"}' \
+ https://api.github.com/repos/schacon/blink/issues/6/comments
+{
+ "id": 58322100,
+ "html_url": "https://github.com/schacon/blink/issues/6#issuecomment-58322100",
+ ...
+ "user": {
+ "login": "tonychacon",
+ "id": 7874698,
+ "avatar_url": "https://avatars.githubusercontent.com/u/7874698?v=2",
+ "type": "User",
+ },
+ "created_at": "2014-10-08T07:48:19Z",
+ "updated_at": "2014-10-08T07:48:19Z",
+ "body": "A new comment, :+1:"
+}
+
+
+
+
+
+
You can use the API to do just about anything you can do on the website — creating and setting milestones, assigning people to Issues and Pull Requests, creating and changing labels, accessing commit data, creating new commits and branches, opening, closing or merging Pull Requests, creating and editing teams, commenting on lines of code in a Pull Request, searching the site and on and on.
+
+
+
Changing the Status of a Pull Request
+
+
There is one final example we’ll look at since it’s really useful if you’re working with Pull Requests.
+Each commit can have one or more statuses associated with it and there is an API to add and query that status.
+
+
+
Most of the Continuous Integration and testing services make use of this API to react to pushes by testing the code that was pushed, and then report back if that commit has passed all the tests.
+You could also use this to check if the commit message is properly formatted, if the submitter followed all your contribution guidelines, if the commit was validly signed — any number of things.
+
+
+
Let’s say you set up a webhook on your repository that hits a small web service that checks for a Signed-off-by string in the commit message.
+
+
+
+
require 'httparty'
+require 'sinatra'
+require 'json'
+
+post '/payload' do
+ push = JSON.parse(request.body.read) # parse the JSON
+ repo_name = push['repository']['full_name']
+
+ # look through each commit message
+ push["commits"].each do |commit|
+
+ # look for a Signed-off-by string
+ if /Signed-off-by/.match commit['message']
+ state = 'success'
+ description = 'Successfully signed off!'
+ else
+ state = 'failure'
+ description = 'No signoff found.'
+ end
+
+ # post status to GitHub
+ sha = commit["id"]
+ status_url = "https://api.github.com/repos/#{repo_name}/statuses/#{sha}"
+
+ status = {
+ "state" => state,
+ "description" => description,
+ "target_url" => "http://example.com/how-to-signoff",
+ "context" => "validate/signoff"
+ }
+ HTTParty.post(status_url,
+ :body => status.to_json,
+ :headers => {
+ 'Content-Type' => 'application/json',
+ 'User-Agent' => 'tonychacon/signoff',
+ 'Authorization' => "token #{ENV['TOKEN']}" }
+ )
+ end
+end
+
+
+
+
Hopefully this is fairly simple to follow.
+In this web hook handler we look through each commit that was just pushed, we look for the string Signed-off-by in the commit message and finally we POST via HTTP to the /repos/<user>/<repo>/statuses/<commit_sha> API endpoint with the status.
+
+
+
In this case you can send a state (success, failure, error), a description of what happened, a target URL the user can go to for more information and a “context” in case there are multiple statuses for a single commit.
+For example, a testing service may provide a status and a validation service like this may also provide a status — the “context” field is how they’re differentiated.
+
+
+
+
+
}}" alt="Commit status">
+
+
نمودار 136. Commit status via the API.
+
+
+
You can now see a little green check mark next to the commit that has a “Signed-off-by” string in the message and a red cross through the one where the author forgot to sign off.
+You can also see that the Pull Request takes the status of the last commit on the branch and warns you if it is a failure.
+This is really useful if you’re using this API for test results so you don’t accidentally merge something where the last commit is failing tests.
+
+
+
Octokit
+
+
Though we’ve been doing nearly everything through curl and simple HTTP requests in these examples, several open-source libraries exist that make this API available in a more idiomatic way.
+At the time of this writing, the supported languages include Go, Objective-C, Ruby, and .NET.
+Check out https://github.com/octokit for more information on these, as they handle much of the HTTP for you.
+
+
+
Hopefully these tools can help you customize and modify GitHub to work better for your specific workflows.
+For complete documentation on the entire API as well as guides for common tasks, check out https://developer.github.com.
+
+
Summary
+
+
Now you’re a GitHub user.
+You know how to create an account, manage an organization, create and push to repositories, contribute to other people’s projects and accept contributions from others.
+In the next chapter, you’ll learn more powerful tools and tips for dealing with complex situations, which will truly make you a Git master.
+
خلاصه
+
+
با هم مروری بر شاخهسازی و مرج مقدماتی در گیت داشتیم.
+اکنون باید در ساخت و پریدن روی برنچهای جدید، جابهجایی بین برنچها و مرج کردن برنچهای محلی با یکدیگر احساس راحتی کنید.
+همچنین باید بتوانید برنچهای خود را با پوش کردن روی یک سرور مشترک به اشتراک بگذارید، بتوانید با دیگران روی برنچهای مشترک کار کنید و برنچهای خود را قبل از به اشتراکگذاری ریبیس کنید.
+از این پس، به بررسی مواردی که برای راهاندازی سرور میزبانی مخزن گیتتان نیاز دارید میپردازیم.
+
روند کاری شاخهسازی
+
+
حالا که مبانی شاخهسازی و ادغام را میدانید، چه کار میتوانید یا باید با آنها کنید؟
+در این بخش چندی از روندهای کاری که این حد سبک از شاخهسازی ممکن میکند را بررسی میکنیم تا شما بتوانید تصمیم بگیرید که در روند توسعه خودتان با آنها میخواهید چکار کنید.
+
+
شاخههای با قدمت
+
+
+از آنجایی که گیت از مرج سه طرفهٔ سادهای استفاده میکند، مرج کردن متوالی برنچی به برنچ دیگر عموماً آسان است.
+این بدان معناست که میتوانید چندین برنچ داشته باشید که همیشه باز هستند و از آنها برای بخشهای مختلف چرخهٔ توسعه خود استفاده کنید؛ میتوانید به طور منظم آنها را در یکدیگر ادغام کنید.
+
+
+
بسیاری از توسعهدهنگان روند کاری دارند که این رویکرد را در بر میگیرد، مثلاً در برنچ master خود فقط کدهای تماماً پایدار را نگهداری میکنند — که احتمالاً فقط کدی است که یا منتشر شده است یا منتشر خواهد شد.
+همچنین احتمالاً آنها برنچی موازی هم با نام develop یا next دارند که روی آن کار میکنند یا از آن برای تست ثبات استفاده میکنند — این برنچ لزوماً همیشه باثبات نیست لکن
+هرگاه که به وضعیت باثباتی برسد میتواند در master مرج شود.
+هنگام آماده شدن برنچهای موضوعی (برنچهای کوتاه عمری مانند iss53 قبلترتان) این برنچ برای پول کردن آنها استفاده میشود تا از اینکه آنها همهٔ تستها را پاس میشوند و باگی تولید نمیکنند اطمینان حاصل شود.
+
+
+
در حقیقت ما دربارهٔ نشانگرهایی که در خطوط کامیتهای تولیدی شما حرکت میکنند حرف میزنیم.
+برنچ باثبات معمولاً بسیار پایینتر در خط تاریخچهٔ کامیتهای شما هستند و برنچهای بروز (Bleeding-edge) بسیار بالاتر در تاریخچه قرار دارند.
+
+
+
+
}}" alt="A linear view of progressive-stability branching.">
+
+
نمودار 26. دیدگاهی خطی به شاخهسازی ثبات-مترقی
+
+
+
به طور کل آسانتر است که به برنچها به عنوان سیلوهای کار نگاه کنیم. جایی که وقتی مجموعهای از کامیتها کاملاً تست شدند به سمت سیلویی باثباتتر انتقال داده میشوند.
+
+
+
+
}}" alt="A ``silo'' view of progressive-stability branching.">
+
+
نمودار 27. دیدگاهی «سیلو» محور به شاخهسازی ثبات-مترقی
+
+
+
شما میتوانید این فرآیند را برای چند مرتبه از ثبات تکرار کنید.
+بعضی از پروژههای بزرگتر همچنین برنچ pu یا proposed (بروزرسانی پیشنهادی) دارند که مجتمعی از برنچهایی است که ممکن است هنوز برای راه یافتن به برنچ master یا next آماده نباشند.
+ایدهٔ کلی این است که برنچهای شما در مرتبههای مختلف ثبات هستند؛ وقتی به مرتبهٔ بالاتری از ثبات رسیدند، در برنچی که در مرتبهٔ بالاتر است مرج خواهند شد.
+مجدداً، داشتن چندین برنچها فعال همزمان لزومی ندارد، اما اغلب مفید است، به خصوص وقتی که با پروژههای خیلی بزرگ یا پیچیده سروکار دارید.
+
+
+
شاخههای موضوعی
+
+
+برنچهای موضوعی، از سوی دیگر، در پروژههایی با هر اندازه مفید هستند.
+یک برنچ موضوعی، برنچی کم عمر است که مختص یک کار یا ویژگی خاص میسازید و استفاده میکنید.
+این کاری است که به احتمال خیلی زیاد، هرگز در هیچ VCS دیگر انجام ندادهاید چرا که به طور کل هزینهٔ ساخت و ادغام برنچها زیاد است.
+لکن در گیت ساختن، ادغام، پاککردن و کار کردن روزانهٔ برنچها رایج است.
+
+
+
در بخش قبل هنگام کار با برنچهای iss53 و hotfix که ساختید متوجه این شدهاید.
+شما تعدادی کامیت روی آنها ساختید و آنها را به محض ادغام با برنچ اصلیتان پاک کردید.
+این روش به شما این امکان را میدهد که سریعاً و تماماً محتوای کاری را تغییر دهید — از آنجایی که کارهای شما به سیلوهایی مجزا تقسیم شده که تمام تغییراتی که در آن برنچ اعمال میشود باید مرتبط با آن موضوع باشد، اطلاع از اتفاقاتی که حین بازبینی کد و غیره افتاده بسیار آسانتر است.
+شما میتوانید تغییرات خود را برای دقایق، روزها و یا ماهها نگهداری کنید و وقتی آماده بودند آنها را بیتوجه به ترتیب کاری یا پیدایش آنها ادغام کنید.
+
+
+
شرایطی را تصور کنید که در حال کار کردن (روی master) هستید، برای یک ایشو یک برنچ میسازید (iss91)، کمی روی آن کار میکنید، برنچ دومی را میسازید تا همان مسئله را
+به صورت دیگری حل کنید (iss91v2)، به برنچ master خود باز میگردید و آنجا کمی فعالیت میکنید و سپس یک برنچ دیگر میسازید تا کمی روی ایدهای که مطمئن نیستید خوب است یا خیر کار کنید (برنچ dumbidea).
+تایخچهٔ کامیتهایتان این شکلی به نظر خواهد رسید:
+
+
+
+
}}" alt="Multiple topic branches.">
+
+
نمودار 28. چندین برنچ موضوعی
+
+
+
حال فرض کنیم که فکر میکنید راه حل دوم بهترین راه حل برای این مشکل است (iss91v2)؛ و برنچ dumbidea را نیز به همکارتان نشان دادهاید و بسیار هوشمندانه به نظر رسیده است.
+شما میتوانید برنچ iss91 را حذف کنید (کامیتهای C5 و C6 را از دست میدهید) و دو برنچ دیگر را ادغام میکنید.
+پس از این تاریخچهٔ شما بدین شکل خواهد بود:
+
+
+
+
}}" alt="History after merging `dumbidea` and `iss91v2`.">
+
+
نمودار 29. تاریخچه پس از ادغام dumbidea و iss91v2
+
+
+
+
در گیت توزیعشده به جزئیات بیشتر دربارهٔ روندهای کاری متفاوت برای پروژه گیتتان میپردازیم،
+بنابراین پیش از اینکه تصمیم بگیرید برای پروژه آینده خود چه ساختار شاخهسازی میخواهید، مطمئن باشید که آن فصل را مطالعه کردهاید.
+
+
+
مهم است به خاطر داشته باشید که هنگامی که تمام این کارها انجام میشود، تمام برنچها تماماً محلی هستند.
+وقتی شاخهسازی یا مرج میکنید، همه چیز فقط در مخزن گیت شما اتفاق میافتد — ارتباطی با سرور برقرار نیست.
+
+
ریبیسکردن
+
+
+در گیت دو راه اصلی برای تعبیه تغییرات از برنچی به برنچ دیگر وجود دارد: merge و rebase.
+در این بخش خواهید آموخت که ریبیس (Rebase) چیست، چکار میکند، چرا ابزار شگفتانگیزی است و در چه شرایطی نمیخواهید از آن استفاده کنید.
+
+
ریبیس مقدماتی
+
+
اگر به یک مثال قدیمیتر از ادغام مقدماتی بازگردیم، میبینید که کار شما و کامیتهای که کردهاید دوشاخه شده است.
+
+
+
+
}}" alt="Simple divergent history.">
+
+
نمودار 35. تاریخچهٔ دوشاخهٔ ساده
+
+
+
همانطور که قبلاً بررسی کردیم، آسانترین راه برای یکپارچهسازی برنچها دستور merge است.
+این دستور یک ادغامسازی سه طرفه بین آخرین اسنپشاتهای دو برنچ (C3 و C4) و آخرین والد مشترک آنها (C2) انجام میدهد، یک اسنپشات جدید میسازد (و آنرا کامیت میکند).
+
+
+
+
}}" alt="Merging to integrate diverged work history.">
+
+
نمودار 36. مرج کردن جهت یکپارچهسازی تاریخچهٔ کار دوشاخه
+
+
+
هرچند راه دیگری نیز وجود دارد: شما میتوانید پچ تغییراتی که در C4 معرفی شدهاند را گرفته و آنرا به بالای C3 اعمال کنید.
+در گیت این عمل ریبیسکردن نامیده میشود.
+با دستور rebase شما میتوانید تمام تغییراتی که روی یک برنچ کامیت شدهاند را بگیرید و آنها را به برنچ دیگر بازاعمال کنید.
+
+
+
برای این مثال شما برنچ experiment را چکاوت میکنید و بعد آنرا به master ریبیس میکنید، که به این شکل است:
+
+
+
+
$ git checkout experiment
+$ git rebase master
+First, rewinding head to replay your work on top of it...
+Applying: added staged command
+
+
+
+
این عملیات با رفتن به والد مشترک دو برنچ (آنکه رویش قرار دارید و آنکه رویش ریبیس میکنید)، گرفتن دیف معرفی شده در هر کامیت برنچی که روی آن هستید،
+ذخیره آن دیفها روی فایلهای موقت، بازنشانی برنچ فعلی به کامیت برنچی که روی آن ریبیس میکنید و در نهایت اعمال به ترتیب تغییرات کار میکند.
+
+
+
+
}}" alt="Rebasing the change introduced in `C4` onto `C3`.">
+
+
نمودار 37. ریبیس کردن تغییرات معرفی شده در C4 به روی C3
+
+
+
+
در این نقطه میتوانید به برنچ master بازگردید و یک مرج fast-forward کنید.
+
+
+
+
$ git checkout master
+$ git merge experiment
+
+
+
+
+
}}" alt="Fast-forwarding the `master` branch.">
+
+
نمودار 38. فست-فوروارد کردن برنچ master
+
+
+
+
حال اسنپشاتی که C4' به آن اشاره میکند دقیقاً به مانند همانی است که که سابقاً توسط C5 در مثال مرج به آن اشاره میشد.
+تفاوتی در محصول نهایی این یکپارچهسازی وجود ندارد اما ریبیسکردن تاریخچهای تمیزتر را خلق میکند.
+اگر لاگ یک برنچ ریبیسشده را مطالعه کنید، به نظر یک تاریخچهٔ خطی است: طوری نمایش داده میشود که انگار همه چیز در طی یک فرآیند سری اتفاق افتاده حتی اگر در حقیقت به طور موازی انجام شده است.
+
+
+
توجه داشته باشید که اسنپشاتی که توسط کامیت نهایی تولیدی به آن اشاره میشود، چه آخرین کامیت ریبیسشده باشد، چه آخرین کامیت پس از مرج باشید، همان اسنپشات است — فقط تاریخچه تغییر کرده است.
+ریبیسکردن تغییرات را به ترتیبی که معرفی شدهاند از خطی که به خط دیگر باز اعمال میکند، درحالی که مرج نقاط نهایی را میگیرد و آنها را ادغام میکند.
+
+
+
ریبیسهای جذابتر
+
+
شما همچنین میتوانید تغییرات را روی چیزی به غیر از برنچ هدف اعمال کنید.
+به طور مثال یک تاریخچه مانند تاریخچهای با یک برنچ موضوعی که از برنچ موضوعی دیگر شروع میشود را در نظر بگیرید.
+یک برنچ موضوعی (server) ساختید تا چند مورد سمت سرور به پروژهٔ خود اضافه کنید و کامیتی گرفتید.
+سپس یک برنچ ساختید (client) تا تغییرات سمت کلاینت را اعمال کنید و چند کامیت هم آنجا گرفتید.
+در نهایت به برنچ سرور بازگشتید و چند کامیت دیگر گرفتهاید.
+
+
+
+
}}" alt="A history with a topic branch off another topic branch.">
+
+
نمودار 39. تاریخچهای با یک برنچ موضوعی که از برنچ موضوعی دیگر شروع میشود
+
+
+
فرض کنید تصمیم دارید که برای یک انتشار، تغییرات سمت کلاینت را در خط اصلی پروژه ادغام کنید ولی میخواهید که تغییرات سمت سرور تا زمان تست شدن باقی بمانند.
+شما میتوانید با استفاده از آپشن --onto از دستور git rebase تغییراتی از client را که در server نیستند (C8 و C9) را گرفته و آنها را روی برنچ master اعمال کنید:
+
+
+
+
$ git rebase --onto master server client
+
+
+
+
این دستور خیلی ساده میگوید که «برنچ client را بگیر، از زمانی که از server جدا شده تغییرات آن را بررسی کن و آنها را دوباره طوری به برنچ client اعمال کن که انگار برنچ مستقیماً
+از پایهٔ master شروع شده بوده.»
+کمی پیچیده است اما نتایجش جالب هستند.
+
+
+
+
}}" alt="Rebasing a topic branch off another topic branch.">
+
+
نمودار 40. ریبیس کردن یک برنچ موضوعی از یک برنچ موضوعی دیگر
+
+
+
+
+
$ git checkout master
+$ git merge client
+
+
+
+
+
}}" alt="Fast-forwarding your `master` branch to include the client branch changes.">
+
+
نمودار 41. فست-فوروارد کردن برنچ master برای اضافه کردن تغییرات برنچ کلاینت
+
+
+
بیایید فرض کنیم که تصمیم گرفتهاید تا برنچ سرور خود را نیز پول کنید.
+با اجرای git rebase <basebranch> <topicbranch> میتوانید برنچ server را روی master ریبیس کنید بدون آنکه مجبور باشید ابتدا آنرا چکاوت کنید — این دستور برای شما
+برنچ موضوعی را چکاوت میکند (در این مثال server) و تغییرات آنرا روی برنچ پایه (بیس) (master) بازاعمال میکند.
+
+
+
+
$ git rebase master server
+
+
+
+
+
+
}}" alt="Rebasing your server branch on top of your `master` branch.">
+
+
نمودار 42. ریبیس کردن برنچ سرورتان روی برنچ master
+
+
+
+
پس از این میتوانید برنچ پایه (master) را fast-forward کنید:
+
+
+
+
$ git checkout master
+$ git merge server
+
+
+
+
شما میتوانید برنچهای client و server را حذف کنید چراکه تمام کارها تعبیه شدهاند و شما دیگر به آنها احتیاجی ندارید، در نتیجه تمام تاریخچه شما مشابه تاریخچهٔ کامیت نهایی میشود:
+
+
+
+
$ git branch -d client
+$ git branch -d server
+
+
+
+
+
}}" alt="Final commit history.">
+
+
نمودار 43. تاریخچهٔ کامیت نهایی
+
+
+
خطرات ریبیسکردن
+
+
+ولی، ریبیس هم مشکلات خودش را دارد، مشکلاتی که در یک خط خلاصه میتوان از آنها اجتناب کرد:
+
+
+
کامیتهایی که خارج از مخزن شما هستند و یا کار دیگران به آن بستگی دارد را ریبیس نکنید.
+
+
+
اگر این راهنما را به گوش بسپارید، با مشکلی مواجه نخواهید شد.
+اگر نسپارید، ملت از شما متنفر خواهند شد و شما توسط دوستان و خانوادهٔ خود ترد خواهید شد.
+
+
+
وقتی چیزی را ریبیس میکنید، در حال پشت سر گذاشتن کامیتهای حاضر و ساختن کامیتهای مشابه، اما متفاوت، با آنها هستید.
+اگر جایی این کامیتها را پوش کنید و دیگران آنها را پول کرده و روی آنها کار کنند و سپس آن کامیتها را با git rebase بازنویسی و دوباره پوش کنید، همکاران شما مجبور
+خواهند بود تا دوباره کار خود را باز-ادغام کنند و هنگامی که بخواهید کار آنها را به کار خودتان پول کنید همهچیز خراب خواهد شد.
+
+
+
بیایید نگاهی به مثالی از اینکه چگونه ریبیس کردن کاری که به صورت عمومی انتشار دادهاید میتواند مشکلساز باشد بیاندازیم.
+فرض کنید که از یک سرور مرکزی کلون کردهاید و سپس کمی کار روی آن انجام دادهاید.
+تاریخچهٔ کامیت شما شبیه زیر است:
+
+
+
+
}}" alt="Clone a repository, and base some work on it.">
+
+
نمودار 44. یک مخزن را کلون میکنید و کمی کار روی آن انجام میدهید
+
+
+
حال شخص دیگری نیز کمی کار محتوی یک مرج انجام میدهد و آنرا به سرور مرکزی پوش میکند.
+شما آنرا فچ میکنید و برنچ ریموت جدید را در کار خود مرج میکنید که باعث میشود تاریخچهٔ شما به شکل زیر شود:
+
+
+
+
}}" alt="Fetch more commits, and merge them into your work.">
+
+
نمودار 45. کامیتهای بیشتری را فچ میکنید و آنها را با کار خود مرج میکنید
+
+
+
پس از این، شخصی که کار مرجشده را پوش کرده تصمیم میگیرد که باز گردد و بجای آن کار خود را ریبیس کند؛ او یک git push --force میکند تا تاریخچهٔ سرور را بازنویسی کند.
+سپس شما آن سرور را فچ میکنید و کامیتهای جدید را دریافت میکنید:
+
+
+
+
}}" alt="Someone pushes rebased commits, abandoning commits you’ve based your work on.">
+
+
نمودار 46. شخصی کامیتهای ریبیسشده را پوش میکند، کامیتهایی که شما کار خود را روی آنها بنا گذاشتهاید را پشت سر میگذارد
+
+
+
حالا هر دوی شما گیر افتادهاید.
+اگر شما git pull کنید، یک مرج کامیت خواهید ساخت که شامل هر دو خط از تاریخچه خواهد بود و مخزن شما به شکل زیر در خواهد آمد:
+
+
+
+
}}" alt="You merge in the same work again into a new merge commit.">
+
+
نمودار 47. شما همان کارها را دوباره مرج میکنید و یک مرج کامیت جدید میسازید
+
+
+
اگر در همین حین که تاریخچهٔ شما به این شکل است، یک git log اجرا کنید خواهید دید که دو کامیت وجود دارد که دقیقاً یک نویسنده، تاریخ و پیغام دارند که میتواند بسیار گیجکننده باشد.
+بعلاوه اگر این تاریخچه را به سرور پوش کنید، شما تمام آن کامیتهای ریبیس شده را دوباره به سرور مرکزی معرفی میکنید که به مقدار گیجکنندگی مسئله بیش از پیش میافزاید.
+خیلی راحت میتوان فرض را بر این گذاشت که توسعهدهندگان دیگر نمیخواهند که C4 و C6 در تاریخچه باشند و همین باعث بوده که در وهله اول ریبیس انجام شود.
+
+
+
وقتی ریبیس میکنید ریبیس کنید
+
+
اگر شما خودتان را در چنین شرایطی میبینید، گیت کمی راه حل جادویی پیش پای شما گذاشته است که ممکن است به شما کمک کنند.
+اگر شخصی در تیمتان فورس پوشی کرده که پایهٔ کار شما را بازنویسی کرده است، چالش شما تشخیص این خواهد بود که چه کاری مال شماست و چه چیزی را آنها بازنویسی کردهاند.
+
+
+
در اینجا معلوم میشود که علاوه بر چکسام SHA-1 کامیت، گیت همچنین چکسامی از تغییراتی که کامیت به تاریخچه افزوده محاسبه میکند.
+این چکسام را «شناسهٔ پچ» (Patch-ID) میخوانیم.
+
+
+
اگر کاری که بازنویسی شده را پول کردهاید و آنرا به روی کامیتهای جدید همکارتان ریبیس کنید، اکثر مواقع گیت متوجه میشود که چه کاری منحصر به شماست و آنها را دوباره به بالای برنچ جدید اعمال میکند.
+
+
+
+
+-
+
خواهد فهمید که چه کاری مختص به برنچ ماست (C2، C3، C4، C6، C7)
+
+-
+
خواهد فهمید کدام کامیتها مرج نشدهاند (C2، C3، C4)
+
+-
+
خواهد فهمید کدام کامیتها در برنچ هدف بازنویسی نشدهاند (فقط C2 و C3، از آنجایی که C4 همان پچ C4' است)
+
+-
+
آن کامیتها را به روی teamone/master اعمال خواهد کرد
+
+
+
+
+
+
+
}}" alt="Rebase on top of force-pushed rebase work.">
+
+
نمودار 48. به روی یک کار ریبیس و فورس پوش شده ریبیس میکنید
+
+
+
این فقط در شرایطی کار خواهد کرد که C4 و C4' که همکار شما ساخته تقریباً پچهای یکسانی هستند.
+در غیر این صورت ریبیس به شما نخواهد گفت که تغییرات کپی هستند و یک پچ شبه-C4 (که احتمالاً اعمالش شکست خواهد خورد چراکه تغییرات قبلاً یک جایی پیادهسازی شدهاند) میسازد.
+
+
+
شما همچنین میتوانید با اجرای git pull --rebase به جای یک git pull معمولی این را سادهتر کنید.
+یا میتوانستید با یک git fetch که پس از آن git rebase teamone/master (با توجه به مثال) اجرا شده به طور دستی آنرا انجام دهید.
+
+
+
اگر از git pull استفاده میکنید و میخواهید --rebase پیشفرض باشد، میتوانید مقدار کانفیگ pull.rebase را با چیزی مشابه git config --global pull.rebase true تنظیم کنید.
+
+
+
اگر شما فقط کامیتهایی که هرگز کامپیوتر شما را ترک نکردهاند ریبیس میکنید به مشکلی بر نخواهید خورد.
+اگر کامیتهایی را ریبیس میکنید که پوش شدهاند اما هیچ شخص دیگری روی آنها کاری را شروع نکرده است باز هم به مشکلی بر نخواهید خورد.
+اگر کامیتهایی را ریبیس میکنید که به طور عمومی پوش کردهاید و ممکن است اشخاصی روی آنها کار کرده باشند، ممکن است در دردسر طاقتفرسایی افتاده باشید و توسط هم تیمیهایتان ترد شوید.
+
+
+
اگر شما یا همکارتان به این نتیجه رسید که انجام چنین کاری ضروری است، از اینکه همه git pull --rebase را اجرا میکنند اطمینان حاصل کنید تا در آینده درد کمتری نسیبتان شود.
+
+
+
ریبیس در مقابل ادغام
+
+
+حال که ریبیس و مرج را در عمل دیدید، ممکن است به این فکر کنید که کدام بهتر است.
+پیش از اینکه به آن پاسخ دهیم بیایید کمی به عقب بازگردیم و به مبحث اینکه تاریخچه چه معنایی دارد بپردازیم.
+
+
+
از دیدگاهی تاریخچهٔ کامیتهای مخزن شما ثبت وقایع اتفاق افتاده است.
+سندی تاریخی و باارزش است که نباید با آن خیلی بازی کرد.
+از این زاویه دید تغییر دادن تاریخچهٔ کامیتها تقریباً تعریف را نقض میکند؛ شما در حال دروغ گفتن دربارهٔ اتفاقاتی هستید که واقعاً افتادهاند.
+پس اگر دستهای از مرج کامیتهای شلوغ داشته باشیم چه کنیم؟
+اتفاقی است که افتاده و مخزن باید آنرا برای آیندگان نگه دارد.
+
+
+
در نقطه مقابل دیدگاهی است که میگوید تاریخچهٔ کامیتها داستان چگونگی ساخت پروژهٔ شما است.
+پیش نمیآید که اولین پیشنویس یک کتاب و راهنمایی درباره اینکه «چرا نرمافزارتان مستحق ویرایشهای محتاطانه است» منتشر کنید.
+افرادی که این دیدگاه را دارند از ابزارهایی مانند rebase و filter-branch استفاده میکنند تا داستان را به نحوی بسرایند که برای خوانندگان احتمالی پخته باشد.
+
+
+
حال برای جواب دادن به اینکه مرج بهتر است یا ریبیس: خوشبختانه ملاحظه میکنید که جواب دادن خیلی ساده نیست.
+گیت ابزار قدرتمندی است، به شما اجازهٔ انجام خیلی کارها را به خصوص روی تاریخچهتان میدهد، اما هر تیم و هر پروژه متفاوت است.
+حال که میدانید چگونه اینها کار میکنند، به شما بستگی دارد که تصمیم بگیرید که کدام برای شرایط بخصوص شما بهترین است.
+
+
+
در کل بهترین حالت ممکن این است که تغییرات محلی را که اعمال کردهاید اما منتشر نکردهاید ریبیس کنید تا پیش از پوش تاریخچهٔ شما تمیز باشد، اما هرگز هیچ چیزی را که جایی پوش کردهاید ریبیس نکنید.
+
+
شاخهسازی و ادغام مقدماتی
+
+
حال بیایید با هم به یک نمونه ساده از مرجکردن و برنچسازی با یک روند کاری که احتمالاً در دنیای واقعی از آن استفاده خواهید کرد بپردازیم.
+شما این مراحل را دنبال خواهید کرد:
+
+
+-
+
کمی کار روی یک پروژه وبسایت کنید.
+
+-
+
یک برنچ جدید برای یک یوزراستوری جدید که روی آن کار میکنید بسازید.
+
+-
+
روی آن برنچ کمی کار کنید.
+
+
+
+
در این وهله شما تماسی دریافت میکنید که یک مورد بحرانی پیش آمده و باید یک راه حل سریع (هاتفیکس) برای آن آماده کنید.
+شما اینگونه عمل خواهید کرد:
+
+
+-
+
به برنچ پروداکشن خود بروید.
+
+-
+
یک برنچ برای اضافه کردن هاتفیکس به پروژه بسازید.
+
+-
+
پس از اینکه تست شد برنچ هاتفیکس را مرج کنید و تغییرات را به برنچ پروداکشن پوش کنید.
+
+-
+
به یوزراستوری قبلی که روی آن کار میکردید باز گردید و به ادامهٔ کار بپردازید.
+
+
+
+
شاخهسازی مقدماتی
+
+
+در ابتدا فرض کنیم که شما روی پروژهای کار میکنید و از قبل تعدادی کامیت روی برنچ master دارید.
+
+
+
+
}}" alt="A simple commit history.">
+
+
نمودار 18. یک تاریخچهٔ کامیت ساده
+
+
+
شما تصمیم گرفتهاید که روی ایشو #53 در سیستم پیگیری-مشکلی (Issue-Tracking System) که کمپانی شما از آن استفاده میکند کار کنید.
+برای ساختن یک برنچ جدید و تعویض برنچ در آن واحد میتوانید دستور git checkout را با کلید -b اجرا کنید:
+
+
+
+
$ git checkout -b iss53
+Switched to a new branch "iss53"
+
+
+
+
این دستور کوتاه شده خطوط زیر است:
+
+
+
+
$ git branch iss53
+$ git checkout iss53
+
+
+
+
+
}}" alt="Creating a new branch pointer.">
+
+
نمودار 19. ساختن یک نشانگر برنچ جدید
+
+
+
شما روی سایت خود کار میکنید و چند کامیت میکنید.
+انجام چنین کاری برنچ iss53 را به جلو منتقل میکند، به این دلیل که شما آنرا چکاوت کردهاید (یعنی HEAD شما به آن اشاره دارد):
+
+
+
+
$ vim index.html
+$ git commit -a -m 'Create new footer [issue 53]'
+
+
+
+
+
}}" alt="The `iss53` branch has moved forward with your work.">
+
+
نمودار 20. برنچ iss53 با کار شما به جلو رفته است
+
+
+
حال تماسی به شما میگوید که مشکلی در وبسایت هست و شما باید درجا آنرا درست کنید.
+با گیت، مجبور نمیشوید که فیکس خود را با تغییراتی که در iss53 دادهاید ارائه کنید و مجبور نیستید زحمتی در جهت بازگردانی آن تغییرات بکشید، پیش از اینکه بتوانید روی ارائه فیکس خود به نسخه پروداکشن کنید.
+تمام کاری که نیاز است انجام دهید این است که به برنچ master بازگردید.
+
+
+
اگرچه قبل از اینکه آن کار را انجام دهید باید دقت کنید که اگر پوشه کاری یا استیج شما تغییرات کامیتنشدهای دارد که باعث ایجاد تداخل (Conflict) در
+برنچی که میخواهید به آن چکاوت کنید میشود، گیت به شما اجازهٔ تعویض برنچ نمیدهد.
+همیشه بهتر است قبل از تعویض برنچ، پوشه کاری داشته باشید.
+راههای متفاوتی برای انجام این تمیزکاری وجود دارد (من جمله استش (Stash) و امند کردن کامیت) که در Stashing and Cleaning به آن خواهیم پرداخت.
+فعلاً بیاید فرض کنیم که همه تغییرات کامیت شدهاند، بنابراین میتوانید به برنچ master خود انتقال پیدا کنید:
+
+
+
+
$ git checkout master
+Switched to branch 'master'
+
+
+
+
تا اینجای کار پوشه کاری پروژهٔ شما دقیقاً مانند قبل از زمانی است که شروع به کار روی ایشو #53 کردید و میتوانید روی هاتفیکس خود تمرکز کنید.
+این نکته مهمی برای به خاطر سپردن است: هنگامی که برنچ را تعویض میکنید، گیت پوشه کاری شما را بازنشانی میکند تا دقیقاً به آن شکلی شود که آخرین بار روی آن برنچ کامیت کردید.
+گیت به طور خودکار فایلها را کم، زیاد یا ویرایش میکند تا مطمئن شود که کپی فعال شما عیناً مطابق آخرین کامیت روی برنچ است.
+
+
+
در ادامه شما باید به هاتفیکس خود بپردازید.
+بیاید یک برنچ hotfix بسازیم و تا زمان تمام شدنش روی آن کار کنیم:
+
+
+
+
$ git checkout -b hotfix
+Switched to a new branch 'hotfix'
+$ vim index.html
+$ git commit -a -m 'Fix broken email address'
+[hotfix 1fb7853] Fix broken email address
+ 1 file changed, 2 insertions(+)
+
+
+
+
+
}}" alt="Hotfix branch based on `master`.">
+
+
نمودار 21. برنچ هاتفیکس در ادامهٔ master
+
+
+
+
میتوانید تستهای خود را بگیرید، از اینکه هاتفیکس آنگونه که شما میخواهید هست اطمینان حاصل کنید و در آخر برنچ hotfix را با برنچ master مرج کنید تا روی
+محیط پروداکشن پیادهسازی کنید. شما میتوانید این کار را با دستور git merge انجام دهید:
+
+
+
+
$ git checkout master
+$ git merge hotfix
+Updating f42c576..3a0874c
+Fast-forward
+ index.html | 2 ++
+ 1 file changed, 2 insertions(+)
+
+
+
+
شما متوجه عبارت «fast-forward» در آن مرج میشوید.
+به این دلیل که کامیت C4 توسط برنچ hotfix مورد اشاره قرار گرفته که دقیقاً جلوی کامیت C2 است که شما روی آن کار میکنید، گیت به سادگی نشانگر را به جلو هل میدهد.
+به بیان دیگر وقتی سعی میکنید یک کامیت را با کامیت دیگری که میتوان از طریق یپمودن مسیر کامیت اول به آن رسید، مرج کنید،
+گیت نشانگر را به جلو میکشد چون دوشاخگی در مسیر وجود ندارد که گیت بخواهد آنرا ادغام کند — به این کار «fast-forward» میگویند.
+
+
+
اکنون تغییرات شما در اسنپشات کامیتی است که برنچ master به آن اشاره میکند و شما میتوانید فیکس خود را ارائه کنید.
+
+
+
+
}}" alt="`master` is fast-forwarded to `hotfix`.">
+
+
نمودار 22. برنچ master به hotfix فست-فوروارد شد.
+
+
+
پس از اینکه فیکس فوق مهمتان ارائه شد، آمادهاید تا به کاری که پیش از اینکه به شما اطلاع داده شود بازگردید.
+هرچند ابتدا شما برنچ hotfix را پاک خواهید کرد، چرا که دیگر آنرا احتیاج ندارید — برنچ master به همانجا اشاره دارد.
+شما میتوانید با آپشن -d دستور git branch آنرا پاک کنید:
+
+
+
+
$ git branch -d hotfix
+Deleted branch hotfix (3a0874c).
+
+
+
+
حال میتوانید به برنچ در حال تکمیل شدن قبلی که دربارهٔ ایشو #53 بود بازگردید و به کارکردن روی آن ادامه دهید:
+
+
+
+
$ git checkout iss53
+Switched to branch "iss53"
+$ vim index.html
+$ git commit -a -m 'Finish the new footer [issue 53]'
+[iss53 ad82d7a] Finish the new footer [issue 53]
+1 file changed, 1 insertion(+)
+
+
+
+
+
}}" alt="Work continues on `iss53`.">
+
+
نمودار 23. کار روی iss53 ادامه پیدا میکند
+
+
+
اهمیتی ندارد که کاری که روی برنچ hotfix خود به انجام رسانیدهاید در فایلهای برنچ iss53 موجود نیست.
+اگر احتیاج دارید تا آنرا اعمال کنید، میتوانید با اجرای git merge master برنچ master را در برنچ iss53 مرج کنید، یا میتوانید برای
+تعبیهسازی تغییرات صبر کنید تا زمانی که تصمیم بگیرید که برنچ iss53 را به برنچ master پول کنید.
+
+
+
ادغام مقدماتی
+
+
+فرض کنید به این نتیجه رسیدهاید که کار روی ایشوی #53 تمام شده و آماده است تا با برنچ master مرج شود.
+برای اینکه این کار را انجام دهید، شما برنچ iss53 را درون برنچ master میریزید و ادغام میکنید، بسیار شبیه به قبل، زمانی که برنچ hotfix را مرج کردید.
+تمام کاری که باید بکنید این است که برنچی که میخواهید تغییرات را به آن بریزید را چکاوت کنید و دستور git merge را اجرا کنید:
+
+
+
+
$ git checkout master
+Switched to branch 'master'
+$ git merge iss53
+Merge made by the 'recursive' strategy.
+index.html | 1 +
+1 file changed, 1 insertion(+)
+
+
+
+
این کمی متفاوت از مرج hotfix که قبلاً انجام دادهاید به نظر میرسد.
+در این مورد، تاریخچهٔ توسعهٔ شما از یک نقطه قدیمیتر به آنسو دوشاخه شده بود.
+چرا که کامیتی که روی برنچ کاری شماست، در مسیر مستقیم برنچی که با آن ادغام میشود نیست و گیت باید در این رابطه کاری کند.
+در این شرایط گیت یک مرج سه طرفه ساده، با استفاده از دو اسنپشاتی که نوک برنچها به آنها اشاره میکنند و یک والد مشترک از هر دو انجام میدهد.
+
+
+
+
}}" alt="Three snapshots used in a typical merge.">
+
+
نمودار 24. سه اسنپشات مورد استفاده در یک مرج معمولی
+
+
+
به جای جلو بردن پوینتر برنچ به جلو، گیت یک اسنپشات جدید میسازد که حاصل این مرج سه طرفه است و به طور خودکار یک کامیت میسازد که به آن اسنپشات اشاره میکند.
+این کامیت به عنوان یک مرج کامیت، نوعی کامیت خاص که بیش از یک والد دارد، شناخته میشود.
+
+
+
+
}}" alt="A merge commit.">
+
+
نمودار 25. یک مرج کامیت
+
+
+
حال که کار شما ادغام شده است و شما دیگر نیازی به برنچ iss53 ندارید.
+شما میتوانید ایشو را در سیستم پیگیری-مشکلتان ببندید و برنچ را پاک کنید:
+
+
+
+
تداخلات ادغام پایه
+
+
+هر از گاهی این فرآیند به این آسانی انجام نمیپذیرد.
+اگر یک بخش از یک فایل را در دو برنچی که مرج میکنید به دو نحو متفاوت ویرایش کردهاید، گیت نمیتواند به طور بینقص آنها را مرج کند.
+اگر فیکس شما برای ایشو #53 همان بخشی را از یک فایل ویرایش کرده که در برنچ hotfix هم ویرایش شده، شما یک تداخل (Conflict) مرج خواهید گرفت که چیزی شبیه زیر خواهد بود:
+
+
+
+
$ git merge iss53
+Auto-merging index.html
+CONFLICT (content): Merge conflict in index.html
+Automatic merge failed; fix conflicts and then commit the result.
+
+
+
+
گیت به طور خودکار یک مرج کامیت جدید نساخته است.
+فرآیند را متوقف کرده است تا شما تداخل را حل کنید.
+هرگاه میخواهید ببینید که چه فایلهایی در یک تداخل مرج، مرجنشده باقی ماندهاند، میتوانید دستور git status را اجرا کنید:
+
+
+
+
$ git status
+On branch master
+You have unmerged paths.
+ (fix conflicts and run "git commit")
+
+Unmerged paths:
+ (use "git add <file>..." to mark resolution)
+
+ both modified: index.html
+
+no changes added to commit (use "git add" and/or "git commit -a")
+
+
+
+
هر چیزی که تداخل مرج دارد و حل نشده باشد به عنوان «مرجنشده» (Unmerged) لیست میشود.
+گیت چند نشانگر استاندارد تفکیک-تداخل را به فایلهایی که در آنها تداخل هست اضافه میکند تا بتوانید آنها را به طور دستی باز کرده و تداخلها را حل کنید.
+فایل شما بخشی خواهد داشت که شبیه زیر خواهد بود:
+
+
+
+
<<<<<<< HEAD:index.html
+<div id="footer">contact : email.support@github.com</div>
+=======
+<div id="footer">
+ please contact us at support@github.com
+</div>
+>>>>>>> iss53:index.html
+
+
+
+
این بدان معناست که نسخهای که در HEAD وجود دارد (برنچ master شما، چرا که این برنچ جایی است که آخرین بار پیش از اینکه دستور مرج را اجرا کنید چکاوت کردید) بخش بالایی
+آن بلوک است (هر چیزی که بالای ======= قرار دارد)، در حالی که نسخهٔ درون برنچ iss53 مشابه نوشتههای بخش زیرین است.
+برای حل تداخل، شما میتوانید یکی از دو طرف را انتخاب کرده یا محتوا را خودتان ادغام کنید.
+به طور مثال ممکن است شما با جایگزین کردن کل آن بلوک با چنین محتوایی این تداخل را حل کنید:
+
+
+
+
<div id="footer">
+please contact us at email.support@github.com
+</div>
+
+
+
+
این راه حل کمی از هر بخش را در خود دارد و خطوط >>>>>>>، ======= و <<<<<<< هم کاملاً پاک شدهاند.
+بعد از اینکه هر کدام از این بخشها را در هر فایل متداخل را ویرایش کردید، git add را روی هر فایل اجرا کنید تا آنرا به عنوان حل شده علامتگذاری کنید.
+در گیت، استیجکردن فایل آنرا به عنوان حل شده علامتگذاری میکند.
+
+
+
اگر میخواهید از ابزاری گرافیکی برای حل این مسائل استفاده کنید، میتوانید git mergetool را اجرا کنید که
+یک ابزار مرج بصری مناسب اجرا میکند و شما را در تداخلها همراهی میکند:
+
+
+
+
$ git mergetool
+
+This message is displayed because 'merge.tool' is not configured.
+See 'git mergetool --tool-help' or 'git help config' for more details.
+'git mergetool' will now attempt to use one of the following tools:
+opendiff kdiff3 tkdiff xxdiff meld tortoisemerge gvimdiff diffuse diffmerge ecmerge p4merge araxis bc3 codecompare vimdiff emerge
+Merging:
+index.html
+
+Normal merge conflict for 'index.html':
+ {local}: modified file
+ {remote}: modified file
+Hit return to start merge resolution tool (opendiff):
+
+
+
+
اگر میخواهید از ابزار مرجی به جز ابزار پیشفرض استفاده کنید (در این مثال گیت opendiff را انتخاب کرده چرا که دستور روی یک مک اجرا شده)،
+میتوانید لیست تمام ابزارهای پشتیبانی شده را در بالا پس از «one of the following tools» مشاهده کنید.
+کافیست نام ابزاری که ترجیح میدهید استفاده کنید وارد کنید.
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ اگر به ابزار پیشرفتهتری برای حل تداخلهای خاص دارید، ما به بحث مرجکردن در Advanced Merging بیشتر میپردازیم.
+ |
+
+
+
+
+
پس از اینکه ابزار مرج را بستید، گیت از شما دربارهٔ موفقیت آمیز بودن یا نبودن مرج میپرسد.
+اگر به اسکریپت بگویید موفقیتآمیز بود، فایلها را استیج میکند تا آنها را برای شما به عنوان حل شده علامت زده باشد.
+شما میتوانید git status را دوباره اجرا کنید تا تصدیق کنید که تمام تداخلات حل شدهاند:
+
+
+
+
$ git status
+On branch master
+All conflicts fixed but you are still merging.
+ (use "git commit" to conclude merge)
+
+Changes to be committed:
+
+ modified: index.html
+
+
+
+
اگر از این خروجی راضی هستید و تصدیق میکنید که هر چیزی که تداخل داشته استیج شده، میتوانید git commit را تایپ کنید تا مرج کامیت را ثبت نهایی کنید.
+پیغام پیشفرض کامیت چیزی شبیه زیر خواهد بود:
+
+
+
+
Merge branch 'iss53'
+
+Conflicts:
+ index.html
+#
+# It looks like you may be committing a merge.
+# If this is not correct, please remove the file
+# .git/MERGE_HEAD
+# and try again.
+
+
+# Please enter the commit message for your changes. Lines starting
+# with '#' will be ignored, and an empty message aborts the commit.
+# On branch master
+# All conflicts fixed but you are still merging.
+#
+# Changes to be committed:
+# modified: index.html
+#
+
+
+
+
اگر فکر میکنید که برای دیگرانی که در آینده به این مرج کامیت نگاه میکنند مفیدتر خواهد بود، میتوانید این پیغام را با جزئیاتی درباره اینکه چگونه مرج
+را حل کردهاید بازنویسی کنید و اگر واضح نیست، توضیح دهید که چه تغییراتی اعمال کردهاید.
+
+
+تقریباً همهٔ VCSها نوعی پشتیبانی از شاخهسازی دارند.
+شاخه یا شعبهسازی (Branching) به معنی این است که شما از مسیر اصلی توسعه جدا شده و به ادامهٔ کار، بدون خرابی به بار آوردن در مسیر اصلی بپردازید.
+در بسیاری از VCSها این فرآیندی کموبیش پرهزینه است. اغلب شما را مجبور میکند که کپی جدیدی از پوشه سورس کدتان بگیرید که در پروژههای عظیم وقت زیادی را میگیرد.
برخی مدل شاخهسازی گیت را «خفنترین ویژگی» گیت میداند و به طور قطع این ویژگی جایگاه خاصی به گیت در جامعه VCS داده است.
+چرا این ویژگی اینچنین خاص است؟
+طریقه شاخهسازی در گیت بسیار سبکوزن است به گونهای که آنرا تقریباً بلادرنگ میکند، همچنین رفتوآمد بین شاخهها هم معمولاً به همان اندازه سریع است.
+بیتشابه به اکثر دیگر VCSها، گیت روند کاری را به شاخهشدن و مرج شدن سوق میدهد، حتی به اندازهای که چند بار در روز این کار انجام شود.
+فهم درست و خبره شدن در این قابلیت به شما ابزار یکتا و قدرتمندی میدهد و میتواند به کلی نحوه توسعهدادن کارتان را تغییر دهد.
+شاخهها در یک کلمه
+
+
برای اینکه به راستی نحوهٔ شاخهسازی گیت را درک کنید، باید یک قدم به عقب برگردیم و نحوهٔ ثبت اطلاعات گیت را مطالعه کنیم.
+
+
همانطور که از شروع به کار به یاد دارید، گیت دادهها را به عنوان دستهای از تغییرات یا تفاوتهایی بین فایلها ذخیره نمیکند؛
+بلکه اطلاعات را به عنوان مجموعهای از اسنپشاتها ذخیره میکند.
+
+
وقتی یک کامیت میسازید، گیت یک آبجکت کامیت که شامل یک نشانگر به اسنپشات دربرگیرندهٔ اطلاعات صحنهٔ شماست را ذخیره میکند.
+این آبجکت همچنین شامل نام نویسنده و آدرس ایمیل او، پیغامی که وارد کردهاید و یک نشانگر به کامیت یا کامیتهایی که مستقیماً قبل این کامیت (والد یا والدین) آمدهاند است:
+صفر والد برای کامیت اولیه، یک والد برای یک کامیت معمولی و چند والد برای یک کامیت مرج حاصل یک یا چند برنچ.
+
+
برای ملموس کردن این موضوع، فرض را بر این بگذاریم که پوشهای حاوی سه فایل داریم و شما همهٔ آنها را استیج و کامیت میکنید.
+استیج کردن فایلهای برای هر کدام از آنها یک چکسام (هش SHA-1 که درشروع به کار ذکر کردیم) محاسبه میکند، آن نسخه از فایل را در مخزن گیت ذخیره میکند،
+(گیت از این فایلهای با نام بلاب یاد میکند) و آن چکسام را به استیج اضافه میکند:
+
+
+
$ git add README test.rb LICENSE
+$ git commit -m 'Initial commit'
+
+
+
وقتی کامیتی را با اجرای git commit میسازید، گیت همهٔ زیرپوشهها (در مثال فقط روت پروژه) را چکسام میکند و آنها را به عنوان یک آبجکت درخت در مخزن گیت ذخیره میکند.
+سپس گیت یک کامیت آبجکت که متادیتا و نشانگری که به روت درخت پروژه دارد میسازد تا بتواند اسنپشات پروژه را هنگامی که نیاز بود بازسازی کند.
+
+
مخزن گیت شما حالا پنج آبجکت دارد: سه بلاب (هر کدام نماینده محتوای یکی از سه فایل هستند)، یک درخت که محتویات پوشه را لیست میکند و
+تعیین میکند که چه فایل نامهایی در چه بلابهایی ذخیره شدهاند و یک کامیت با نشانگری به روت آن درخت و تمام متادیتای خود کامیت.
+
+
+
}}" alt="A commit and its tree.">
+
+
نمودار 9. یک کامیت و درختش
+
+
اگر تغییری ایجاد کنید و دوباره کامیت بگیرید، کامیت بعدی نشانگری را به کامیتی که دقیقاً قبل از آن آمده در خود ذخیره میکند.
+
+
+
}}" alt="Commits and their parents.">
+
+
نمودار 10. کامیتها و والدینشان
+
+
یک برنچ گیت یک نشانگر سبکوزن قابل انتقال به یکی از این کامیتهاست.
+نام پیشفرض برنچ در گیت master است.
+همچنان که کامیت میسازید، یک برنچ master برایتان ساخته میشود که به آخرین کامیتی که ساختهاید اشاره میکند.
+هر بار که کامیت میکنید نشانگر برنچ master به طور خودکار به جلو حرکت میکند.
+
+
+
+|
+ یادداشت
+ |
+
+
+ برنچ «master» در گیت برنچ خاصی نیست.
+این برنچ دقیقاً مشابه هر برنچ دیگری است.
+تنها دلیلی که تقریباً همهٔ مخزنها یک برنچ با این نام دارند این است که دستور git init به طور پیشفرض آنرا میسازد و بیشتر مردم هم زحمت تغییر این نام را به خود نمیدهند.
+ |
+
+
+
+
+
}}" alt="A branch and its commit history.">
+
+
نمودار 11. یک برنچ و تاریخچهٔ کامیتهای آن
+
+
ساختن یک شاخه جدید
+
+
+وقتی یک برنچ جدید میسازید چه اتفاقی میافتد؟
+انجام این کار یک نشانگر جدید برای شما میسازد تا آنرا به این سو و آن سو انتقال دهید.
+فرض بر این بگذاریم که میخواهید برنچ جدیدی با نام testing بسازید.
+شما این کار را با دستور git branch انجام میدهید:
+
+
+
+
این کار یک نشانگر جدید به کامیتی که روی آن هستید میسازد.
+
+
+
+
}}" alt="Two branches pointing into the same series of commits.">
+
+
نمودار 12. دو برنچ که به یک دسته از کامیتها اشاره میکنند
+
+
+
چگونه گیت میداند که روی چه برنچی کار میکنید؟
+گیت نشانگر خاصی به نام HEAD (هد) را در خود دارد.
+به خاطر داشته باشید این مفهوم تفاوت زیادی با مفهوم HEAD در دیگر VCSها، مانند سابورژن یا CVS، دارد که ممکن است از پیشتر به یاد داشته باشید.
+در گیت، هد نشانگری است که به برنچ محلی که روی آن هستید اشاره میکند.
+در مثالی که روی آن کار میکنیم شما هنوز روی master هستید.
+دستور git branch فقط یک برنچ جدید ساخت — به برنچ جدید نقل مکان نکرد.
+
+
+
+
}}" alt="HEAD pointing to a branch.">
+
+
نمودار 13. هد که به یک برنچ اشاره میکند
+
+
+
به سادگی هر چه تمام شما میتوانید با اجرای دستور git log، که به شما نشان میدهد چه برنچی به کجا اشاره دارد، این موضوع را بررسی کنید.
+این آپشن --decorate خوانده میشود.
+
+
+
+
$ git log --oneline --decorate
+f30ab (HEAD -> master, testing) Add feature #32 - ability to add new formats to the central interface
+34ac2 Fix bug #1328 - stack overflow under certain conditions
+98ca9 Initial commit
+
+
+
+
شما میتوانید برنچهای master و testing را که دقیقاً کنار کامیت f30ab هستند ببینید.
+
+
+
تعویض شاخهها
+
+
+برای تعویض یا جابهجایی به یک برنچ از پیش ساخته شده دستور git checkout را اجرا میکنید.
+حال بیایید به برنچ جدید testing برویم:
+
+
+
+
$ git checkout testing
+
+
+
+
این کار HEAD را جابهجا میکند تا به برنچ testing اشاره کند.
+
+
+
+
}}" alt="HEAD points to the current branch.">
+
+
نمودار 14. هد به برنچ فعلی اشاره میکند
+
+
+
تأثیر این کار در چه بود؟
+خب، بیایید یک کامیت دیگر انجام دهیم:
+
+
+
+
$ vim test.rb
+$ git commit -a -m 'made a change'
+
+
+
+
+
}}" alt="The HEAD branch moves forward when a commit is made.">
+
+
نمودار 15. هنگامی که کامیتی ساخته میشود برنچ هد به جلو میرود
+
+
+
این جالب است چرا که الآن برنچ testing به جلو رفت در حالی که برنچ master هنوز به کامیتی، که سابقاً روی آن git checkout که برای تعویض برنچها استفاده شد، اشاره میکند.
+بیایید دوباره به برنچ master بازگردیم:
+
+
+
+
+
+|
+ یادداشت
+ |
+
+
+git log همیشه، همهٔ برنچها را نمایش نمیدهد.
+
+ اگر الآن git log را اجرا میکردید ممکن بود از اینکه برنچ «testing»ـی که همین الآن ساختید کجا رفت متعجب شوید، چرا که قاعدتاً نباید در خروجی نمایش داده شود.
+
+ برنچ مذکور غیب نشده است؛ صرفاً گیت گمان نمیکند که شما علاقهای به دانستن اطلاعات آن برنچ دارید و سعی میکند مطالبی که به نظرش برای شما مفید است را به شما نشان دهد.
+به بیان دیگر، در حالت پیشفرض، git log فقط تاریخچهٔ کامیتهای زیر برنچی که شما چکاوت کردهاید را نمایش میدهد.
+
+ برای نمایش تاریخچهٔ کامیتهای برنچ مورد نظر باید به صراحت آن را نام ببرید: git log testing.
+برای نمایش تمام برنچها --all را به دستور git log خود بیافزایید.
+ |
+
+
+
+
+
+
}}" alt="HEAD moves when you checkout.">
+
+
نمودار 16. وقتی چکاوت میکنید هد جابهجا میشود
+
+
+
آن دستور دو کار انجام داد.
+نشانگر هد را بازگرداند تا به برنچ master اشاره کند و فایلهایی که در پوشه کاری شما بودند را به اسنپشاتی که master به آن اشاره میکرد بازگردانی کرد.
+این همچنین به این معنا است که تغییراتی که از این نقطه به بعد اعمال کنید از نسخههای قدیمیتر پروژه جدا خواهد ماند.
+در سادهترین تعریف، کاری که در برنچ testing کردید را خنثی میکند تا بتوانید راه دیگری را در پیش بگیرید.
+
+
+
+
+|
+ یادداشت
+ |
+
+ تعویض برنچ فایلهای درون پوشه کاری را تغییر میدهد
+
+ بسیار مهم است که به خاطر داشته باشید که تعویض برنچ در گیت فایلهایی که در پوشه کاری دارید را تغییر میدهد.
+اگر به برنچ قدیمیتری انتقال پیدا کنید، پوشه کاری شما به آن صورتی بازگردانی خواهد شد که آخرین بار هنگام ایجاد کامیت روی آن برنچ بوده است.
+اگر گیت نتواند این بازگردانی را به صورت بینقص انجام دهد، نمیگذارد تعویض برنچ انجام شود.
+ |
+
+
+
+
+
بیایید چند تغییر اعمال کنیم و دوباره کامیت بگیریم:
+
+
+
+
$ vim test.rb
+$ git commit -a -m 'made other changes'
+
+
+
+
اکنون تاریخچه پروژه شما دوشاخه شده است (به تاریخچه دوشاخه شده مراجعه کنید).
+شما یک برنچ ساختید و به آن انتقال پیدا کردید، کمی روی آن کار کردید و سپس به برنچ اصلی خود بازگشتید و آنجا کمی کار متفاوت انجام دادید.
+هر دوی آن تغییرات به صورت ایزوله در برنچهای خودشان موجوداند: شما میتوانید بین برنچها جابهجا شوید و هرگاه آماده بودید آنها را با هم مرج کنید.
+و جالبتر اینکه همهٔ این کارها را صرفاً با دستورهای branch، checkout و commit انجام دادید.
+
+
+
+
}}" alt="Divergent history.">
+
+
نمودار 17. تاریخچه دوشاخه شده
+
+
+
علاوه بر آن، با دستور git log میتوانید این اطلاعات را ببینید.
+اگر git log --oneline --decorate --graph --all را اجرا کنید، برنامه تاریخچهٔ کامیتهای شما را نمایش میدهد، نشان میدهد که نشانگرهای برنچهایتان کجاست و چگونه تاریخچهٔ شما دو شاخه شده است.
+
+
+
+
$ git log --oneline --decorate --graph --all
+* c2b9e (HEAD, master) Made other changes
+| * 87ab2 (testing) Made a change
+|/
+* f30ab Add feature #32 - ability to add new formats to the central interface
+* 34ac2 Fix bug #1328 - stack overflow under certain conditions
+* 98ca9 initial commit of my project
+
+
+
+
از این جهت که برنچ در گیت صرفاً یک فایل سادهٔ محتوی یک چکسام SHA-1 چهل حرفی کامیتی است که به آن اشاره میکند، ساختن و از بین بردن برنچها کم هزینه است.
+ساختن یک برنچ جدید به سادگی و سرعت نوشتن ۴۱ بایت اطلاعات درون یک فایل است (۴۰ حرف و یک خط جدید).
+
+
+
این قضیه بسیار متفاوت با نحوهٔ برنچسازی بیشتر ابزارهای VCS قدیمی است که شامل کپی کردن تمام فایلهای پروژه به یک پوشه ثانوی میباشد.
+این میتواند چندین ثانیه یا حتی دقیقه، بسته به سایز پروژه، طول بکشد؛ درحالی که در گیت این فرآیند همیشه آنی است.
+همچنین به علت اینکه هنگامی که کامیت میکنیم والد را هم در کامیت ثبت میکنیم، پیدا کردن یک پایهٔ ادغام برای مرج کردن به صورت خودکار برای ما انجام میشود و به طور کل انجام آن بسیار آسان است.
+این مزایا توسعهدهندگان را به ساختن و استفاده بیشتر از برنچها مشتاق میکند.
+
+
+
بیایید به اینکه چرا شما نیز باید این کار را کنید نگاهی بیاندازیم.
+
+
+
+
+|
+ یادداشت
+ |
+
+ ساختن یک برنچ جدید و انتقال به آن در آن واحد
+
+ خیلی اوقات پیش میآید که یک برنچ جدید بسازید و بخواهید در آن واحد به آن انتقال یابید — این کار در یک عملیات با git checkout -b <newbranchname> قابل انجام است.
+ |
+
+
+
+
شاخههای ریموت
+
+
+مراجع یا رفرنسهای ریموت، مراجع (نشانگرهایی) در مخزن ریموت شما هستند که شامل برنچها، تگها و غیره میشود.
+شما میتوانید لیست کاملی از مراجع ریموت را با git ls-remote <remote>، یا git remote show <remote> هم برای برنچهای ریموت و اطلاعات بیشتر، مشاهده کنید.
+اگرچه روش رایجتر استفاده از برنچهای رهگیر ریموت یا درپی-ریموت (Remote-tracking) است.
+
+
برنچهای درپی-ریموت، رفرنسهایی به وضعیت برنچهای ریموت هستند.
+آنها رفرنسهای محلی هستند که نمیتوانید جابهجا کنید؛ هر گاه که هر ارتباط شبکهای برقرار کنید، گیت آنها را برای شما جابهجا میکند تا از اینکه آنها به دقت وضعیت مخزن
+ریموت را بازنمایی میکنند، اطمینان حاصل کند.
+میتوانید به آنها مثل بوکمارک بنگرید که به شما یادآوری میکنند که آخرین بار که به مخزنهای ریموت وصل شدید، برنچها کجا قرار داشتهاند.
+
+
نام برنچهای در پی ریموت به این صورت شکل میگیرد: <remote>/<branch>.
+به طور مثال اگر میخواهید ببینید آخرین بار که با ریموت origin ارتباطی داشتهاید برنچ master کجا قرار داشته، باید به بررسی برنچ origin/master بپردازید.
+اگر با همکاری روی یک ایشو کار میکردهاید و آنها روی برنچ iss53 پوش کردهاند، ممکن است که شما هم برنچ iss53 محلی خودتان را داشته باشید،
+لکن برنچ روی سرور با برنچ درپی-ریموت origin/iss53 به نمایش در میآید.
+
+
شاید این کمی گیجکننده باشد، پس بیایید به یک مثال نگاهی بیاندازیم.
+فرض کنیم که یک سرور گیت به آدرس git.ourcompany.com روی شبکهٔ خود دارید.
+اگر از این آدرس کلون کنید، دستور clone گیت به طور خودکار آنرا origin برای شما نامگذاری میکند، تمام اطلاعاتش را پول میکند، نشانگری به جایی که برنچ master است میسازد و
+نام آنرا به طور محلی origin/master میگذارد.
+علاوه بر این گیت به شما برنچ محلی master خودتان را میدهد که از همانجایی که برنچ master در origin قرار دارد شروع میشود، تا بتوانید روی آن کار کنید.
+
+
+
+|
+ یادداشت
+ |
+
+ «origin» خاص نیست
+
+ دقیقاً همانگونه که نام برنچ «master» هیچ معنی خاصی در گیت ندارد، «origin» هم بیمعناست.
+مادامی که «master» نام پیشفرض یک برنچ آغازین به هنگام اجرای git init است و تنها به همین دلیل بسیار مورد استفاده قرار میگیرد، «origin» نام پیشفرض یک ریموت به هنگام اجرای git clone است.
+اگر git clone -o booyah را وارد کنید، آنگاه booyah/master را به عنوان برنچ پیشفرض ریموت خود خواهید دید.
+ |
+
+
+
+
+
}}" alt="Server and local repositories after cloning.">
+
+
نمودار 30. مخازن سرور و محلی بعد از کلون کردن
+
+
اگر روی برنچ master محلی خود کار کنید و در همین حین شخص دیگری به git.ourcompany.com پوش کند و برنچ master مخزن را بروزرسانی کند، آنگاه تاریخچههای شما به طور متفاوتی به جلو حرکت میکند.
+علاوه بر آن تا زمانی که بیارتباط با سرور origin باقی بمانید، نشانگر origin/master تکان نمیخورد.
+
+
+
}}" alt="Local and remote work can diverge.">
+
+
نمودار 31. کارهای روی مخزن محلی و ریموت میتواند دوشاخه شود
+
+
برا همگامسازی کارتان با هر ریموتی، باید دستور git fetch <remote> اجرا کنید (در این مورد git fetch origin).
+این دستور سروری که با نام «origin» است را بررسی میکند (در این مثال آدرس git.ourcompany.com)، اطلاعات جدید را فچ میکند و پایگاهداده محلی را بروز میکند که باعث
+جابهجایی نشانگر origin/master به مکان بروزتر میشود.
+
+
+
}}" alt="`git fetch` updates your remote references.">
+
+
نمودار 32. دستور git fetch برنچهای درپی-ریموتتان را به روز میکند
+
+
برای نمایش داشتن چند سرور ریموت و اینکه چه برنچ ریموتی در آن پروژههای ریموت در کجا قرار دارد، بیاید فرض کنیم که
+شما یک سرور گیت داخلی دیگر دارید که فقط برای توسعه با یکی از اعضای تیم «دور» (Sprint) فعلی شما پاسخگو است.
+این سرور در git.team1.ourcompany.com قرار دارد.
+همانگونه که در مقدمات گیت بررسی شد، میتوانید با git remote add آنرا به عنوان یک مرجع ریموت جدید به پروژهای که در حال حاضر روی آن کار میکنید اضافه کنید.
+این ریموت را teamone بنامید که نام کوتاهی برای URL کامل ریموت است.
+
+
+
}}" alt="Adding another server as a remote.">
+
+
نمودار 33. اضافه کردن سروری جدید به عنوان ریموت
+
+
اکنون میتوانید git fetch teamone را اجرا کنید تا هرچیزی را که هنوز ندارید از سرور ریموت teamone واکشی کند.
+از آنجایی که اکنون سرور زیرمجموعهای از اطلاعات سرور origin را دارد، گیت دادهای را واکشی نمیکند بلکه یک برنچ درپی-ریموت با نام teamone/master میسازد که به کامیتی که
+teamone در master خود دارد اشاره میکند.
+
+
+
}}" alt="Remote tracking branch for `teamone/master`.">
+
+
نمودار 34. برنچ درپی-ریموت teamone/master
+
+
+
پوشکردن
+
+
+هنگامی که میخواهید برنچی را با دنیا به اشتراک بگذارید، نیاز دارید که آنرا به برنچی در ریموتی که در آن اجازهٔ نوشتن دارید پوش کنید.
+برنچهای محلی شما به طور خودکار با ریموتی که به آنها بگویید همگام نمیشوند — باید به صراحت، برنچهایی را که میخواهید به اشتراک بگذارید، به سرور پوش کنید.
+از این طریق میتوانید از برنچهای شخصی که برای کار دارید و نمیخواهید آنها را به اشتراک بگذارید استفاده کنید و فقط برنچهای موضوعی که میخواهید روی آنها مشارکت صورت گیرد را پوش کنید.
+
+
+
اگر برنچی با نام serverfix داشته باشید که بخواهید با دیگران کار کنید، میتوانید آنرا به همان طریقی که برنچ اول خود را پوش کردید، پوش کنید.
+git push <remote> <branch> را اجرا کنید:
+
+
+
+
$ git push origin serverfix
+Counting objects: 24, done.
+Delta compression using up to 8 threads.
+Compressing objects: 100% (15/15), done.
+Writing objects: 100% (24/24), 1.91 KiB | 0 bytes/s, done.
+Total 24 (delta 2), reused 0 (delta 0)
+To https://github.com/schacon/simplegit
+ * [new branch] serverfix -> serverfix
+
+
+
+
این به نوعی یک میانبر است.
+گیت به طور خودکار نام برنچ serverfix را به refs/heads/serverfix:refs/heads/serverfix گسترش میدهد که به معنی عبارت روبرو است: «برنچ محلی serverfix من را بگیر و برای بروزرسانی
+برنچ serverfix ریموت آنرا پوش کن.»
+در Git Internals با جزئیات به بخش refs/heads/ میپردازیم، اما به طور کل میتوانید فعلاً آن را اینگونه رها کنید.
+همچنین میتوانید git push origin serverfix:serverfix کنید که همان کار را میکند — میگوید: «serverfix مرا بگیر و آنرا serverfix ریموت کن.»
+اگر نمیخواهید روی ریموت serverfix نامیده شود میتوانید به جای آن، git push origin serverfix:awesomebranch را برای پوش کردن برنچ serverfix محلیتان به aweseomebranch روی پروژه ریموت اجرا کنید.
+
+
+
+
+|
+ یادداشت
+ |
+
+ هر بار رمز خود را تایپ نکنید
+
+ اگر از یک HTTPS URL برای پوش کردن استفاده میکنید، سرور گیت از شما رمز و نام کاربریتان را برای احراز هویت میخواهد.
+به طور پیشفرض در ترمینال به شما آگهی میدهد تا این اطلاعات را بخواند تا سرور بتواند تشخیص دهد که شما اجازه دارید پوش کنید یا خیر.
+
+ اگر نمیخواهید هر بار که پوش میکنید آنها را تایپ کنید میتوانید یک «کش گواهی» انجام دهید.
+سادهترین راه ذخیرهٔ گواهی در حافظه به مدت چند دقیقه است، که میتوانید به سادگی با اجرای git config --global credential.helper cache آنرا راهاندازی کنید.
+
+ برای اطلاعات بیشتر درباره تنظیمات کش کردن گواهیهای مختلف موجود به Credential Storage مراجعه کنید.
+ |
+
+
+
+
+
دفعهٔ بعد که یکی از همکاران شما از سرور فچ میکند، یک رفرنس با نام origin/serverfix به مکان نسخهٔ serverfix سرور دریافت میکند:
+
+
+
+
$ git fetch origin
+remote: Counting objects: 7, done.
+remote: Compressing objects: 100% (2/2), done.
+remote: Total 3 (delta 0), reused 3 (delta 0)
+Unpacking objects: 100% (3/3), done.
+From https://github.com/schacon/simplegit
+ * [new branch] serverfix -> origin/serverfix
+
+
+
+
مهم است که به خاطر داشته باشید که هنگامی که فچی میکنید که برنچهای درپی-ریموت جدیدی را واکشی میکند، به طور خودکار یک نسخه قابل ویرایش محلی از آنها نخواهید داشت.
+به بیان دیگر، در این مثال، شما یک برنچ serverfix جدید ندارید — شما فقط یک نشانگر origin/serverfix خواهید داشت که قابل ویرایش نیست.
+
+
+
برای ادغام این کار با برنچ فعال حاضر میتوانید git merge origin/serverfix را اجرا کنید.
+اگر میخواهید که برنچ serverfix خود را داشته باشید تا روی آن کار کنید، میتوانید آنرا از جایی که برنچ درپی-ریموت فعلی هست شروع کنید:
+
+
+
+
$ git checkout -b serverfix origin/serverfix
+Branch serverfix set up to track remote branch serverfix from origin.
+Switched to a new branch 'serverfix'
+
+
+
+
این کار به شما یک برنچ محلی در جایی که origin/serverfix است، میدهد که میتوانید روی آن کار کنید.
+
+
+
پیگیری شاخهها
+
+
+چکاوت کردن یک برنچ محلی از یک برنچ درپی-ریموت به طور خودکار ماهیتی به نام «برنچ پیگیر» (Tracking) میسازد (و برنچی که این برنچ در حال پیگیری آن است «برنچ بالادست» (Upstream) نامیده میشود).
+برنچهای پیگیر برنچهای محلی هستند که رابطهٔ مستقیمی با یک برنچ ریموت دارند.
+اگر روی یک برنچ پیگیر باشید و git pull را تایپ کنید، گیت به طور خود به خودی میداند که از چه سروری فچ کند و با چه برنچی آنرا ادغام کند.
+
+
+
وقتی یک مخزن را کلون میکنید، عموماً به طور خودکار برنچ master ساخته میشود که پیگیر origin/master است.
+هرچند شما میتوانید در صورت تمایل برنچهای پیگیر دیگری را نیز راهاندازی کنید — آنهایی که درپی برنچهای ریموتهای دیگر هستند یا آنهایی که برنچ master را پیگیری نمیکنند.
+نمونهٔ سادهٔ آن مثالی است که همین الآن ملاحظه کردید: git checkout -b <branch> <remote>/branch>
+این عملیات آنقدر رایج است که گیت اختصار --track را هم ارائه میکند:
+
+
+
+
$ git checkout --track origin/serverfix
+Branch serverfix set up to track remote branch serverfix from origin.
+Switched to a new branch 'serverfix'
+
+
+
+
در حقیقت این کار به حدی رایج است که حتی اختصاری هم برای آن اختصار وجود دارد.
+اگر نام برنچی که سعی در چکاوت کردن آن دارید (a) وجود ندارد و (b) دقیقاً با نام یک برنچ فقط در یک ریموت تطابق دارد، گیت برنچ پیگیر آنرا برای شما میسازد:
+
+
+
+
$ git checkout serverfix
+Branch serverfix set up to track remote branch serverfix from origin.
+Switched to a new branch 'serverfix'
+
+
+
+
برای راهاندازی یک برنچ محلی با نامی متفاوت از برنچ ریموت، میتوانید به آسانی از نسخه اول دستور با یک نام برنچ محلی متفاوت استفاده کنید:
+
+
+
+
$ git checkout -b sf origin/serverfix
+Branch sf set up to track remote branch serverfix from origin.
+Switched to a new branch 'sf'
+
+
+
+
حال برنچ محلی sf شما به طور خودکار از origin/serverfix پول میکند.
+
+
+
اگر از قبل یک برنچ محلی دارید و میخواهید که آنرا به یک برنچ ریموت که تازه پول کردید نسبت دهید یا هر گاه که خواستید صراحتاً برنچ بالادست برنچ پیگیر
+فعلی را تغییر دهید، میتوانید از آپشن -u یا --set-upstream-to برای git branch استفاده کنید.
+
+
+
+
$ git branch -u origin/serverfix
+Branch serverfix set up to track remote branch serverfix from origin.
+
+
+
+
+
+|
+ یادداشت
+ |
+
+ اختصار بالادست
+
+ هنگامی که یک برنچ پیگیر تنظیم شده دارید میتوانید با اختصار @{upstream} یا @{u} به آن مراجعه کنید.
+بنابراین اگر در برنچ master هستید و در پی برنچ origin/master هستید،
+در صورت تمایل میتوانید دستوری مثل git merge @{u} را به جای git merge origin/master اجرا کنید.
+ |
+
+
+
+
+
اگر میخواهید بدانید که چه برنچهای پیگیری راهاندازی کردهاید میتوانید از آپشن -vv برای git branch استفاده کنید.
+این کار تمام برنچهای محلی را با اطلاعات بیشتری، از قبیل اینکه هر برنچ پیگیر چه برنچی است و آیا برنچ محلی عقبتر، جلوتر یا عقب-جلوی برنچ ریموت است، لیست میکند.
+
+
+
+
$ git branch -vv
+ iss53 7e424c3 [origin/iss53: ahead 2] Add forgotten brackets
+ master 1ae2a45 [origin/master] Deploy index fix
+* serverfix f8674d9 [teamone/server-fix-good: ahead 3, behind 1] This should do it
+ testing 5ea463a Try something new
+
+
+
+
در اینجا میتوان دید که برنچ iss53 ما پیگیر origin/iss53 است و دو تا «جلوتر» از آن است، به این معنی که ما دو کامیت محلی داریم که هنوز به سرور پوش نکردهایم.
+همچنین میتوان دید که برنچ master ما پیگیر origin/master است و بروز میباشد.
+سپس میتوان دید که برنچ serverfix ما پیگیر برنچ server-fix-good روی سرور teamone ماست و سه کامیت و جلوتر و یکی عقبتر است، به این معنا که یک کامیت روی سرور هست که
+ما هنوز آنرا مرج نکردهایم و سه کامیت محلی داریم که آنرا را پوش نکردهایم.
+در آخر میتوان دید که برنچ testing ما پیگیر هیچ برنچ ریموتی نیست.
+
+
+
البته بسیار مهم است به خاطر داشته باشید که این ارقام صرفاً از آخرین باری که هر سرور را فچ کردهاید ماندهاند.
+همچنین این دستور به سرورها نمیرود، فقط به شما چیزی را میگوید که از این سرورها به طور محلی کش کرده است.
+اگر میخواهید تمام اطلاعات بروز باشند باید پیش از اجرای این دستور همهٔ ریموتها را فچ کنید.
+بدین شکل میتوانید این کار را انجام دهید:
+
+
+
+
$ git fetch --all; git branch -vv
+
+
+
+
پول کردن
+
+
+مادامی که دستور git fetch تمام تغییرات سرور را که شما ندارید واکشی میکند، پوشهٔ کاری شما را به هیچ عنوان ویرایش نمیکند.
+به بیان سادهتر اطلاعات را برای شما میآورد و به شما اجازه میدهد خودتان مرج را انجام دهید.
+هرچند دستوری به نام git pull وجود دارد که خیلی ساده git fetch است که در اکثر مواقع مستقیماً پس از آن git merge اجرا میشود.
+اگر آنطور که در بخش قبل اشاره شد، برنچ پیگیری را راهاندازی کردهاید یا به طور صریح آنرا معرفی کردهاید یا گیت آنرا با دستورات clone یا checkout برای شما ساخته است،
+git pull به دنبال اینکه چه سرور و برنچی را پیگیری میکنید میگردد، آن سرور را برای شما فچ میکند و سپس سعی در مرج کردن آن برنچ ریموت میکند.
+
+
+
عموماً بهتر است که به طور صریح از دو دستور fetch و merge استفاده کنید چرا که git pull غالباً میتواند گیجکننده واقع شود.
+
+
+
پاک کردن شاخههای ریموت
+
+
+فرض کنید که کارتان با یک برنچ ریموت تمام شده است — فرض کنیم که شما و همکاران شما کارتان روی یک ویژگی تمام شده و آنرا به برنچ master ریموت مرج کردهاید (یا هر برنچی که کد باثباتتان در آن است).
+میتوانید برنچ ریموت را با آپشن --delete دستور git push پاک کنید.
+اگر میخواهید برنچ serverfix خود را از سرور پاک کنید، باید دستور زیر را اجرا کنید:
+
+
+
+
$ git push origin --delete serverfix
+To https://github.com/schacon/simplegit
+ - [deleted] serverfix
+
+
+
+
تمام کاری که این دستور میکند این است که نشانگر برنچ را از سرور پاک کند.
+عموماً سرور گیت تمام دادهها را تا زمانی که Grabage Collector اجرا شود نگهداری میکند، تا اگر اشتباهی این پاکسازی رخ داده بود بازیابی آن آسان باشد.
+
+
مدیریت شاخه
+
+
+حال که چند برنچ ساختهاید، مرج و پاک کردهاید، بیاید نگاهی به چند ابزار مدیریت برنچ بیندازیم که وقتی شروع به استفادهٔ مادام از برنچها کردید به کارتان میآید.
+
+
دستور git branch بیشتر از ساختن و نابود کردن برنچها به کار میآید.
+اگر بدون هیچ آرگومانی آنرا اجرا کنید، یک لیست ساده از برنچهای حاضر پروژه را به شما نمایش میدهد:
+
+
+
$ git branch
+ iss53
+* master
+ testing
+
+
+
به علامت * که پیش از برنچ master میآید توجه کنید: این علامت نشاندهندهٔ برنچی است که چکاوت کردهاید (به بیان دیگر برنچی که HEAD به آن اشاره دارد).
+این بدان معناست که اگر الآن کامیتی بگیرید، برنچ master با کار جدید شما به جلو خواهد رفت.
+برای دیدن آخرین کامیت هر برنچ میتوانید git branch -v را اجرا کنید:
+
+
+
$ git branch -v
+ iss53 93b412c Fix javascript issue
+* master 7a98805 Merge branch 'iss53'
+ testing 782fd34 Add scott to the author list in the readme
+
+
+
آپشنهای پرکاربرد --merged و --no-merged میتوانند این لیست را به برنچهایی که هنوز به برنچ حاضر مرجکرده یا نکردهاید محدود کند.
+برای اطلاع از اینکه چه برنچی با برنچ حاضر مرجشده است میتوانید دستور git branch --merged را اجرا کنید:
+
+
+
$ git branch --merged
+ iss53
+* master
+
+
+
به این دلیل که شما سابقاً با iss53 مرج شدهاید آنرا در این لیست مشاهده میکنید.
+برنچهایی در این لیست که مقابلشان * ندارد، غالباً میتوانند بیمشکل با git branch -d پاک شوند؛ شما قبلتر آنها را درون برنچی دیگر ریختهاید پس با پاک کردنشان چیزی را از دست نخواهید داد.
+
+
برای مشاهده تمام برنچهایی که شامل کارهایی هستند که هنوز مرجشان نکردهاید، میتوانید git branch --no-merged را اجرا کنید:
+
+
+
$ git branch --no-merged
+ testing
+
+
+
این دستور برنچ دیگر شما را نشان میدهد.
+به این دلیل که شامل کاری است که هنوز مرج نکردهاید، تلاش برای پاک کردن آن با git branch -d شکست خواهد خورد:
+
+
+
$ git branch -d testing
+error: The branch 'testing' is not fully merged.
+If you are sure you want to delete it, run 'git branch -D testing'.
+
+
+
اگر واقعاً میخواهیدی که آنرا پاک کنید و کار خود را از دست بدهید میتوانید با -D آنرا به گیت تحمیل کنید، همانطور پیغام مفید بالا به آن اشاره میکند.
+
+
+
+|
+ نکته
+ |
+
+
+ آپشنهایی که بالا توضیح داده شدند، --merged و --no-merged اگر نام برنچ یا کامیتی را به عنوان آرگومان دریافت نکنند، به شما خروجیهایی را نشان میدهند که به نسبت برنچ حاضر، به ترتیب،
+مرجشده یا مرجنشدهاند.
+
+ همیشه میتوانید یک آرگومان اضافه برای درخواست وضعیت مرج به نسبت برنچی خاص را وارد دستور کنید بدون آنکه بخواهید روی آن برنچ چکاوت کنید،
+مثلاً چه برنچی با برنچ master مرج نشده است؟
+
+
+ $ git checkout testing
+$ git branch --no-merged master
+ topicA
+ featureB
+
+ |
+
+
+
اولین راهاندازی گیت
+
+
حالا که گیت را در سیستم خود دارید، وقت آن است که چند شخصیسازی در محیط گیتتان انجام دهید.
+باید این کارها را فقط یک بار به ازای هر کامپیوتری انجام دهید؛ این تنظیمات با بروزرسانیها از بین نمیرود.
+همچنین میتوانید هر زمان که خواستید آنها را با اجرای دوباره دستورات تغییر دهید.
+
+
گیت با ابزاری به نام git config ارائه میشود، که به شما امکان تنظیم و خواندن متغیرهای پیکربندی که تمام جوانب کاری گیت و ظاهر آن را مدیریت میکنند را میدهد.
+این متغیرها را میتوان در سه مکان مختلف ذخیره کرد:
+
+
+-
+
فایل /etc/gitconfig: شامل مقادیری است که برای تمام کاربران سیستم و تمام مخازن آنها اعمال میشود.
+اگر از آپشن --system برای git config استفاده کنید خواندن و نوشتن با فایل مذکور انجام میشود.
+(به دلیل اینکه این یک فایل تنظیم سیستمی است ممکن است شما به دسترسی سطح ادمین یا سوپریوزر احتیاج داشته باشید تا بتوانید آن را ویرایش کنید.)
+
+-
+
فایل ~/.gitconfig یا ~/.config/git/config: مقادیر مختص به شما، کاربر، را نگهداری میکند.
+شما میتوانید با دادن آپشن --global به گیت بگویید تا مخصوصاً با این فایل خواندن و نوشتن را انجام بدهد.
+
+-
+
فایل config درون پوشه گیت (همان .git/config) هر پروژهای که در حال کار روی آن هستید: تنظیمات مختص به آن مخزن واحد را شامل میشود.
+شما میتوانید با آپشن --local گیت را مجبور کنید تا خواندن و نوشتن را روی این فایل انجام دهد. لکن درحقیقت به طور پیشفرض گیت همین کار را میکند.
+(بدیهی است که نیاز دارید درون پوشهٔ آن مخزن گیت باشید تا این دستور به درستی کار کند.)
+
+
+
+
هر کدام از این مرتبهها تنظیمات مرتبه قبل را بازنویسی میکنند. بنابراین مقادیر .git/config نسبت به مقادیر /etc/gitconfig اولویت دارند.
+
+
در سیستمهای ویندوزی گیت به دنبال فایل .gitconfig در پوشه $HOME میگردد (که برای اکثریت C:\Users\$USER است).
+علاوه بر آن همچنان به دنبال /etc/gitconfig میگردد،
+اگرچه به دنبال آن به نسبت روت MSys میگردد که هنگام نصب گیت روی سیستم ویندوزتان آنرا تنظیم میکنید.
+اگر از نسخه 2.x یا بالاتر گیت برای ویندوز استفاده میکنید باید یک فایل پیکربندی مرتبه-سیستمی
+در C:\Documents and Settings\All Users\Application Data\Git\config روی ویندوز XP و
+در C:\ProgramData\Git\config روی ویندوز ویستا و جدیدتر وجود داشته باشد.
+این فایل پیکربندی فقط با git config -f <file> به عنوان ادمین قبل ویرایش است.
+
+
شما میتوانید تمام تنظیمات خود و اینکه از کجا میآیند را با دستور زیر بررسی کنید:
+
+
+
$ git config --list --show-origin
+
+
+
هویت شما
+
+
اولین کاری که باید هنگام نصب گیت انجام دهید تنظیم نام کاربری و آدرس ایمیل خود است.
+این اصل مهمی است چرا که هر گیت کامیت از این اطلاعات استفاده میکند و به صورت غیرقابل تغییر درون کامیتهایی که شما میسازید حک میشود:
+
+
+
+
$ git config --global user.name "John Doe"
+$ git config --global user.email johndoe@example.com
+
+
+
+
مجدداً، فقط لازم است که یکبار این کار را انجام دهید (تنها در حالتی که آپشن --global را به دستور بدهید)، چرا که گیت همیشه از این اطلاعات برای هر کاری در آن سیستم استفاده خواهد کرد.
+اگر میخواهید این را با یک نام یا ایمیل متفاوت برای پروژهای خاص بازنویسی کنید، مادامی که در آن پروژه هستید میتوانید بدون --global آنرا اجرا کنید.
+
+
+
بسیاری از ابزارهای گرافیکی هنگامی که شما برای اولین بار آنها را اجرا میکنید، به شما کمک میکنند این پیکربندیها را انجام دهید.
+
+
+
ویرایشگر شما
+
+
اکنون که هویت شما تنظیم شده است، میتوانید ویرایشگر پیشفرضی که هنگام تایپ پیام، گیت احتیاج دارد را تنظیم کنید.
+در صورتی که تنظیم نشود گیت از ویرایشگر پیشفرض سیستم استفاده میکند.
+
+
+
اگر میخواهید که از ویرایشگر متفاوتی، مانند ایمکس، استفاده کنید میتوانید مانند دستور زیر این کار را انجام دهید:
+
+
+
+
$ git config --global core.editor emacs
+
+
+
+
در یک سیستم ویندوزی اگر میخواهید که از یک ویرایشگر متفاوت استفاده کنید باید مسیر کامل فایل اجرایی آنرا مشخص کنید.
+این مسیر میتواند بسته به نحوه پکیجشدن ویرایشگر شما متفاوت باشد.
+
+
+
نوتپد++ را نظر بگیرید، یک ویرایشگر محبوب برنامهنویسی، که از آنجایی که نسخه ۶۴ بیتی در زمان نوشتن این متن از تمام افزونهها پشتیبانی نمیکند احتمالاً از نسخه ۳۲ بیت آن استفاده میکنید.
+اگر شما از یک سیستم ویندوز ۳۲ بیتی استفاده میکنید یا یک ویرایشگر ۶۴ بیتی روی یک سیستم ۶۴ بیتی دارید، ورودی مسیر کامل چیزی شبیه زیر خواهد بود:
+
+
+
+
$ git config --global core.editor "'C:/Program Files/Notepad++/notepad++.exe' -multiInst -notabbar -nosession -noPlugin"
+
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ ویم، ایمکس و نوتپد++ ویرایشگرهای محبوبی هستند که اکثراً توسط کاربران سیستمهای یونیکس-پایه مانند لینوکس و مک و یا حتی یک سیستم ویندوزی استفاده میشوند.
+اگر شما از ادیتور دیگری یا نسخه ۳۲ بیتی استفاده میکنید، لطفاً دستورات مختص به اینکه چگونه ویرایشگر مورد علاقه خود را در گیت راه بنیدازید را از core.editor پیدا کنید.
+ |
+
+
+
+
+
+
+|
+ هشدار
+ |
+
+
+ اگر اینگونه ویرایشگر خود را معرفی نکنید ممکن است در هنگام اجرای گیت دچار سردرگمی شوید.
+مثلاً حین اجرای مثالها، هنگامی که گیت ویرایشگر را روی یک سیستم ویندوزی فرا میخواند ممکن است پیش از اتمام دستور گیت به مشکل بخورد و متوجه نشوید.
+ |
+
+
+
+
+
بررسی تنظیمات شما
+
+
اگر میخواهید که تنظیمات پیکربندی خود را بررسی کنید، میتوانید از دستور git config --list برای لیست کردن تمام تنظیماتی که گیت در مکان اجرا پیدا میکند استفاده کنید:
+
+
+
+
$ git config --list
+user.name=John Doe
+user.email=johndoe@example.com
+color.status=auto
+color.branch=auto
+color.interactive=auto
+color.diff=auto
+...
+
+
+
+
ممکن است بعضی از کلیدها را بیش از سایر کلیدها ببینید چرا که گیت آن کلیدها را از فایلهای مختلف میخواند (/etc/gitconfig و ~/.gitconfig به طور مثال).
+در این حالت گیت از آخرین مقداری که برای هر کلید یکتا میخواند استفاده میکند.
+
+
+
همچنین میتوانید مقدار مد نظر گیت را برای یک کلید خاص را با git cofnig <key> بررسی کنید:
+
+
+
+
$ git config user.name
+John Doe
+
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ از آنجا که ممکن است گیت مقدار یک متغیر پیکربندی را از بیش از یک فایل بخواند، احتمال دارد که یک مقدار غیرمنتظره برای یکی از این مقادیر پیدا کنید و چرایی این قضیه را ندانید.
+در چنین مواردی میتوانید از گیت origin (مرجع) یک مقدار را پرسوجو کنید و به شما خواهد گفت که کدام فایل پیکربندی آخرین حرف را در تنظیم مقدار مورد نظر زده است:
+
+
+ $ git config --show-origin rerere.autoUpdate
+file:/home/johndoe/.gitconfig false
+
+ |
+
+
+
+
تاریخچهٔ کوتاهی از گیت
+
+
مثل اکثر چیزهای عالی زندگی، گیت نیز با کمی تخریب خلاقانه و جنجالی آتشین شروع شد.
+
+
هسته لینوکس پروژهای متن-باز با حوزهٔ بسیار وسیعی است.
+برای سالها (۱۹۹۱ - ۲۰۰۲ میلادی) جهت نگهداری هسته لینوکس تغییرات به واسطه پچها و فایلهای آرشیو انتقال پیدا میکرد.
+در سال ۲۰۰۲ پروژه هسته لینوکس شروع به استفاده از DVCS اختصاصی با نام BitKeeper کرد.
+
+
در سال ۲۰۰۵ رابطهٔ بین جامعهای که هسته لینوکس را توسعه میداد و شرکت تجاری که BitKeeper را توسعه میداد بهم خورد و رایگان بودن آن برنامه فسخ شد.
+این به جامعهٔ توسعهدهنده لینوکس (و به خصوص لینوس توروالدز، خالق لینوکس) هشداری داد تا ابزار خود را، بر اساس درسهایی که پیشتر با استفاده از BitKeeper گرفته بودند، توسعه دهند.
+چندی از خواستههای سیستم جدید عبارت بودند از:
+
+
از زمان تولد گیت در سال ۲۰۰۵، این نرمافزار برای ساده بودن و سهولت استفاده تکامل پیدا کرده و به بلوغ رسیده و هنوز این استانداردهای اولیه را حفظ میکند.
+این نرمافزار خارقالعاده سریع، در مواجه با پروژههای بزرگ بسیار بهینه و حاوی سیستم انشعابی باورنکردنی برای توسعه غیرخطی است (مراجعه به شاخهسازی در گیت).
+
خط فرمان
+
+
روشهای مختلفی برای استفاده از گیت وجود دارد.
+ابزارهای اصیل خط فرمان و بسیاری از رابطهای کاربری گرافیکی با قابلیتهای مختلف وجود دارد.
+برای این کتاب، ما از گیت در خط فرمان استفاده خواهیم کرد.
+اول آنکه فقط خط فرمان به شما این امکان را میدهد که بتوانید همه دستورات گیت را اجرا کنید — اکثر رابطهای گرافیکی جهت ساده بودن فقط بخش جزئی از کارکرد گیت را پیادهسازی میکنند.
+اگر میدانید که چگونه نسخه خط فرمان را اجرا کنید، احتمالاً میتوانید از نحوه اجرای نسخه رابط گرافیکی نیز سر دربیاورید، اما برعکس آن لزوماً ممکن نیست.
+علاوه بر آن ممکن است که انتخاب کلاینت گرافیکی حاصل سلیقه شخصی شما باشد، اما همه کاربران همیشه رابط واحد خط فرمان را نصب و در دسترس دارند.
+
+
بنابرین انتظار میرود که شما بدانید چگونه ترمینال را در مک و یا Command Prompt یا Powershell را در ویندوز باز کنید.
+اگر شما نمیدانید که در این بخش، موضوع مورد بحث چیست، شاید نیاز باشد که دست نگه دارید و تحقیقی سریع دربارهٔ این مبحث کنید تا بتوانید ادامه مثالها و توضیحات این کتاب را دنبال کنید.
+
خلاصه
+
+
حال باید درک پایهای از اینکه گیت چیست و چه تفاوتی با سایر سیستمهای کنترل نسخه متمرکز قدیمی دارد داشته باشید.
+همچنین حالا باید یک نسخه کاری از گیت که با هویت شخصی شما تنظیم شده را روی سیستم خود داشته باشید.
+اکنون وقت آن رسیده که کمی از مقدمات گیت را فرابگیرید.
+
این فصل راجع به آغاز به کار با گیت خواهد بود. در آغاز پیرامون تاریخچهٔ ابزارهای کنترل نسخه توضیحاتی خواهیم داد،
+سپس به چگونگی راهاندازی گیت بر روی سیستمتان خواهیم پرداخت و در پایان به تنظیم گیت و کار با آن.
+در پایان این فصل خواننده علت وجود و استفاده از گیت را خواهد دانست و خواهد توانست محیط کار با گیت را فراهم کند.
+دربارهٔ کنترل نسخه
+
+
+«کنترل نسخه» چیست و چرا باید بدان پرداخت؟ کنترل نسخه سیستمی است که تغییرات را در فایل یا دستهای از
+فایلها ذخیره میکند و به شما این امکان را میدهد که در آینده به نسخه و نگارش خاصی برگردید.
+برای مثالهای این کتاب، شما از سورس کد نرمافزار به عنوان فایلهایی که نسخه آنها کنترل میشود استفاده میکنید.
+اگرچه در واقع میتوانید تقریباً از هر فایلی استفاده کنید.
+
+
اگر شما یک گرافیست یا طراح وب هستید و میخواهید نسخههای متفاوت از عکسها و قالبهای خود داشته باشید (که احتمالاً میخواهید)، یک سیستم کنترل نسخه (Version Control System (VCS)) انتخاب خردمندانهای است.
+یک VCS به شما این امکان را میدهد که فایلهای انتخابی یا کل پروژه را به یک حالت قبلی خاص برگردانید، روند تغییرات را بررسی کنید، ببینید چه کسی آخرین بار تغییری ایجاد کرده که احتمالاً مشکل آفرین شده،
+چه کسی، چه وقت مشکلی را اعلام کرده و…
+استفاده از یک VCS همچنین به این معناست که اگر شما در حین کار چیزی را خراب کردید و یا فایلهایی از دست رفت، به سادگی میتوانید کارهای انجام شده را بازیابی نمایید.
+همچنین مقداری سربار به فایلهای پروژهتان افزوده میشود.
+
+
سیستمهای کنترل نسخهٔ محلی
+
+
+روش اصلی کنترل نسخهٔ کثیری از افراد کپی کردن فایلها به پوشهای دیگر است (احتمالاً با تاریخگذاری، اگر خیلی باهوش باشند).
+این رویکرد به علت سادگی بسیار رایج است هرچند خطا آفرینی بالایی دارد.
+فراموش کردن اینکه در کدام پوشه بودهاید و نوشتن اشتباهی روی فایل یا فایلهایی که نمیخواستید روی آن بنویسید بسیار آسان است.
+
+
+
برای حل این مشکل، سالها قبل VCSهای محلی را توسعه دادند که پایگاه دادهای ساده داشت که تمام تغییرات فایلهای تحت مراقبتش را نگهداری میکرد.
+
+
+
+
}}" alt="Local version control diagram">
+
+
نمودار 1. کنترل نسخه محلی.
+
+
+
یکی از شناختهشدهترین ابزاریهای کنترل نسخه، سیستمی به نام RCS بود که حتی امروز، با بسیاری از کامپیوترها توزیع میشود.
+RCS با نگه داشتن مجموعههایی از پچها (Patch/وصله) — همان تفاوتهای بین نگارشهای گوناگون فایلها — در قالبی ویژه کار میکند؛
+پس از این، با اعمال پچها میتواند هر نسخهای از فایل که مربوط به هر زمان دلخواه است را بازسازی کند.
+
+
+
سیستمهای کنترل نسخهٔ متمرکز
+
+
+چالش بزرگ دیگری که مردم با آن روبرو میشوند نیاز به همکاری با توسعهدهندگانی است که با سیستمهای دیگر کار میکنند.
+دربرخورد با این چالش سیستمهای کنترل نسخه متمرکز (Centralized Version Control System (CVCS)) ایجاد شدند.
+این قبیل سیستمها (مثل CVS، سابورژن و Preforce) یک سرور دارند که تمام فایلهای نسخهبندی شده را در بر دارد و تعدادی کلاینت (Client/خدمتگیرنده)
+که فایلهایی را از آن سرور چکاوت (Checkout/وارسی) میکنند. سالهای سال این روش استاندارد کنترل نسخه بوده است.
+
+
+
+
}}" alt="Centralized version control diagram">
+
+
نمودار 2. کنترل نسخه متمرکز.
+
+
+
این ساماندهی به ویژه برای VCSهای محلی منافع و مزایای بسیاری دارد. به طور مثال هر کسی به میزان مشخصی از فعالیتهای دیگران روی پروژه آگاهی دارد.
+مدیران دسترسی و کنترل مناسبی بر این دارند که چه کسی چه کاری میتواند انجام دهد؛
+همچنین مدیریت یک CVCS خیلی آسانتر از درگیری با پایگاهدادههای محلی روی تک تک کلاینتهاست.
+
+
+
هرچند که این گونه ساماندهی معایب جدی نیز دارد. واضحترین آن رخدادن خطا در سروری که نسخهها در آن متمرکز شدهاند است.
+اگر که سرور برای یک ساعت غیرفعال باشد، در طول این یک ساعت هیچکس نمیتواند همکاری یا تغییراتی که انجام داده است را ذخیره نماید.
+اگر هارددیسک سرور مرکزی دچار مشکلی شود و پشتیبان مناسبی هم تهیه نشده باشد
+همه چیز (تاریخچه کامل پروژه بجز اسنپشاتهایی که یک کلاینت ممکن است روی کامپیوتر خود ذخیره کرده باشد) از دست خواهد رفت.
+VCSهای محلی نیز همگی این مشکل را دارند — هرگاه کل تاریخچه پروژه را در یک مکان واحد ذخیره کنید، خطر از دست دادن همه چیز را به جان میخرید.
+
+
+
سیستمهای کنترل نسخه توزیعشده
+
+
+اینجا است که سیستمهای کنترل نسخه توزیعشده (Distributed Version Control System (DVCS)) نمود پیدا میکنند.
+در یک DVCS (مانند گیت، Mercurial، Bazaar یا Darcs) کلاینتها صرفاً به چکاوت کردن آخرین اسنپشات فایلها اکتفا نمیکنند؛
+بلکه آنها کل مخزن (Repository) را کپی عینی یا آینه (Mirror) میکنند که شامل تاریخچه کامل آن هم میشود.
+بنابراین اگر هر سروری که سیستمها به واسطه آن در حال تعامل با یکدیگر هستند متوقف شده و از کار بیافتد، با کپی مخرن هر کدام از کاربران بر روی سرور، میتوان آن را بازیابی کرد.
+در واقع هر کلون، پشتیبان کاملی از تمامی دادهها است.
+
+
+
+
}}" alt="Distributed version control diagram">
+
+
نمودار 3. کنترل نسخه توزیعشده.
+
+
+
علاوه بر آن اکثر این سیستمها تعامل کاری خوبی با مخازن متعدد خارجی دارند و از آن استقبال میکنند،
+در نتیجه شما میتوانید با گروههای مختلفی به روشهای مختلفی در قالب پروژهای یکسان بهصورت همزمان همکاری کنید.
+این قابلیت این امکان را به کاربر میدهد که چندین جریان کاری متنوع، مانند مدلهای سلسه مراتبی، را پیادهسازی کند که انجام آن در سیستمهای متمرکز امکانپذیر نیست.
+
+
نصب گیت
+
+
پیش از اینکه بتوانید از گیت استفاده کنید باید آن را نصب کنید.
+حتی اگر هم اکنون گیت را نصب شده دارید بهتر است که آن را به آخرین نسخه بروز کنید.
+شما میتوانید گیت را به عنوان یک بسته یا توسط نصاب دیگری نصب کنید و یا حتی سورس آن را دانلود کرده و خودتان کامپایل نمایید.
+
+
+
+|
+ یادداشت
+ |
+
+
+ این کتاب با نگارش 2.8.0 از گیت نوشته شده است.
+اگرچه بیشتر دستوراتی که ما بکار میبریم باید در نسخههای پیشین نیز جوابگو باشد، شاید برخی از آنها با کمی تغییر همراه باشند یا حتی از کار افتاده باشند.
+از آنجایی که گیت در سازگاری با نسخههای پیشین خود بسیار خوب عمل میکند، نسخههای بعد از 2.8 نیز باید این دستورات را پشتیبانی کنند.
+ |
+
+
+
+
نصب بر روی لینوکس
+
+
+اگر به واسطه یک نصاب اجرایی قصد نصب ابزارهای پایه گیت را روی لینوکس دارید، به طور عمومی باید بتوانید به وسیله پکیجمنیجری که با توزیعتان همراه است این کار را انجام دهید.
+به طور مثال اگر توزیع شما فدورا است (یا هر توریع RPM-پایه دیگری مثل RHEL و یا CentOS)، میتوانید از dnf استفاده کنید:
+
+
+
+
$ sudo dnf install git-all
+
+
+
+
یا اگر در حال استفاده از توزیع دبیان-پایهای مثل اوبونتو هستید میتوانید apt را امتحان کنید:
+
+
+
+
$ sudo apt install git-all
+
+
+
+
+
نصب روی مک
+
+
+راههای زیادی برای نصب گیت روی مک وجود دارد.
+شاید سادهترین راه نصب ابزارهای خط فرمان Xcode باشد.
+در نسخهٔ Mavericks (10.9) و یا نسخههای بالاتر به راحتی با اجرای git از خط فرمان میتوان این کار را کرد.
+
+
+
+
اگر گیت را نصب نداشته باشید، مراحل نصب پیش روی شما آورده میشود.
+
+
+
اگر نسخههای بروزتری را برای نصب نیاز داشته باشید می توان از طریق نصاب اجرایی این کار را انجام دهید.
+یک نصاب گیت برای سیستمعامل مک توسعه پیدا کرده و در وبسایت گیت به آدرس https://git-scm.com/download/mac قرار داده شده است.
+
+
+
+
}}" alt="Git macOS installer.">
+
+
نمودار 7. نصاب گیت مک.
+
+
+
همچنین شما میتوانید گیت را به عنوان بخشی از نرمافزار گیتهاب برای مک نصب کنید.
+ابزار رابط گرافیکی گیت آنها گزینهای دارد که به شما اجازه نصب ابزارهای خط فرمان را نیز میدهد.
+شما میتوانید آن ابزار را از سایت گیتهاب برای مک به آدرس https://desktop.github.com دانلود کنید.
+
+
+
نصب روی ویندوز
+
+
همچنین چند راه برای نصب گیت روی ویندوز وجود دارد.
+رسمیترین نسخه روی وبسایت گیت برای دانلود موجود است.
+کافیست به http://git-scm.com/download/win مراجه کنید و دانلود شما به طور خودکار شروع میشود.
+به خاطر داشته باشید که این یک پروژه به نام گیت برای ویندوز است که از خود گیت جداست؛ برای اطلاعات بیشتر در این باره به https://gitforwindows.org مراجعه کنید.
+
+
+
برای یک نصب تمام خودکار میتوانید از پکیج گیت چوکو استفاده کنید.
+توجه داشته باشید که پکیج چوکو توسط جامعه توسعه پیدا میکند.
+
+
+
روش آسان دیگری که میتوانید گیت را نصب کنید با استفاده گیتهاب دسکتاپ است.
+این نصاب یک نسخه خط فرمانی از گیت را هم در کنار رابط گرافیکی شامل میشود.
+بعلاوه با Powershell به خوبی کار میکند و کش گواهی (Credential) و تنظیمات CRLF را به درستی پیادهسازی میکند.
+درباره این مباحث کمی بعدتر میآموزیم ولی پیش از آن فقط کافیست که بدانید که اینها مواردی هستند که میخواهید داشته باشید.
+شما میتوانید این نصاب را از وبسایت گیتهاب دسکتاپ دانلود کنید.
+
+
+
نصب از سورس
+
+
در عین حال شماری از مردم نصب گیت از سورس کد را مفید میدانند، چراکه ازین طریق جدیدترین نسخه را خواهید گرفت.
+نصابهای اجرایی غالباً کمی عقبتر میماند؛ اگرچه گیت در سالهای اخیر بالغ شده است و این اختلاف نسخه کمتر تفاوت فاحشی ایجاد خواهد کرد.
+
+
+
اگر میخواهید که گیت را از سورس نصب کنید، کتابخانههای روبرو را که گیت به آنها وابستگی (Dependency) دارد را لازم دارید: autotools، curl، zlib، openssl، expat و libiconv.
+برای مثال اگر روی سیستمی کار میکنید که dnf را دارد (مثل فدورا) یا apt-get (مثل یک سیستم دیبان-پایه)، وارد کنید:
+
+
+
+
$ sudo dnf install dh-autoreconf curl-devel expat-devel gettext-devel \
+ openssl-devel perl-devel zlib-devel
+$ sudo apt-get install dh-autoreconf libcurl4-gnutls-dev libexpat1-dev \
+ gettext libz-dev libssl-dev
+
+
+
+
پیش از اینکه قادر باشید که پروندههای با قالبهای مختلف را اضافه کنید (doc، html، info) باید این وابستگیها را هم داشته باشید.
+
+
+
+
$ sudo dnf install asciidoc xmlto docbook2X
+$ sudo apt-get install asciidoc xmlto docbook2x
+
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ کاربران RHEL و مشتقات RHEL مثل CentOS و ساینتیفیک لینوکس برای دانلود بسته docbook2X مستلزم فعال کردن مخزن EPEL هستند.
+ |
+
+
+
+
+
اگر از یک توزیع دبیان-پایه (دبیان/اوبونتو/مشتقات اوبونتو) استفاده میکنید، بسته install-info را نیز احتیاج دارید:
+
+
+
+
$ sudo apt-get install install-info
+
+
+
+
اگر از یک توزیع RPM-پایه (فدورا/RHEL/مشتقات RHEL) استفاده میکنید، بسته getopt را نیز احتیاج دارید (که از قبل روی توزیعهای دبیان-پایه وجود دارد):
+
+
+
+
$ sudo dnf install getopt
+
+
+
+
علاوه بر این، اگر شما از فدورا/RHEL/مشتقات RHEL استفاده میکنید به علت تفاوت نام فایلهای اجرایی باید دستور زیر را نیز وارد کنید.
+
+
+
+
$ sudo ln -s /usr/bin/db2x_docbook2texi /usr/bin/docbook2x-texi
+
+
+
+
هنگامی که تمام وابستگیهای لازم را حل کرده بودید میتوانید ادامه داده و آخرین تاربالی که برچسب release خورده را از جاهای مختلف تهیه کنید.
+شما میتوانید آنرا از سایت kernel.org به آدرس https://www.kernel.org/pub/software/scm/git یا از یکی از آینههای وبسایت گیتهاب در https://github.com/git/git/releases دریافت کنید.
+به طور کل در صفحه گیتهاب مشخصتر است که آخرین نسخه چیست لکن اگر مایلید برای دانلودتان امضاهای نسخههای ارائه شده را بررسی کنید صفحه kernel.org آنرا هم شامل میشود.
+
+
+
پس از این مرحله، کامپایل و نصب کنید:
+
+
+
+
$ tar -zxf git-2.8.0.tar.gz
+$ cd git-2.8.0
+$ make configure
+$ ./configure --prefix=/usr
+$ make all doc info
+$ sudo make install install-doc install-html install-info
+
+
+
+
پس از اینکه تمام شد میتوانید گیت را با خود گیت آپدیت کنید:
+
+
+
+
$ git clone git://git.kernel.org/pub/scm/git/git.git
+
+
+
کمک گرفتن
+
+
در شرایطی که برای کار با گیت به کمک احتیاج داشتید، سه روش معادل برای گرفتن یک راهنمای مشروح (manpage) دربارهٔ هر یک از دستورات گیت وجود دارد:
+
+
+
$ git help <verb>
+$ git <verb> --help
+$ man git-<verb>
+
+
+
به طور مثال میتوانید صفحهٔ راهنمای دستور git config را با اجرای خط زیر ببینید:
+
+
اینها دستورات خوبی هستند چرا که میتوانید در هرکجا، حتی وقتی آفلاین هستید، به آنها دسترسی پیدا کنید.
+اگر صفحات راهنما و این کتاب کافی نیستند و شما به کمک فردی احتیاج دارید، میتوانید به کانال #git یا #github روی سرور IRC فرینود متصل شوید که در https://freenode.net واقع است.
+معمولاً این کانالها با صدها داوطلب پر شده است که همه دربارهٔ گیت بسیار آگاه و مایل به کمک کردن هستند.
+
+
آخر اینکه اگر نیازی به یک صفحه راهنمای کامل و جامع ندارید و فقط به یک یادآوری سریع برای آپشنهای یک دستور احتیاج دارید، میتوانید از خروجی مختصر آپشن «کمک» بوسیلهٔ -h بخواهید که به شما یادآوری کند؛
+همانگونه که در مثال زیر آمده است:
+
+
+
$ git add -h
+usage: git add [<options>] [--] <pathspec>...
+
+ -n, --dry-run dry run
+ -v, --verbose be verbose
+
+ -i, --interactive interactive picking
+ -p, --patch select hunks interactively
+ -e, --edit edit current diff and apply
+ -f, --force allow adding otherwise ignored files
+ -u, --update update tracked files
+ --renormalize renormalize EOL of tracked files (implies -u)
+ -N, --intent-to-add record only the fact that the path will be added later
+ -A, --all add changes from all tracked and untracked files
+ --ignore-removal ignore paths removed in the working tree (same as --no-all)
+ --refresh don't add, only refresh the index
+ --ignore-errors just skip files which cannot be added because of errors
+ --ignore-missing check if - even missing - files are ignored in dry run
+ --chmod (+|-)x override the executable bit of the listed files
+
+
گیت چیست؟
+
+
بنابراین به طور مختصر گیت چیست؟
+این بخش مهمی برای یادگیری است، چراکه اگر بدانید گیت چیست و مقدمات اینکه چطوری کار میکند را درک کنید، کار کردن با گیت برای شما، احتمالاً به طور چشمگیری، آسانتر خواهد بود.
+همانطور که گیت را میآموزید، سعی کنید ذهن خود را از چیزهایی که ممکن است درباره دیگر VCSها مانند CVS، سابورژن یا Perforce میدانید پاک نگهدارید — این کار کمک میکند که از
+پیچیدگیهای حاصل ناخودآگاه به هنگام استفاده از این نرمافزار دوری کنید.
+اگرچه رابط کاربری گیت بسیار مشابه با دیگر VCSها است، اما گیت دربارهٔ اطلاعات و ذخیرهسازی آنها نگرش بسیار متفاوتی دارد و
+درک این تفاوتها به شما کمک میکند تا از گیج شدن حین استفاده اجتناب کنید.
+
+
اسنپشاتها، نه تفاوتها
+
+
تفاوت اصلی بین گیت و هر VCS دیگری (سابورژن و دوستان) در نحوهٔ نگرش گیت به دادههایش است.
+از منظر مفهومی، بیشتر دیگر سیستمها اطلاعات را به عنوان لیستی از تغییرات اعمال شده روی یک فایل پایه ذخیره میکنند.
+این دسته از سیستمها (CVS، سابورژن، Perforce، Bazaar، و غیره) به اطلاعاتی که ذخیره میکنند به عنوان مجموعهای از فایلها و تغییراتی که در طی زمان به آنها اعمال شده مینگرند
+(به طور کل این رفتار کنترل نسخه دلتا-پایه نامیده میشود).
+
+
+
+
}}" alt="Storing data as changes to a base version of each file.">
+
+
نمودار 4. ذخیره دادهها به عنوان تغییرات اعمال شده به روی یک نسخه پایه از هر فایل.
+
+
+
گیت به داده یا ذخیره کردن آن به این نحو نمینگرد.
+در عوض، گیت به دادههایش بیشتر مانند یک سری از اسنپشاتهایی از یک فایلسیستم مینیاتوری مینگرد.
+با گیت، هر بار که کامیت (Commit/واگذاری) — یا وضعیت پروژه را ذخیره — میکنید، گیت یک تصویر از تمام شمایل فایلهای شما در آن لحظه میگیرد و یک رفرنس را به آن اسنپشات در خود ذخیره میکند.
+برای بهینه بودن، اگر فایلها تغییری نکرده بودند، گیت دیگر آن فایل را ذخیره نمیکند و فقط یک لینک به نسخه قبلی عیناً مشابه آن فایل که قبلاً ذخیره کرده بود را ذخیره میکند.
+گیت به دادههایش بیشتر مثل جریانی از اسنپشاتها مینگرد.
+
+
+
+
}}" alt="Git stores data as snapshots of the project over time.">
+
+
نمودار 5. ذخیره دادهها به عنوان اسنپشاتهایی از پروژه در طول زمان.
+
+
+
این نقطه تمایز مهمی بین گیت و تقریباً تمام دیگر VCSهاست؛
+باعث این است که گیت غالب دیدگاههای کنترل نسخه را، که بیشتر سیستمها از نسلهای قبل کپی کرده بودند، بازبینی کند.
+همین اصل گیت را بیشتر یک فایلسیستم کوچک با ابزارهای افزودهٔ خارقالعاده قدرتمند میکند تا یک VCS خشک و خالی.
+در ادامه، هنگامی که برنچسازی در شاخهسازی در گیت توضیح داده شد، مفصلتر مزایای دیدن دادههایتان به روش گیت را بررسی خواهیم کرد.
+
+
+
غالب عملیاتها محلی است
+
+
اکثر عملیاتها در گیت فقط به فایلهای محلی و منابع نیاز دارند تا کار کنند — عموماً اطلاعاتی از کامپیوتر دیگری روی شبکهٔ شما احتیاج نیست.
+اگر به یک CVCS دیگر عادت دارید که بیشتر عملیاتها آن تأخیر مازاد شبکه را دارند، این جنبه از گیت باعث میشود که فکر کنید خدایان سرعت گیت را با قدرتهای ماوراطبیعی تجهیز کردند.
+چراکه شما تمام تاریخچه پروژه را همین جا روی هارددیسک خود دارید، اکثر عملیاتها تقریباً درجا انجام میشوند.
+
+
+
به طور مثال، برای گشتن در تاریخچه پروژه، گیت نیازی ندارد که تا سرور برود تا تاریخچه را برگرداند و به شما نمایش دهد — آنرا به سادگی از پایگاهداده محلی شما میخواند.
+این بدان معناست که شما میتوانید تاریخچه خود را تقریباً بلادرنگ مشاهده کنید.
+اگر میخواهید که تغییرات بین این نسخه یک فایل و نسخه یک ماه پیشش را ببینید، گیت میتواند فایل یک ماه قبل را جستوجو کند و یک محاسبه محلی برای شما انجام دهد تا اینکه بخواهد از یک سرور دوردست بخواهد یا
+اینکه نسخهای قدیمی از فایل را از سرور بخواهد تا این محاسبه را به طور محلی روی آن انجام دهد.
+
+
+
علاوه بر آن به این معناست که تنها تعداد کمی از کارها را هنگام آفلاین بودن یا آف-VPN بودن نمیتوانید انجام دهید.
+اگر سوار هواپیما یا قطار شدهاید و میخواهید کمی کار کنید، میتوانید با سعادت کامیت کنید (البته به کپی محلی خودتان، بهیاد دارید؟) تا به یک شبکه متصل شوید و آپلود لازمه را انجام دهید.
+اگر به خانه رفتهاید و کلاینت VPN شما پاسخگو نیست، همچنان میتوانید کار کنید.
+در بسیاری از دیگر سیستمها، انجام این کارها یا بسیار دردناک است یا غیرممکن.
+در Perforce، به طور مثال، مادامی که به سرور متصل نیستید نمیتوانید کار خاصی بکنید؛ در سابورژن و CVS، شما میتوانید فایلها را ویرایش کنید، اما نمیتوانید تغییرات را به پایگاهدادهتان
+کامیت کنید (چون پایگاهداده شما آفلاین است). شاید این مشکل بزرگی به نظر نرسد، اما در عمل از تفاوت احتمالی عظیمی که ایجاد میکند، متعجب خواهید شد.
+
+
+
گیت یکپارچگی دارد
+
+
هر چیزی در گیت قبل از اینکه ذخیره شود چکسام میشود و سپس متعاقباً با آن چکسام فراخوانی میشود.
+این بدان معناست که غیرممکن است که محتوای فایل یا پوشهای را بدون اینکه گیت متوجه شود ویرایش کنید.
+این کارکرد درون گیت و در پایینترین مرتبهها ساختار یافته و با تاروپود فلسفهاش همراه است.
+ممکن نیست که شما اطلاعات را حین انتقال یا بر اثر خرابی از دست بدهید بدون اینکه گیت آنرا تشخیص دهد.
+
+
+
سازوکاری که گیت برای چکسام کردن استفاده میکند هش یا درهمسازی SHA-1 نام دارد.
+این هش یک رشته ۴۰ حرفی ساخته شده از کاراکترهای هگزادسیمال (0-9 و a-f) است و بر اساس محتوای یک فایل یا ساختار پوشه در گیت محاسبه میشود.
+یک هش SHA-1 چیزی شبیه به این است:
+
+
+
+
24b9da6552252987aa493b52f8696cd6d3b00373
+
+
+
+
شما این مقادیر هش را در همهجا در گیت میبینید چرا که از آنها بسیار استفاده میکند.
+در حقیقت گیت همه چیز را در پایگاهدادهاش، نه براساس نام فایل، بلکه بر اساس مقدار هش محتوایش ذخیره میکند.
+
+
+
به طور کلی گیت فقط داده میافزاید
+
+
وقتی که کاری در گیت میکنید، تقریباً همهٔ آن افزودن به اطلاعات درون پایگاهداده گیت است.
+به بیان دیگر، انجام کاری که سیستم نتواند آنرا بازگردانی کند یا اجبار آن به پاکسازی کامل اطلاعات به هر نحو بسیار دشوار است.
+اما در هر VCS دیگر، شما میتوانید تغییراتی که هنوز کامیت نکردهاید بهم بریزید یا از دست بدهید، اما بعد از اینکه یک اسنپشات به گیت کامیت کردید، از دست دادن آن بسیار مشکل است،
+بخصوص اگر به طور منظم پایگاهدادهتان را به مخزنی دیگر پوش (Push) میکنید.
+
+
+
اینها همه استفاده از گیت را به یکی از لذتهای دنیوی تبدیل میکند چراکه میدانیم که میتوانیم آزمون و خطای بدون خطر خرابکاری کردن داشته باشیم.
+برای نظارهٔ عمیق اینکه چگونه گیت دادههایش را ذخیره میکند و اینکه چگونه میتوانید اطلاعاتی که به نظر از دست رفته میآیند را بازگردانی کنید به بازگردانی کارها مراجعه کنید.
+
+
+
سه حالت ممکنه
+
+
حال توجه کنید — مسئله اصلی که باید درباره گیت بخاطر بسپارید، اگر میخواهید که فرآیند یادگیری شما به سادگی پیش رود، اینجاست.
+گیت سه حالت اصلی دارد که فایلهای شما میتوانند به خود بگیرند: ویرایششده، استیجشده و کامیتشده:
+
+
+
+-
+
ویرایششده (Modified) به این معناست که شما تغییری در فایل ایجاد کردهاید اما هنوز آنرا به پایگاه داده خود کامیت نکردهاید.
+
+-
+
استیجشده به این معناست که شما ویرایشی در فایل را نسخهٔ فعلی آن علامتگذاری کردهاید تا به اسنپشاتِ کامیت بعدی شما اضافه شود.
+
+-
+
کامیتشده به این معناست که اطلاعات با امنیت کامل در پایگاهداده محلی شما ذخیره شدهاند.
+
+
+
+
+
پس از این به سه بخش اصلی یک پروژه گیت میرسیم: درخت کاری (Working Tree)، صحنه (Staging Area) و پوشه گیت.
+
+
+
+
}}" alt="Working tree, staging area, and Git directory.">
+
+
نمودار 6. درخت کاری، صحنه و پوشه گیت.
+
+
+
درخت کاری یا درخت فعال یک چکاوت از یکی از نسخههای پروژه است.
+این فایلها از پایگاهداده فشرده درون پوشه گیت بیرون کشیده شده و روی دیسک برای استفاده یا ویرایش شما گذاشته میشوند.
+
+
+
صحنه یا استیج یک فایل است که عموماً در پوشه گیت شماست، که اطلاعاتی درباره اینکه در کامیت بعدی چه چیزی باشد را شامل میشود.
+نام فنی آن در ادبیات گیتی «ایندکس» است، اما عبارت «صحنه» هم به کار گرفته میشود.
+
+
+
پوشه گیت جایی است که گیت فرادادهها (Metadata) و آبجکتهای پایگاهداده را برای پروژه شما نگهداری میکند.
+این مهمترین جز گیت است و چیزی است که وقتی یک مخزن را از کامپیوتری دیگر کلون میکنید کپی میشود.
+
+
+
روند کاری پایه گیت به این شکل است:
+
+
+
+-
+
شما فایلهایی را در درخت کاری خود ویرایش میکنید.
+
+-
+
به طور انتخابی آنهایی را که میخواهید در کامیت بعدیتان باشند را به صحنه میآورید — استیج میکنید — که باعث میشود فقط آن تغییرات به صحنه اضافه شوند ولاغیر آن چیزی که انتخاب کردید.
+
+-
+
یک کامیت میگیرید که فایلها را آنگونه که در صحنه بودند را به طور دائمی به اسنپشاتی در پوشه گیت شما تبدیل میکند.
+
+
+
+
+
اگر نسخه خاصی از فایلی در پوشه گیت است کامیتشده به حساب میآید.
+اگر ویرایش شده و به صحنه اضافه شده، استیجشده است.
+و اگر از موقعی که چکاوت شده تغییری در آن ایجاد شده ولکن استیج نشده، ویرایششده است.
+در مقدمات گیت، بیشتر درباره این حالات و اینکه چطور میتوان از آنها در استیج استفاده کرد یا به طور کلی آنها را دور زد را میآموزید.
+
+
بازگردانی کارها
+
+
در هر مرحله، شاید بخواهید که چیزی را یا کاری را بازگردانی یا برگشت دهید.
+اینجا برخی ابزار پایهای برای بازگردانی تغییرات و کارهایی که انجام دادهاید را بررسی خواهیم کرد.
+توجه کنید، چرا که همیشه نمیتوانید همهٔ همین بازگردانیها را بازگردانی کنید.
+اینجا یکی از معدود حیطههای گیت است که اگر اشتباه انجامش دهید امکان دارد مقداری از کارتان از دست برود.
+
+
یکی از متداولترین بازگشتها زمانی است که شما خیلی زود کامیت میگیرید و احتمالاً فراموش میکنید چند فایی اضافه کنید یا یا پیام کامیتتان را خراب کردهاید.
+اگر میخواهید دوباره آن کامیت را بگیرید، تغییرات اضافه فراموش شده را اعمال کنید، آنها را استیج کنید و دوباره با استفاده از آپشن --amend کامیت کنید:
+
+
این دستور استیج شما را دریافت میکند و از آن برای کامیت استفاده میکند.
+اگر از آخرین کامیتتان تغییری ایجاد نکرده باشید (برای مثال، دستور را به محض انجام کامیت قبلی اجرا کنید)، اسنپشات شما دقیقاً به همان شکل خواهد بود و تمام چیزی که تغییر میکند فقط پیام کامیت شما است.
+
+
همان ویرایشگر پیام کامیت بالا میآید، اما از پیش حاوی پیام کامیت قبلی شما است.
+مثل همیشه میتوانید پیام را مانند همیشه اصلاح کنید، اما این عمل کامیت قبلی را بازنویسی میشود.
+
+
برای مثال، اگر کامیت کنید و سپس متوجه شوید فراموش کردهاید که تغییراتی در فایل را که میخواستید به این کامیت اضافه کنید استیج کنید، میتوانید چنین کاری کنید:
+
+
+
$ git commit -m 'Initial commit'
+$ git add forgotten_file
+$ git commit --amend
+
+
+
در نهایت کار شما با یک کامیت به پایان میرسد — کامیت دوم جایگزین نتایج کامیت اول میشود.
+
+
+
+|
+ یادداشت
+ |
+
+
+ خیلی مهم است که بدانید که وقتی درحال امند کردن آخرین کامیت خود هستید، درواقع شما آن را آنچنان تعمیر نمیکنید چراکه آنرا با
+یک ورودی کاملاً جدید و بهبودیافته جایگزین میسازید که کامیت قدیمی را کنار میزند و در جای آن مینشیند.
+در نتیجه، انگار کامیت قبلی هرگز بوجود نیامده است و در تاریخچهٔ مخزن شما نمایش داده نمیشود.
+
+ فایده مشخص امند کردن کامیتهااین است که بدون ایجاد درهم ریختگی در تاریخچهٔ مخزن با پیغام کامیتهای مثل
+«اوه، اضافه کردن یک فایل فراموش شده بود» یا «اصلاح یک غلط املایی در کامیت آخر»، یک تغییر خیلی جزئی برای آخرین کامیت میسازید.
+ |
+
+
+
+
آناستیج کردن یک فایل استیجشده
+
+
دو قسمت بعدی نشان میدهند که چگونه با استیج خود و تغییرات پوشه کاری کار کنید.
+قسمت قشنگ آن این است که دستوری که برای تعیین وضعیت آن دو بخش به کار میرود همچنین یادآوری میکند که چگونه تغییرات به عقب برگردانید.
+برای مثال، فرض کنیم شما دو فایل را تغییر دادهاید و میخواهید آنها را جدا از هم کامیت کنید، اما به اتفاقاً دستور git add * را وارد میکنید و هر دوی آنها را استیج میکنید.
+چطور میتوانید یکی از آنها را آناستیج کنید؟
+دستور git status به شما یادآوری میکند:
+
+
+
+
$ git add *
+$ git status
+On branch master
+Changes to be committed:
+ (use "git reset HEAD <file>..." to unstage)
+
+ renamed: README.md -> README
+ modified: CONTRIBUTING.md
+
+
+
+
دقیقاً زیر متن «Changes to be comitted»، به شما میگوید از git reset HEAD <file> ... برای آناستیج استفاده کنید.
+پس بایید به توصیه گیت گوش کنیم و فایل CONTRIBURING.md را آناستیج کنیم:
+
+
+
+
$ git reset HEAD CONTRIBUTING.md
+Unstaged changes after reset:
+M CONTRIBUTING.md
+$ git status
+On branch master
+Changes to be committed:
+ (use "git reset HEAD <file>..." to unstage)
+
+ renamed: README.md -> README
+
+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: CONTRIBUTING.md
+
+
+
+
دستور مقداری عجیب به نظر میرسد، اما کار میکند.
+فایل CONTRIBUTING.md تغییر کرده است اما دوباره به حال آناستیج درآمده است.
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ درست است که دستور git reset میتواند خطرناک باشد، مخصوصاً اگر از فلگ --hard را به آن بدهید.
+با این حال، در این سناریو که بالا توضیح داده شد، فایلی که در پوشه کاری شما قرار دارد تغییر نیافته، پس نسبتاً ایمن است.
+ |
+
+
+
+
+
در حال حاضر این توضیحات جادویی تمام چیزی بود که لازم بود درباره دستور git reset بدانید.
+بعدتر در بخش Reset Demystified با جزئیات بیشتری وارد بحث reset میشویم که چه کاری میکند و چطور میتوان در آن خبره شد تا کارهای جالبتری انجام داد.
+
+
+
بازگردانی تغییرات یک فایل تغییریافته
+
+
اگر ببینید که دیگر نمیخواهید تغییرات فایل COUNTRIBUTING.md را حفظ کنید چطور؟
+چطور میشود تغییرات را به حالت قبل برگرداند — آن را به همان شکل که در آخرین کامیت شما (یا کلون اولیه، یا همانگونه که وارد پوشه کاری شما شده بود) بازگرداند؟
+خوشبختانه، git status این را نیز به شما میگوید که چگونه آن را انجام دهید.
+در خروجی آخرین مثال، بخش آناستیج چیزی شبیه به این بود:
+
+
+
+
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: CONTRIBUTING.md
+
+
+
+
این به صراحت تمام به شما میگوید که تغییرات انجام شده را چگونه از بین ببریم.
+بیایید کاری که میگوید را انجام دهیم:
+
+
+
+
$ git checkout -- CONTRIBUTING.md
+$ git status
+On branch master
+Changes to be committed:
+ (use "git reset HEAD <file>..." to unstage)
+
+ renamed: README.md -> README
+
+
+
+
شما میتوانید ببینید که تغییرات به حالت اول بازگشتند.
+
+
+
+
+|
+ مهم
+ |
+
+
+ مهم است که بدانید دستور git checkout -- <file> دستور خطرناکی است.
+هر تغییر محلی که به آن فایل اعمال شده بود از بین رفته است — گیت تغییرات فایلها را با آخرین نسخه کامیت شده جایگزین میکند.
+هرگز از این دستور استفاده نکنید مگر اینکه کاملاً میدانید که نمیخواهید آن تغییرات ذخیره نشده محلی از بین برود.
+ |
+
+
+
+
+
اگر مایل هستید تا تغییراتی که ایجاد کرده بودید را حفظ کنید اما باز هم لازم است که موقتاً آنها را از سر راهتان بردارید،
+در شاخهسازی در گیت به بررسی استش و شاخهسازی خواهیم پرداخت؛ به طور کل اینها راههای بهتری برای انجام این کار هستند.
+
+
+
یادتان باشد، هرچیزی که در گیت کامیت شده باشد تقریباً همیشه میتواند بازگردانی شود.
+حتی کامیتهایی که بر روی شاخههایی که حذف شدهاند وجود داشتند یا
+کامیتهایی که با فلگ --amend بازنویسی شده بودند میتوانند بازگردانی شوند (بخش Data Recovery را برای بازیابی داده ببینید).
+با این حال، هر چیزی را که از دست میدهید که هرگز کامیت نشده، قریب به یقین دیگر نخواهید دید.
+
+
برچسبگذاری
+
+
+مانند بیشتر VCSها، گیت قابلیت برچسب زدن در نقاطی خاص از تاریخچهٔ پروژه را به عنوان نقاط مهم دارد.
+معمولاً افراد از این قابلیت برای نشانهگذاری نسخههای قابل ارائه یا release استفاده میکنند (v1.0، v2.0 و به همین ترتیب).
+در این بخش میآموزید که چگونه برچسبهای از پیش موجود را لیست کنید، چگونه برچسب بسازید و یا از بین ببرید و دیگر اینکه انواع مختلف تگها کدامند.
+
+
لیستکردن برچسبهایتان
+
+
لیست کردن برچسبهای موجود در گیت بسیار ساده است.
+تنها نیاز است که دستور git tag (با -l و یا --list اختیاری) را وارد نمایید:
+
+
+
+
این دستور برچسبهای موجود را به ترتیب حرف الفبا نشان میدهد؛ درواقع ترتیب نمایش آنها هیچ اهمیتی ندارد.
+
+
+
همچنین میتوانید برچسبها را بر اساس یک الگو خاص جستوجو کنید.
+برای نمونه مخزن اصلی گیت، بیش از ۵۰۰ برچسب دارد.
+مثلاً اگر میخواهید تنها به دنبال برچسبهای سری 1.8.5 بگردید، میتوانید دستور زیر را اجرا نمایید:
+
+
+
+
$ git tag -l "v1.8.5*"
+v1.8.5
+v1.8.5-rc0
+v1.8.5-rc1
+v1.8.5-rc2
+v1.8.5-rc3
+v1.8.5.1
+v1.8.5.2
+v1.8.5.3
+v1.8.5.4
+v1.8.5.5
+
+
+
+
+
+|
+ یادداشت
+ |
+
+ لیست کردن تگها با الگوها نیازمند آپشن -l یا --list است
+
+ اگر صرفاً لیست کاملی از تگها میخواهید، با اجرای git tag دستور به طور ضمنی فرض میکند که به دنبال لیست کردن هستید و لیستی را به شما ارائه میکند؛ استفاده از -l یا --list در این مورد اختیاری است.
+
+ با این حال اگر خواستید یک لیستی مشخص با یک الگو را ببینید، استفاده از آپشن -l یا --list لازم است.
+ |
+
+
+
+
+
ساختن برچسبها
+
+
گیت از دو نوع برچسب پشتیبانی میکند: lightweight یا سبک و annotated یا توصیفشده.
+
+
+
یک تگ سبک بسیار شبیه یک برنچ است که تغییر نمیکند — فقط یک نشانگر به کامیتی مشخص است.
+
+
+
با این حال، تگهای توصیفشده یا توضیحی به عنوان یک آبجکت کامل در پایگاهداده گیت ذخیره میشوند.
+آنها چکسام میشوند؛ شامل نام و ایمیل کسی که تگ را ثبت کرده و تاریخ میباشند؛ و میتوانند با محافظ حریم خصوصی گنو (GNU Privacy Guard (GPG)) امضا و تأیید شوند.
+به طور کلی پیشنهاد میشود که از تگ توضیحی استفاده کنید تا در نتیجه بتوانید تمام اطلاعات ذکر شده را داشته باشید؛ اما اگر میخواهید
+که یک تگ موقت ثبت کنید و بنا به دلایلی که نمیخواهید دیگر اطلاعات را نگه دارید، تگهای موقت یا سبک هم موجود هستند.
+
+
+
+
+
+ساخت یک برچسب توضیحی در گیت بسیار ساده است.
+آسانترین راه افزودن آپشن -a هنگام اجرای دستور tag میباشد:
+
+
+
+
$ git tag -a v1.4 -m "my version 1.4"
+$ git tag
+v0.1
+v1.3
+v1.4
+
+
+
+
با آپشن -m میتوانید یک پیام برچسب بنویسید که با تگ ذخیره میشود.
+اما اگر برای یک برچسب توضیحی پیامی مشخص نکنید، گیت ویرایشگر متن شما را برای نوشتن پیام تگ باز خواهد کرد.
+
+
+
شما میتوانید اطلاعات مربوط به تگ را در کنار کامیتی که برچسبگذاری شده با استفاده از git show ببینید:
+
+
+
+
$ git show v1.4
+tag v1.4
+Tagger: Ben Straub <ben@straub.cc>
+Date: Sat May 3 20:19:12 2014 -0700
+
+my version 1.4
+
+commit ca82a6dff817ec66f44342007202690a93763949
+Author: Scott Chacon <schacon@gee-mail.com>
+Date: Mon Mar 17 21:52:11 2008 -0700
+
+ Change version number
+
+
+
+
این دستور اطلاعات تگکننده، دادههای کامیت برچسب گذاری شده و پیغام توضیحات را پیش از اطلاعات کامیت نشان میدهد.
+
+
+
برچسبهای سبک
+
+
+راه دیگری برای برچسب گذاری کامیتها، برچسب سبک یا موقت است.
+این برچسب صرفاً چکسام کامیت است که در یک فایل ذخیره میشود — هیچ اطلاعات دیگری نگهداری نمیشود.
+برای ساخت یک برچسب موقت، هیچکدام از آپشنهای -a، -s یا -m را بکار نگیرید، فقط نام برچسب را وارد نمایید.
+
+
+
+
$ git tag v1.4-lw
+$ git tag
+v0.1
+v1.3
+v1.4
+v1.4-lw
+v1.5
+
+
+
+
در این لحظه، اگر شما دستور git show بر روی تگ اجرا کنید؛ اطلاعات اضافی نمیبینید.
+این دستور فقط کامیت را نشان میدهد:
+
+
+
+
$ git show v1.4-lw
+commit ca82a6dff817ec66f44342007202690a93763949
+Author: Scott Chacon <schacon@gee-mail.com>
+Date: Mon Mar 17 21:52:11 2008 -0700
+
+ Change version number
+
+
+
+
بعداً برچسب گذاشتن
+
+
شما این امکان را دارید که بعد از چند کامیت، کامیتها قبلی را تگ بزنید.
+فرض کنید تاریخچهٔ کامیتهای شما شبیه این باشد:
+
+
+
+
$ git log --pretty=oneline
+15027957951b64cf874c3557a0f3547bd83b3ff6 Merge branch 'experiment'
+a6b4c97498bd301d84096da251c98a07c7723e65 Create write support
+0d52aaab4479697da7686c15f77a3d64d9165190 One more thing
+6d52a271eda8725415634dd79daabbc4d9b6008e Merge branch 'experiment'
+0b7434d86859cc7b8c3d5e1dddfed66ff742fcbc Add commit function
+4682c3261057305bdd616e23b64b0857d832627b Add todo file
+166ae0c4d3f420721acbb115cc33848dfcc2121a Create write support
+9fceb02d0ae598e95dc970b74767f19372d61af8 Update rakefile
+964f16d36dfccde844893cac5b347e7b3d44abbc Commit the todo
+8a5cbc430f1a9c3d00faaeffd07798508422908a Update readme
+
+
+
+
حالا فرض کنید که پروژه را در v1.2 برچسبگذاری کنید، که مثلاً در کامیت «Updated rakefile» بوده است.
+پس از کامیت میتوانید این کار را انجام دهید.
+برای برچسب زدن به کامیت مورد نظر، هش کد کامیت مورد نظر را در آخر دستور وارد کنید.
+
+
+
+
$ git tag -a v1.2 9fceb02
+
+
+
+
میبینید که کامیت مورد نظر برچسب گذاری شده است:
+
+
+
+
$ git tag
+v0.1
+v1.2
+v1.3
+v1.4
+v1.4-lw
+v1.5
+
+$ git show v1.2
+tag v1.2
+Tagger: Scott Chacon <schacon@gee-mail.com>
+Date: Mon Feb 9 15:32:16 2009 -0800
+
+version 1.2
+commit 9fceb02d0ae598e95dc970b74767f19372d61af8
+Author: Magnus Chacon <mchacon@gee-mail.com>
+Date: Sun Apr 27 20:43:35 2008 -0700
+
+ Update rakefile
+...
+
+
+
+
+
+
دستور git push برچسبها را به صورت پیش فرض به سرور منتقل نمیکند.
+شما باید برچسبها را پس از ساخت و ایجاد آنها، مستقلاً به سرور انتقال دهید.
+این فرآیند دقیقاً شبیه انتقال و انتشار شاخههای ریموت است — شما میتوانید دستور git push origin <tagname> را اجرا کنید:
+
+
+
+
$ git push origin v1.5
+Counting objects: 14, done.
+Delta compression using up to 8 threads.
+Compressing objects: 100% (12/12), done.
+Writing objects: 100% (14/14), 2.05 KiB | 0 bytes/s, done.
+Total 14 (delta 3), reused 0 (delta 0)
+To git@github.com:schacon/simplegit.git
+ * [new tag] v1.5 -> v1.5
+
+
+
+
اگر برچسبهای زیادی دارید که میخواهید همه را یکجا به سرور منتقل کنید، میتوانید از گزینهٔ --tags در دستور git push استفاده نمایید.
+این دستور تمام تگهایی را که در سرور نیستند به سرور منتقل خواهد کرد.
+
+
+
+
$ git push origin --tags
+Counting objects: 1, done.
+Writing objects: 100% (1/1), 160 bytes | 0 bytes/s, done.
+Total 1 (delta 0), reused 0 (delta 0)
+To git@github.com:schacon/simplegit.git
+ * [new tag] v1.4 -> v1.4
+ * [new tag] v1.4-lw -> v1.4-lw
+
+
+
+
حالا اگر شخصی دیگر از مخزن شما کلون کند یا آن را پول کند، تمامی برچسبهای شما را نیز خواهد گرفت.
+
+
+
+
+|
+ یادداشت
+ |
+
+
+git push هر دو نوع برچسب را پوش میکند
+
+ فرستادن برچسبها به سمت سرور با دستور git push <tagname> --tags هیچ وجه تمایزی بین تگ توضیحی یا تگ سبک قائل نمیشود؛
+هیچ آپشن سادهای برای انتخاب یک نوع تگ جهت پوش کردن وجود ندارد.
+ |
+
+
+
+
+
حذف کردن برچسبها
+
+
برای حذف برچسبهای ساخت شده در مخزن محلی خود، میتوانید از دستور git tag -d <tagname> استفاده کنید.
+برای مثال، ما میتوانیم تگهای سبک خود را با دستور زیر حذف کنیم:
+
+
+
+
$ git tag -d v1.4-lw
+Deleted tag 'v1.4-lw' (was e7d5add)
+
+
+
+
دقت کنید که دستور بالا برچسب را از مخزنهای ریموت پاک نمیکند.
+دو راه ساده برای حذف برچسبها از سرور ریموت وجود دارد.
+
+
+
اولین راه، git push <remote> :refs/tags/<tagname> است:
+
+
+
+
$ git push origin :refs/tags/v1.4-lw
+To /git@github.com:schacon/simplegit.git
+ - [deleted] v1.4-lw
+
+
+
+
طریقهٔ تفسیر بالا این است که آنرا طوری بخوانید که انگار مقدار تهی پیش از نقل قول به نام تگ ریموت پوش میشود، که باعث حذف شدن آن است.
+
+
+
راه دوم (و منطقیتر) برای حذف برچسب از یک ریموت دستور زیر است:
+
+
+
+
$ git push origin --delete <tagname>
+
+
+
+
چکاوت کردن برچسبها
+
+
اگر میخواهید نسخههایی از فایلهایی را که یک تگ به آنها اشاره میکند ببینید، میتوانید یک git checkout از آن تگ انجام دهید،
+هرچند که این کار مخزن شما را در وضعیت «detached HEAD» قرار میدهد، که عوارض جانبی بدی دارد:
+
+
+
+
$ git checkout 2.0.0
+Note: checking out '2.0.0'.
+
+You are in 'detached HEAD' state. You can look around, make experimental
+changes and commit them, and you can discard any commits you make in this
+state without impacting any branches by performing another checkout.
+
+If you want to create a new branch to retain commits you create, you may
+do so (now or later) by using -b with the checkout command again. Example:
+
+ git checkout -b <new-branch>
+
+HEAD is now at 99ada87... Merge pull request #89 from schacon/appendix-final
+
+$ git checkout 2.0-beta-0.1
+Previous HEAD position was 99ada87... Merge pull request #89 from schacon/appendix-final
+HEAD is now at df3f601... Add atlas.json and cover image
+
+
+
+
در وضعیت «detached HEAD» اگر تغییراتی ایجاد کنید و سپس آنها را کامیت کنید، برچسب تغییر نخواهد کرد، اما کامیت شما در هیچ کدام از شاخهها ثبت نخواهد شد و غیرقابل دسترسی خواهد بود، مگر با هش دقیق آن.
+بنابراین اگر نیاز به ایجاد تغییرات دارید — مثلاً میخواهید یک باگ را در نسخههای پیشین برطرف نمایید — به طور کل بهتر است که یک شاخهٔ جدید بسازید.
+
+
+
+
$ git checkout -b version2 v2.0.0
+Switched to a new branch 'version2'
+
+
+
+
اگر دستور بالا را اجرا کنید و یک کامیت بسازید، شاخه version2 کمی با برچسب v2.0.0 شما متفاوت خواهد بود، چراکه با تغییرات جدید شما به جلو خواهد رفت، بنابراین مراقب باشید.
+
+
ثبت تغییرات در مخزن
+
+
تا اینجا، باید یک مخزن واقعی گیت بر روی سیستم محلیتان داشته باشید و یک چکاوت یا کپی کاری تمام فایلهای موجود مقابل شما باشد.
+معمولاً، شما میخواهید شروع به اعمال تغییرات کرده و هنگام رسیدن پروژه به درجهٔ خاصی، اسنپشاتهای همان تغییرات را در مخزن کامیت کنید.
+
+
بخاطر داشته باشید که هر فایل در پوشه کاری شما میتواند یکی از این دو حالت را داشته باشد: Tracked (رهگیری شده) یا Untracked (دنبال نشده).
+فایلهای رهگیری شده فایلهایی هستند که در آخرین اسنپشات شما بودهاند؛ آنها میتوانند ویرایشنشده، ویرایششده یا استیجشده داشته باشند.
+به طور خلاصه، فایلهای رهگیری شده آنهایی هستند که گیت آنها را میشناسد.
+
+
فایلهای رهگیری نشده مابقی فایلها هستند — هر فایلی در اسنپشات آخر شما نبوده باشد و شما آن را add نکرده باشید.
+در ابتدا، هنگامی که مخزنی را کلون میکنید، همهٔ فایلها رهگیریشده و دست نخورده هستند زیرا گیت همین الآن آنها را چکاوت کرده است و چیزی ویرایش نشده است.
+
+
به محض تغییر فایلها، گیت وضعیت آنها را به ویرایششده تغییر میدهد، چون شما آن را نسبت به کامیت آخر تغییر دادهاید.
+همانطور که کار میکنید، به طور انتخابی این فایلها را استیج کرده و تغییرات اعمال شدهٔ تحت استیج را کامیت میکنید و این چرخه تکرار میشود.
+
+
+
}}" alt="The lifecycle of the status of your files.">
+
+
نمودار 8. چرخه عمر وضعیت فایلهای شما.
+
+
بررسی وضعیت فایلها
+
+
ابزار اصلی که شما برای تعیین وضعیت فایلها استفاده میکنید، دستور git status است.
+اگر شما دستور را مستقیماً بعد از کلون اجرا کنید، باید چیزی شبیه به این ببینید:
+
+
+
+
$ git status
+On branch master
+Your branch is up-to-date with 'origin/master'.
+nothing to commit, working directory clean
+
+
+
+
این بدین معنی است که پوشه کاری شما تمیز است؛ به زبان دیگر، هیچ کدام از فایلهای رهگیریشده شما ویرایش نشدهاند.
+علاوه بر این گیت هیچ فایل دنبال نشدهای نمیبینید، اگر میدید در اینجا لیست میشد.
+در آخر، این دستور به شما میگوید که بر روی کدام شاخه و شعبه هستید و به شما اطلاع میدهد که شاخه مذکور از شاخهای که از سرور آمده جدا نشده است.
+فعلاً، آن شاخه همیشه master است که به صورت پیش فرض ساخته شده است؛ نگران نباشید در بخش شاخهسازی در گیت درباره این موضوع با جزئیات بحث خواهد شد.
+
+
+
فرض کنیم یک فایل جدید به پروژه اضافه میکنیم، یک فایل README ساده.
+اگر فایل از قبل وجود نداشت و git status را اجرا میکردید، فایلهای رهگیری نشده را به شکل زیر میدیدید:
+
+
+
+
$ echo 'My Project' > README
+$ git status
+On branch master
+Your branch is up-to-date with 'origin/master'.
+Untracked files:
+ (use "git add <file>..." to include in what will be committed)
+
+ README
+
+nothing added to commit but untracked files present (use "git add" to track)
+
+
+
+
همانطور که میبینید فایل README جدیدتان در حالت رهگیرینشده است، چون وضعیت فایل در زیر تیتر «Untracked files» خروجی است.
+به طوری کلی رهگیرینشده به این معنی است که گیت فایلی یافته است که در اسنپشات (کامیت) قبلی نداشتهاید؛
+گیت آن را به اسنپشات کامیتهای بعدی اضافه نمیکند تا زمانی که شما صراحتاً به گیت بگویید که این کار را کند.
+گیت این کار را میکند تا شما به صورت اتفاقی شروع به اضافه کردن فایلهای اجرایی ساختهشده یا دیگر فایلهایی که نمیخواهید به مخزن اضافه شوند نکنید.
+شما میخواهید شروع به اضافه کردن فایل README کنید، پس بیایید رهگیری آن را شروع کنیم.
+
+
+
دنبال کردن فایلهای جدید
+
+
برای رهگیری یک فایل جدید، از دستور git add استفاده میکنید.
+برای شروع پیگیری فایل README میتوانید این دستور را اجرا کنید:
+
+
+
+
اگر دستور git status را دوباره وارد کنید، میتوانید ببیند که حالا فایل README در حالت رهگیریشده و استیجشده قرار دارد تا کامیت شود:
+
+
+
+
$ git status
+On branch master
+Your branch is up-to-date with 'origin/master'.
+Changes to be committed:
+ (use "git restore --staged <file>..." to unstage)
+
+ new file: README
+
+
+
+
میتوانید بگویید که فایل تحت استیج است چراکه فایل در زیر تیتر «Changes to be committed» قرار دارد.
+اگر در این نقطه کامیتی بگیرید، نسخهای از فایل در اسنپشات متعاقب خواهد بود که در زمان اجرای git add وجود داشته است.
+ممکن است به خاطر داشته باشید که پیشتر، دستور git init و پس از آن git add <files> را اجرا کردید — که برای رهگیری فایلهای پوشهٔ شما بود.
+دستور git add مسیری را برای یک فایل یا پوشه میگیرد؛ اگر یک پوشه باشد، دستور به صورت بازگشتی تمامی فایلهای آن پوشه را اضافه میکند.
+
+
+
استیجکردن فایلهای ویرایششده
+
+
بیایید فایلی که در حال حاضر رهگیریشده است را تغییر دهیم.
+اگر یک فایل از قبل رهگیریشده به نام CONTRIBUTING.md تغییر دهید و دوباره دستور git status را اجرا کنید، خروجی مشابه زیر میبینید:
+
+
+
+
$ git status
+On branch master
+Your branch is up-to-date with 'origin/master'.
+Changes to be committed:
+ (use "git reset HEAD <file>..." to unstage)
+
+ new file: README
+
+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: CONTRIBUTING.md
+
+
+
+
فایل CONTRIBUTING.md در بخشی به نام «Changes not staged for commit» ظاهر خواهد شد — به معنی که فایلی در پوشه کاری ویرایش شده است که هنوز آنرا استیج نکردهایم.
+برای استیج کردن آن میبایست دستور git add را اجرا کنید.
+دستور git add چند منظوره است — از آن برای رهگیری کردن فایلهای جدید، استیج کردن و برای انجام دیگر کارها مثل علامت زدن تداخلات فایلها به عنوان حل شده استفاده میکنید.
+ممکن است نگاه به آن به عنوان «این محتوا را به کامیت بعدی اضافه کن» قابل فهمتر باشد تا «این فایل را به پروژه اضافه کن».
+بیایید دستور git add را اجرا کنیم تا فایل CONTRIBUTING.md را استیج کنیم، و بعد دستور git status را دوباره وارد کنیم:
+
+
+
+
$ git add CONTRIBUTING.md
+$ git status
+On branch master
+Your branch is up-to-date with 'origin/master'.
+Changes to be committed:
+ (use "git reset HEAD <file>..." to unstage)
+
+ new file: README
+ modified: CONTRIBUTING.md
+
+
+
+
هر دو فایل استیج شدهاند و به کامیت بعدی شما اضافه خواهند شد.
+در این لحظه، فرض کنید که یادتان میآید که میخواهید قبل از اینکه کامیت کنید یک تغییر کوچک دیگر در فایل CONTRIBUTING.md ایجاد کنید.
+فایل را دوباره باز میکنید و تغییرات را اعمال میکنید، حالا آماده کامیت هستید.
+هرچند، بیایید دوباره دستور git status را اجرا کنیم:
+
+
+
+
$ vim CONTRIBUTING.md
+$ git status
+On branch master
+Your branch is up-to-date with 'origin/master'.
+Changes to be committed:
+ (use "git reset HEAD <file>..." to unstage)
+
+ new file: README
+ modified: CONTRIBUTING.md
+
+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: CONTRIBUTING.md
+
+
+
+
چطور شد؟
+فایل CONTRIBUTING.md هم به عنوان فایلی استیجشده و همچنین استیجنشده لیست شده است.
+چطور امکان دارد؟
+مشخص میشود که گیت فایل را دقیقاً به آن صورتی استیج میکند که هنگام اجرای دستور git add بوده است.
+اگر الآن کامیت کنید، نسخهٔ CONTRIBUTING.md آن خواهد بود که آخرین بار git add را روی آن اجرا کردهاید و همانگونه به کامیت اضافه میشود، نه آن نسخهای که هنگام اجرای git commit در پوشهٔ کاری شماست.
+اگر فایلی را بعد از اجرای git add ویرایش کنید، باید git add را دوباره اجرا کنید تا آخرین نسخهٔ فایل را دوباره استیج کنید:
+
+
+
+
$ git add CONTRIBUTING.md
+$ git status
+On branch master
+Your branch is up-to-date with 'origin/master'.
+Changes to be committed:
+ (use "git reset HEAD <file>..." to unstage)
+
+ new file: README
+ modified: CONTRIBUTING.md
+
+
+
+
وضعیتهای کوتاه
+
+
خروجی git status خیلی توصیفی و لغوی است؛
+گیت همچنین فلگی برای اعلام وضعیتهای کوتاه دارد که شما را قادر میکند تغییرات خود را به طور خلاصهتر ببینید.
+اگر دستور git status -s یا git status --short را وارد کنید، یک خروجی ساده شده خواهید گرفت:
+
+
+
+
$ git status -s
+ M README
+MM Rakefile
+A lib/git.rb
+M lib/simplegit.rb
+?? LICENSE.txt
+
+
+
+
فایلهای جدیدی که هنوز رهگیری نشدهاند علامت ?? مقابل آنان است، فایلهای جدیدی که استیج شدهاند علامت A دارند، فایلهای ویرایششده علامت M دارند و باقی نیز به همین ترتیب.
+خروجی شامل دو ستون است — ستون سمت چپ نشاندهنده وضعیت استیج است و ستون سمت راست نشاندهنده وضعیت درخت کاری است.
+برای مثال در خروجی بالا، فایل README در پوشه کاری تغییر یافته است اما هنوز استیج نشده، در حالی که فایل lib/simplegit.rb ویرایش و استیج شده است.
+فایل Rakefile ویرایش، استیج و بعد دوباره ویرایش شده، به همین دلیل تغییرات آن هم استیجشده و استیجنشده هستند.
+
+
+
نادیده گرفتن فایلها
+
+
اغلب مجموعهای از فایلها خواهید داشت که نمیخواهید گیت به طور خودکار آنها را اضافه یا حتی به عنوان رهگیری نشده به شما نشان دهد.
+به صورت کلی این فایلها، فایلهایی هستند که به صورت خودکار ساخته میشوند مثل لاگها و فایلهایی که توسط سیستم ساخته میشوند.
+در این گونه موارد، شما میتوانید فایلی داشته باشید که همهٔ آنها را با الگوهایی مرتبط لیست میکند و آنرا .gitignore بنامید.
+در اینجا مثالی برای فایل .gitignore داریم:
+
+
+
+
$ cat .gitignore
+*.[oa]
+*~
+
+
+
+
خط اول به گیت میگوید که هر فایلی که با .o یا .a تمام میشود را نادیده بگیرد — فایلهای آرشیو یا آبجکتهایی که ممکن است حاصل خروجی کد شما باشند.
+خط دوم به گیت میگوید که همهٔ فایلهای که نامشان با علامت مد (~) پایانیافته است را نادیده بگیرد، علامتی که توسط کثیری از ویرایشگرها مانند ایمکس استفاده میشود تا فایلهای موقت را علامتگذاری کنند.
+شاید حتی یک پوشهٔ log، tmp و یا pid، فایل مستنداتی که خودکار ساخته شدهاند و سایر را هم اضافه کنید.
+راهاندازی یک فایل .gitignore برای مخزن جدیدتان پیش از اینکه کار خود را شروع کنید تمرین خوبی است چرا که نمیخواهید به طور اتفاقی فایلهایی را کامیت کنید که قصد ذخیره آنها را در مخزن گیت خود نداشتهاید.
+
+
+
قوانین الگوهایی که میتوانید در فایل .gitignore قرار دهید به این صورت است:
+
+
+
+-
+
خطهای خالی یا خطهایی که با # شروع شوند نادیده گرفته میشوند.
+
+-
+
الگوهای استاندارد گلاب کار میکنند و به صورت بازگشتی بر روی درخت کاری شما اعمال میشوند.
+
+-
+
میتوانید الگوها را با یک اسلش رو به جلو (/) شروع کنید تا از حالت بازگشتی آن اجتناب کنید.
+
+-
+
میتوانید الگوها را با یک اسلش رو به جول (/) تمام کنید تا پوشهای را مشخص کنید.
+
+-
+
میتوانید الگویی را با اضافه کردن علامت تعجب (!) برعکس کنید.
+
+
+
+
+
الگوهای گلاب مانند عبارات منظم ساده شدهای هستند که شلها از آن استفاده میکنند.
+یک ستاره (*) با یک یا چند حرف تطبیق داده میشود؛ [abc] هر حرفی که داخل براکت یا قلاب باشد را تطبیق میدهد (در این مثال a، b، یا c هستند)؛
+یک علامت سوال (?) یک تک حرف را تطبیق میدهد؛ و براکتهایی که حروفی را که با خط تیره از هم جدا شده باشند ([9-0]) را محاصره کرده باشند هر حرفی که
+در آن مجموعه وجود داشته باشند را پیدا میکند (در این مورد هر عددی که بین 0 و 9 باشد).
+همچنین میتوانید از دو ستاره برای تطبیق پوشههای تو در تو استفاده کنید؛ a/**/z با a/z، a/b/z، a/b/c/z و ساختارهای مشابه تطبیق پیدا میکرد.
+
+
+
در اینجا مثال دیگری برای فایل .gitignore داریم:
+
+
+
+
# ignore all .a files
+*.a
+
+# but do track lib.a, even though you're ignoring .a files above
+!lib.a
+
+# only ignore the TODO file in the current directory, not subdir/TODO
+/TODO
+
+# ignore all files in any directory named build
+build/
+
+# ignore doc/notes.txt, but not doc/server/arch.txt
+doc/*.txt
+
+# ignore all .pdf files in the doc/ directory and any of its subdirectories
+doc/**/*.pdf
+
+
+
+
+
+|
+ نکته
+ |
+
+
+ گیتهاب لیست قابل فهم خوبی از نمونه فایلهای .gitignore مملوع از مثالهای مختلف برای زبانها و پروژههای مختلف در https://github.com/github/gitignore دارد، اگر دنبال یک نمونه آغازین برای پروژه خود هستید.
+ |
+
+
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ در این مثالهای ساده، یک مخزن شاید یک فایل .gitignore در پوشه روت خود داشته باشد، که به صورت بازگشتی روی تمام پروژه اعمال میشود.
+با این حال، این امکان هم وجود دارد که پروژهها در زیر پوشههای خود باز هم فایل .gitignore داشته باشد.
+قوانین درون این فایلهای .gitignore تو در تو فقط روی فایلهای زیر پوشههای آنها اعمال میشود
+(مخزن منبع هسته لینوکس ۲۰۶ فایل .gitignore دارد.)
+
+ این موضوع و جزئیات فایلهای .gitignore چندگانه خارج از بحث کتاب است؛ برای جزئیات بیشتر به man gitignore مراجعه کنید.
+ |
+
+
+
+
+
نمایش تغییرات استیجشده و استیجنشده
+
+
اگر دستور git status کمی برایتان مبهم است — میخواهید بفهمید دقیقاً چه چیزی، نه فقط چه فایلهایی، را تغییر دادهاید — میتوانید از دستور git diff استفاده کنید.
+درباره دستور git diff و جزئیات آن بعد میگوییم، اما احتمالاً شما از این دستور بیشتر برای پاسخ به دو سؤال استفاده کنید: چه چیزی را تغییر دادهاید اما هنوز استیج نکردهاید؟
+و چه چیزی را استیج کرده و در شرف کامیت کردن آن هستید؟
+با اینکه دستور git status جواب آن سؤالات را به صورت کلی، به واسطه لیست کردن نامهای فایلها خواهد داد، اما git diff جزئیات دقیق خطوط اضافه و حذف شده — انگار پچ آنرا — به شما نشان میدهد.
+
+
+
فرض کنیم که شما از دوباره فایل README را تغییر داده و استیج کردهاید و سپس فایل CONTRIBUTING.md را بدون استیج کردن ویرایش کردهاید.
+اگر دستور git status را اجرا کنید، دگر بار چیزی شبیه به خروجی پایین میبینید:
+
+
+
+
$ git status
+On branch master
+Your branch is up-to-date with 'origin/master'.
+Changes to be committed:
+ (use "git reset HEAD <file>..." to unstage)
+
+ modified: README
+
+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: CONTRIBUTING.md
+
+
+
+
برای دیدن تغییراتی که انجام دادید ولی هنوز استیج نکردهاید، دستور git diff را بدون هیچ آرگومان دیگری وارد کنید:
+
+
+
+
$ git diff
+diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
+index 8ebb991..643e24f 100644
+--- a/CONTRIBUTING.md
++++ b/CONTRIBUTING.md
+@@ -65,7 +65,8 @@ branch directly, things can get messy.
+ Please include a nice description of your changes when you submit your PR;
+ if we have to read the whole diff to figure out why you're contributing
+ in the first place, you're less likely to get feedback and have your change
+-merged in.
++merged in. Also, split your changes into comprehensive chunks if your patch is
++longer than a dozen lines.
+
+ If you are starting to work on a particular area, feel free to submit a PR
+ that highlights your work in progress (and note in the PR title that it's
+
+
+
+
آن دستور چیزهایی که در پوشه کاری شما هست را با محتویات استیج مقایسه میکند.
+نتیجه تغییراتی را به شما نشان میدهد که اعمال کردهاید اما هنوز استیج نکردهاید.
+
+
+
اگر میخواهید ببینید چه چیزی را استیج کردهاید که در کامیت بعدی شما باشد، میتوانید از git diff --staged استفاده کنید.
+این دستور آخرین کامیتتان را با تغییرات استیج مقایسه میکند:
+
+
+
+
$ git diff --staged
+diff --git a/README b/README
+new file mode 100644
+index 0000000..03902a1
+--- /dev/null
++++ b/README
+@@ -0,0 +1 @@
++My Project
+
+
+
+
خیلی مهم است که دقت کنید که git diff خودش به تنهایی تمام تغییرات ایجاد شده از آخرین کامیت را نشان نمیدهد — بلکه فقط تغییراتی که هنوز استیج نشدهاند را به نمایش میگذارد.
+اگر شما تغییراتی را به استیج کنید، git diff خروجی به شما نمیدهد.
+
+
+
به عنوان مثالی دیگر، اگر شما فایل CONTRIBUTING.md را استیج کنید و سپس آن را تغییر دهید،
+میتوانید از دستور git diff استفاده کنید تا تغییرات استیجشده و تغییرات استیجنشده را ببینید.
+اگر محیط ما اینگونه باشد:
+
+
+
+
$ git add CONTRIBUTING.md
+$ echo '# test line' >> CONTRIBUTING.md
+$ git status
+On branch master
+Your branch is up-to-date with 'origin/master'.
+Changes to be committed:
+ (use "git reset HEAD <file>..." to unstage)
+
+ modified: CONTRIBUTING.md
+
+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: CONTRIBUTING.md
+
+
+
+
حال میتوانید از git diff برای دیدن مواردی که هنوز استیج نشدهاند استفاده کنید:
+
+
+
+
$ git diff
+diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
+index 643e24f..87f08c8 100644
+--- a/CONTRIBUTING.md
++++ b/CONTRIBUTING.md
+@@ -119,3 +119,4 @@ at the
+ ## Starter Projects
+
+ See our [projects list](https://github.com/libgit2/libgit2/blob/development/PROJECTS.md).
++# test line
+
+
+
+
و git diff --cached برای اینکه ببینید چه چیزی را تا اینجای کار استیج کردهاید (--staged و --cached مترادف هستند):
+
+
+
+
$ git diff --cached
+diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
+index 8ebb991..643e24f 100644
+--- a/CONTRIBUTING.md
++++ b/CONTRIBUTING.md
+@@ -65,7 +65,8 @@ branch directly, things can get messy.
+ Please include a nice description of your changes when you submit your PR;
+ if we have to read the whole diff to figure out why you're contributing
+ in the first place, you're less likely to get feedback and have your change
+-merged in.
++merged in. Also, split your changes into comprehensive chunks if your patch is
++longer than a dozen lines.
+
+ If you are starting to work on a particular area, feel free to submit a PR
+ that highlights your work in progress (and note in the PR title that it's
+
+
+
+
+
+|
+ یادداشت
+ |
+
+دستور git diff یک ابزار خارجی است.
+ |
+
+
+
+
+
+
+
در ادامهٔ کتاب از دستور git diff به طرق مختلفی استفاده خواهیم کرد.
+اگر ابزارهای گرافیکی یا برنامههای نمایش دیف دیگری را ترجیح میدهید راه دیگری هم برای مشاهده این دیف هست.
+اگر git difftool را به جای git diff اجرا کنید، میتواند هر کدام از این دیفها را در نرمافزارهایی مثل emerge، vimdiff و غیره (شامل نرمافزارهای تجاری) ببینید.
+دستور git difftool --tool-help را اجرا کنید تا ببنید که چه ابزارهایی بر روی سیستم شما موجود است.
+
+
+
+
+
کامیت کردن تغییراتتان
+
+
اکنون استیج شما آنطور که میخواستید آماده شده است، میتوانید تغییرات خود را کامیت کنید.
+به یاد داشته باشید که هر چیزی که همچنان استیجنشده است — هر فایلی که ساختهاید یا تغییر دادهاید و هنوز دستور git add را برای استیج کردن آنها اجرا نکردهاید — به کامیت اضافه نخواهند شد.
+آنها با عنوان فایل تغییر یافته بر روی دیسک شما باقی خواهد ماند.
+در این مورد، فرض کنیم که آخرین باری که دستور git status اجرا کردید، مشاهده کردهاید که تمام تغییرات استیج شدهاند، پس آمادهاید تا تغییراتتان را کامیت کنید.
+سادهترین راه کامیت کردن نوشتن دستور git commit است:
+
+
+
+
انجام این کار ویرایشگرتان را باز میکند.
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ ویرایشگر با متغیر محیطی EDITOR شل شما تنظیم میشود — معمولاً ویم یا ایمکس است، هرچند همانطور که در شروع به کار مشاهده کردید،
+میتوانید آنرا با استفاده از دستور git config --global core.editor با هر چیزی که میخواهید جایگزین کنید.
+ |
+
+
+
+
+
ویرایشگر متن زیر را به نمایش میگذارد (این مثال یک صفحه ویم است):
+
+
+
+
# Please enter the commit message for your changes. Lines starting
+# with '#' will be ignored, and an empty message aborts the commit.
+# On branch master
+# Your branch is up-to-date with 'origin/master'.
+#
+# Changes to be committed:
+# new file: README
+# modified: CONTRIBUTING.md
+#
+~
+~
+~
+".git/COMMIT_EDITMSG" 9L, 283C
+
+
+
+
میتوانید ببینید که پیام کامیت پیش فرض شامل آخرین خروجی دستور git status به صورت کامنت شده و یک خط خالی در بالای آن است.
+شما میتوانید تمام این کامنتها را حذف کرده و پیام خود را بنویسید، یا میتوانید همانطور آنها رها کنید تا به شما یادآوری کنند که در حال کامیت کردن چه چیزی هستید.
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ برای یادآوری صریحتر مواردی که ویرایش کردهاید، آپشن -v را به git commit بدهید.
+انجام این کار همچنین دیف تغییراتتان را در ویرایشگر قرار میدهد تا بتوانید ببینید دقیقاً چه تغییراتی را کامیت میکنید.
+ |
+
+
+
+
+
وقتی از ادیتور خارج میشوید، گیت کامیت مورد نظر شما را با پیام کامیتی که نوشتهاید (بدون کامنتها و دیفها) میسازد.
+
+
+
به عنوان یک روش دیگر، میتوانید پیام کامیت خود را به صورت درون خطی همراه با دستور git commit با آپشن -m بنویسید، مانند این:
+
+
+
+
$ git commit -m "Story 182: fix benchmarks for speed"
+[master 463dc4f] Story 182: fix benchmarks for speed
+ 2 files changed, 2 insertions(+)
+ create mode 100644 README
+
+
+
+
حال شما اولین کامیت خود را ساختید!
+میتوانید ببینید که کامیت، چند خروجی درباره خودش به شما میدهد: بر روی کدام برنچ کامیت انجام شده است (master)، چه کد هش SHA-1 دارد (463dc4f)، چه فایلهایی تغییر کردهاند و آمارهایی در کامیت جاری
+درباره خطهایی که اضافه یا حذف شدهاند.
+
+
+
به یاد داشته باشید که کامیت، اسنپشاتی را ثبت میکند که شما در استیج آمادهسازی کردهاید.
+هر چیزی که استیج نکردهاید همچنان با عنوان فایل تغییر یافته باقی مانده است؛ میتوانید کامیت دیگری بسازید و آن را به تاریخچهٔ تغییرات خود اضافه کنید.
+هر زمانی که یک کامیت جدید میگیرید، در حال ثبت اسنپشاتی از پروژه خود هستید که که در هر زمان میتوانید پروژه را به آن برگردانید یا مقایسه کنید.
+
+
+
گذر از استیج
+
+
+هرچند که برای ساختن کامیتها دقیقاً به آن نحوی که میخواهید استیج بسیار مفید است، اما گاهی بیش از نیاز برای روند کاریتان پیچیده است.
+اگر میخواهید از مرحله استیج کردن فایلها رد شوید، گیت میانبر سادهای ارائه میکند.
+اضافه کردن آپشن -a به دستور git commit گیت را وادار میکند که به طور خودکار هر فایلی را که پیش از کامیت گرفتن رهگیری شده را استیج کند که به شما این امکان را میدهد که از بخش git add گذر کنید:
+
+
+
+
$ git status
+On branch master
+Your branch is up-to-date with 'origin/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: CONTRIBUTING.md
+
+no changes added to commit (use "git add" and/or "git commit -a")
+$ git commit -a -m 'Add new benchmarks'
+[master 83e38c7] Add new benchmarks
+ 1 file changed, 5 insertions(+), 0 deletions(-)
+
+
+
+
دقت کنید که در این مورد دیگر لازم نیست قبل از اینکه کامیت کنید، دستور git add را روی فایل CONTRIBUTING.md اجرا کنید.
+این از این جهت است که آپشن -a تمام فایلهایی که تغییر کردهاند را در بر میگیرد.
+این گزینهٔ راحتی است اما مراقب باشید؛ گاهی اوقات باعث میشود که تغییراتی را که نمیخواهید شامل کنید.
+
+
+
حذف کردن فایل
+
+
+برای حذف یک فایل از گیت، باید آن را از فایلهای رهگیری شده حذف کنید (به طور دقیقتر، آن را از استیج حذف کنید) و بعد کامیت کنید.
+دستور git rm این کار را میکند و همچنین فایل را از پوشه کاریتان حذف میکند تا شما دفعهٔ بعد آن را به عنوان یک فایل رهگیرینشده نبینید.
+
+
+
اگر صرفاً فایل را از پوشه کاریتان حذف کنید، آن را زیر تیتر «Changes not staged for commit» (معادل unstaged) خروجی git status خود میبینید:
+
+
+
+
$ rm PROJECTS.md
+$ git status
+On branch master
+Your branch is up-to-date with 'origin/master'.
+Changes not staged for commit:
+ (use "git add/rm <file>..." to update what will be committed)
+ (use "git checkout -- <file>..." to discard changes in working directory)
+
+ deleted: PROJECTS.md
+
+no changes added to commit (use "git add" and/or "git commit -a")
+
+
+
+
سپس، اگر دستور git rm را اجرا کنید، حذف فایل را استیج میکند:
+
+
+
+
$ git rm PROJECTS.md
+rm 'PROJECTS.md'
+$ git status
+On branch master
+Your branch is up-to-date with 'origin/master'.
+Changes to be committed:
+ (use "git reset HEAD <file>..." to unstage)
+
+ deleted: PROJECTS.md
+
+
+
+
دفعه بعد که کامیت کنید، فایل از بین خواهد رفت و دیگر رهگیری نخواهد شد.
+اگر فایل را تغییر دادهاید یا آن را استیج کردهاید، باید با استفاده از آپشن -f حذف آنرا تحمیل کنید.
+این یک امکان امنیتی برای جلوگیری از حذف تصادفی دادههایی است که هنوز در اسنپشاتی ثبت نشدهاند و نمیتوانند توسط گیت بازیابی شوند.
+
+
+
کار مفید دیگری که ممکن است بخواهید انجام دهید، نگهداری فایل در پوشه کاری اما حذف آن از استیج است.
+به بیان دیگر، ممکن است بخواهید فایل را در هارددیسک خود نگهدارید اما نخواهید گیت دیگر آنرا رهگیری کند.
+این بخصوص وقتی مفید است که فراموش کردهاید چیزی را به .gitignore اضافه کنید و تصادفاً آن را استیج کردهاید، مانند یک فایل لاگ بزرگ یا تعدادی فایل .a کامپایل شده.
+برای انجام این کار از آپشن --cached استفاده کنید:
+
+
+
+
$ git rm --cached README
+
+
+
+
میتوانید از الگوهای فایلها، پوشهها و فایل-گلاب در دستور git rm استفاده کنید.
+این به آن معناست که میتوانید چنین کارهایی کنید:
+
+
+
+
به بکاسلش(\) مقابل * دقت کنید.
+این لازم است چراکه گیت گسترش نامفایل (Filename Expansion) خودش را مازاد بر گسترش نامفایل شل شما انجام میدهد.
+این دستور تمام فایلهایی که با پسوند .log درون پوشته log/ را حذف میکند.
+یا شما میتوانید چیزی شبیه به دستور زیر را اجرا کنید:
+
+
+
+
این دستور تمام فایلهایی که نام آنها با یک ~ تمام میشود را حذف میکند.
+
+
+
جابهجایی فایلها
+
+
+بیتشابه به کثیری از سیستمهای VCS دیگر، گیت به صراحت جابهجاییها را دنبال نمیکند.
+اگر شما نام فایلی را در گیت تغییر دهید، هیچ متادیتایی در گیت وجود ندارد که به آن بگوید که شما آن نام فایل را تغییر دادهاید.
+با این حال، پس از رخ دادن چنین موردی گیت در این باره هوشمندانه عمل میکند — جلوتر درباره جابهجایی فایلها میپردازیم.
+
+
+
بنابراین شاید کمی گیجکننده باشد که گیت دستوری به نام mv دارد.
+اگر بخواهید نام یک فایل را در گیت تغییر دهید، میتوانید دستوری شبیه به زیر را اجرا کنید:
+
+
+
+
$ git mv file_from file_to
+
+
+
+
و به خوبی کار میکند.
+در حقیقت، اگر شما چیزی شبیه دستور زیر را اجرا کنید و وضعیت را بررسی کنید، میبینید که گیت آن را به عنوان فایل تغییر نام یافته در نظر میگیرد:
+
+
+
+
$ git mv README.md README
+$ git status
+On branch master
+Your branch is up-to-date with 'origin/master'.
+Changes to be committed:
+ (use "git reset HEAD <file>..." to unstage)
+
+ renamed: README.md -> README
+
+
+
+
با این حال، این معادل اجرا کردن چنین چیزی است:
+
+
+
+
$ mv README.md README
+$ git rm README.md
+$ git add README
+
+
+
+
گیت میفهمد که این یک تغییر نام ضمنی است، پس مهم نیست که شما فایلی را اینگونه تغییر نام دهید یا با دستور mv.
+تنها تفاوت اصلی این است که git mv، به جای سه دستور، یک دستور است — تابعی برای آسودگی کار است.
+مهمترآنکه میتوانید از هر ابزاری برای تغییر نام یک فایل استفاده کنید و بعداً، قبل از کامیت، git add/rm را اجرا کنید.
+
+
خلاصه
+
+
تا به اینجا، تمام عملیاتهای پایه و محلی گیت را میتوانید انجام دهید — ساختن یا کلون کردن یک مخزن، اعمال تغییرات، استیج و کامیت کردن آن تغییرات و مشاهده تاریخچه تمام تغییرات اعمال شده روی مخزن.
+پس از این به خفنترین ویژگی گیت میپردازیم: مدل شاخهسازی آن.
+
اگر فقط میتوانید یک فصل از این کتاب را بخوانید تا با گیت آشنا شوید و راه بیوفتید، دقیقاً همینجا است.
+این فصل شامل تمامی دستورات پایه گیت است که شما در اکثر اوقات از آنها استفاده میکنید.
در آخر این فصل شما قادر خواهید بود یک مخزن را پیکربندی و راهاندازی کنید، پیگیری فایلها را شروع کنید یا متوقف کنید و تغییرات را استیج و ثبت کنید.
+همچنین به شما نشان خواهیم داد که چگونه گیت را برای نادیده گرفتن برخی از فایلها و الگوهای فایلها تنظیم کنید، اشتباهات را به سرعت و راحتی بازگردانی کنید،
+در تاریخچه پروژه جستوجو کنیم و تغییرات ثبت شده بین کامیتها را مشاهده کنیم و پوش و پول از مخزن ریموت انجام دهیم.
+دستیابی به یک مخزن گیت
+
+
به طور کل میتوانید به یکی از دو روش زیر یک مخزن به دست آورید:
+
+
+-
+
یک پوشه محلی که تحت نظارت کنترل نسخه نیست را به مخزن گیت تبدیل کنید، یا
+
+-
+
یک نسخه از یک مخزن از پیش موجود گیت را از جایی دیگر کلون کنید.
+
+
+
+
در هر صورت شما یک مخزن گیت محلی آماده به کار خواهید داشت.
+
+
راهاندازی مخزن گیت در یک پوشه موجود
+
+
اگر شما پروژهای دارید که هنوز تحت نظارت کنترل نسخه نیست و میخواهید که مدیریت نسخههای آن را به کمک گیت انجام دهید، ابتدا به پوشه اصلی پروژه بروید.
+اگر تا کنون این کار را نکردهاید، این کار بسته سیستمعامل شما ممکن است کمی متفاوت باشد:
+
+
+
+
+
$ cd /home/user/my_project
+
+
+
+
+
+
$ cd /Users/user/my_project
+
+
+
+
+
+
$ cd C:/Users/user/my_project
+
+
+
+
+
+
با زدن این دستور یک پوشه تازه به نام .git ساخته میشود که تمام فایلهایی که مخزن نیاز دارد — اسکلت یک مخزن گیت — را در بر دارد.
+تا اینجای کار، گیت تغییرات هیچ فایلی را دنبال نمیکند.
+(برای اینکه بدانید در پوشه .git که هم اکنون ایجاد کردید، چه فایلهایی وجود دارند، Git Internals را ببینید.)
+
+
+
اگر میخواهید شروع به کنترل نسخه فایلهای موجود در پروژه کنید (مگر اینکه پوشه خالی باشد) شاید بهتر باشد که آنها را ترک
+یا مورد پیگیری قرار دهید و اولین کامیت یا کامیت ابتدایی را انجام دهید.
+برای انجام این کار میتوانید با چند دستور git add فایلهای انتخابی را رهگیری کنید و و در نهایت git commit بزنید:
+
+
+
+
$ git add *.c
+$ git add LICENSE
+$ git commit -m 'Initial project version'
+
+
+
+
کمی جلوتر به بررسی کاربرد این دستورها میپردازیم.
+در حال حاضر یک مخزن گیت با فایلهایی که ترک شدهاند و یک کامیت شروع دارید.
+
+
+
کلونکردن از مخزن موجود
+
+
اگر میخواهید یک کپی کامل از یک مخزن از پیش موجود را داشته باشید — برای مثال، پروژهای که علاقه دارید در آن مشارکت کنید — دستوری که به آن احتیاج دارید git clone است.
+اگر کمی با دیگر نرمافزارهای کنترل نسخه مانند سابورژن آشنا باشید، متوجه خواهید شد که فعل این دستور clone است، نه checkout.
+این یک تفاوت خیلی مهم است — به جای اینکه یک نسخه کپی از پروژه به دست آورید، گیت به طور مستقیم یک نسخه کامل از تمامی دادههایی که در سرور وجود دارد را تحویل میگیرد.
+به صورت پیشفرض با اجرای دستور git clone هر نسخهای از هر فایلی که در تاریخچهٔ پروژه است توسط گیت آورده میشود.
+در حقیقت اگر احیاناً دیسک سرور شما دچار مشکل گردد و اطلاعات از دست روند غالباً میتوانید به طور مستقیم از هر کلون دیگری
+روی هر کلاینت دیگری استفاده کنید تا اطلاعات سرور را به همان حالتی که به هنگام کلون کردن بود بازگردانید.
+(ممکن است بعضی از هوکهای سرور و این قبیل اطلاعات از دست بروند اما تمام نسخههای کنترل شده خواهند ماند — برای جزئیات بیشتر راهاندازی گیت در سرور را مطالعه کنید.)
+
+
+
با دستور git clone <url> یک مخزن را کلون میکنید.
+برای مثال، اگر بخواهید یک کتابخانه گیت قابل لینک به نام libgit2 را کلون کنید، میتوانید اینگونه انجام دهید:
+
+
+
+
$ git clone https://github.com/libgit2/libgit2
+
+
+
+
با اجرای خط بالا در مرحلهٔ اول یک پوشه به نام libgit2 ساخته میشود، در پوشه libgit2 یک پوشه جدید به نام .git ساخته شده
+و مخزن گیت راهاندازی میشود، تمام اطلاعات از مخزن اصلی دریافت میشوند و ما را به اخرین نسخه از پروژه چکاوت میکند.
+اگر وارد پوشه جدید libgit2 شوید، خواهید دید که فایلهای پروژه حاضر و آماده استفاده هستند.
+
+
+
اگر بخواهید مخزن مورد نظر را در پوشهای با نام دلخواه خودتان (بجای libgit2) کلون کنید، میتوانید نام پوشه دلخواه را مانند دستور پایین به عنوان آرگومان اضافه مشخص کنید:
+
+
+
+
$ git clone https://github.com/libgit2/libgit2 mylibgit
+
+
+
+
دستور بالا همان مراحل قبل را انجام میدهد، با این تفاوت که نام پوشهای که ساخته میشود mylibgit خواهد بود.
+
+
+
گیت دارای تعداد زیادی پروتکلهای انتقال است که شما میتوانید از آنها استفاده کنید.
+در مثال قبل از پروتکل https:// استفاده شد، اما شاید git:// یا user@server:path/to/repo.git را نیز دیده باشید، که از پروتکل SSH استفاده میکند.
+راهاندازی گیت در سرور تمام گزینههای موجود برای را دسترسی به مخزن گیت را معرفی خواهد کرد و درباره مضرات و فواید هر کدام توضیح خواهد داد.
+
+
دیدن تاریخچهٔ کامیتها
+
+
پس از اینکه چندین کامیت انجام دادید، یا اگر مخزنی با یک تاریخچهٔ از پیش موجود را کلون کردید، احتمالاً میخواهید ببینید که در کامیتهای پیشین چه پیش آمده است.
+اساسیترین و قدرتمندترین ابزار برای این کار دستور git log است.
+
+
این مثالها از یک پروژه بسیار ساده به نام «simplegit» استفاده میکنند.
+برای دریافت پروژه دستور زیر را اجرا کنید:
+
+
+
$ git clone https://github.com/schacon/simplegit-progit
+
+
+
هنگامی که git log را در این پروژه اجرا میکنید، باید خروجی ببینید که مشابه این است:
+
+
+
$ git log
+commit ca82a6dff817ec66f44342007202690a93763949
+Author: Scott Chacon <schacon@gee-mail.com>
+Date: Mon Mar 17 21:52:11 2008 -0700
+
+ Change version number
+
+commit 085bb3bcb608e1e8451d4b2432f8ecbe6306e7e7
+Author: Scott Chacon <schacon@gee-mail.com>
+Date: Sat Mar 15 16:40:33 2008 -0700
+
+ Remove unnecessary test
+
+commit a11bef06a3f659402fe7563abf99ad00de2209e6
+Author: Scott Chacon <schacon@gee-mail.com>
+Date: Sat Mar 15 10:31:28 2008 -0700
+
+ Initial commit
+
+
+
به صورت پیشفرض، بدون هیچ آرگومانی، دستور git log کامیتهای به ثبت رسیده در مخزن را از جدیدترین تا قدیمیترین لیست میکند؛ یعنی جدیدترین کامیت اولین به نمایش در میآید.
+همانطور که مشاهده میکنید این دستور کامیتها را به همراه هش کد SHA-1، نام و ایمیل نویسنده، تاریخ کامیت و پیام کامیت لیست میکند.
+
+
تعداد و انواع زیاید از آپشنها برای دستور git log وجود دارند تا به شما دقیقاً همان چیزی را نمایش دهند که شما به دنبالش هستید.
+اینجا چندی از محبوبترینها را به شما نشان میدهیم.
+
+
یکی از آپشنهای سودمند آپشن -p یا --patch است که تفاوتهای (خروجی پچ) معرفی شده در هر کامیت را نشان میدهد.
+همچنین میتوانید تعداد خروجیهای لاگ نمایشی را محدود کنید، برای مثال استفاده از -2 فقط دو مورد آخر را نشان میدهد.
+
+
+
$ git log -p -2
+commit ca82a6dff817ec66f44342007202690a93763949
+Author: Scott Chacon <schacon@gee-mail.com>
+Date: Mon Mar 17 21:52:11 2008 -0700
+
+ Change version number
+
+diff --git a/Rakefile b/Rakefile
+index a874b73..8f94139 100644
+--- a/Rakefile
++++ b/Rakefile
+@@ -5,7 +5,7 @@ require 'rake/gempackagetask'
+ spec = Gem::Specification.new do |s|
+ s.platform = Gem::Platform::RUBY
+ s.name = "simplegit"
+- s.version = "0.1.0"
++ s.version = "0.1.1"
+ s.author = "Scott Chacon"
+ s.email = "schacon@gee-mail.com"
+ s.summary = "A simple gem for using Git in Ruby code."
+
+commit 085bb3bcb608e1e8451d4b2432f8ecbe6306e7e7
+Author: Scott Chacon <schacon@gee-mail.com>
+Date: Sat Mar 15 16:40:33 2008 -0700
+
+ Remove unnecessary test
+
+diff --git a/lib/simplegit.rb b/lib/simplegit.rb
+index a0a60ae..47c6340 100644
+--- a/lib/simplegit.rb
++++ b/lib/simplegit.rb
+@@ -18,8 +18,3 @@ class SimpleGit
+ end
+
+ end
+-
+-if $0 == __FILE__
+- git = SimpleGit.new
+- puts git.show
+-end
+
+
+
این آپشن همان اطلاعات را نشان میدهد، لکن درجا پس از هر مورد یک دیف (تفاوت) به نمایش میگذارد.
+این برای بازنگری کد یا بررسی سریع اینکه در طی دستهای از کامیتهایی که یک مشارکتکننده اضافه کرده چه اتفاقاتی افتاده بسیار مفید است.
+همچنین میتوانید از دستهای از آپشنهای مختصرکننده با git log بهره ببرید.
+برای مثال اگر بخواهید مختصر آماری برای هر کامیت ببینید، میتوانید از آپشن --stat استفاده کنید:
+
+
+
$ git log --stat
+commit ca82a6dff817ec66f44342007202690a93763949
+Author: Scott Chacon <schacon@gee-mail.com>
+Date: Mon Mar 17 21:52:11 2008 -0700
+
+ Change version number
+
+ Rakefile | 2 +-
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+
+commit 085bb3bcb608e1e8451d4b2432f8ecbe6306e7e7
+Author: Scott Chacon <schacon@gee-mail.com>
+Date: Sat Mar 15 16:40:33 2008 -0700
+
+ Remove unnecessary test
+
+ lib/simplegit.rb | 5 -----
+ 1 file changed, 5 deletions(-)
+
+commit a11bef06a3f659402fe7563abf99ad00de2209e6
+Author: Scott Chacon <schacon@gee-mail.com>
+Date: Sat Mar 15 10:31:28 2008 -0700
+
+ Initial commit
+
+ README | 6 ++++++
+ Rakefile | 23 +++++++++++++++++++++++
+ lib/simplegit.rb | 25 +++++++++++++++++++++++++
+ 3 files changed, 54 insertions(+)
+
+
+
همانطور که مشاهده میکنید، آپشن --stat زیر هر کامیت لیستی از فایلهای تغییر داده شده، تعداد فایلها مورد تغییر قرار گرفته و تعداد خطوطی که به آن فایلها اضافه و حذف شده را چاپ میکند.
+همچنین در آخر چکیدهای از اطلاعات را قرار میدهد.
+
+
یکی دیگر از آپشنهای مفید --pretty است.
+این آپشن نوع فرمت لاگ خروجی را به حالت دیگری غیر از حالت پیشفرض تغییر میدهد.
+چندی آپشن از پیش ساخته شده برای این فلگ جهت استفاده شما در دسترس است.
+آپشن oneline هر کامیت را بر روی یک خط واحد چاپ میکند که در صورتی که در مواجهه با تعداد زیادی کامیت هستید مفید واقع است.
+علاوهبر آن، آپشنهای short، full و fuller خروجی را تقریباً همانگونه نمایش میدهد اما با اطلاعات کمتر تا بیشتر:
+
+
+
$ git log --pretty=oneline
+ca82a6dff817ec66f44342007202690a93763949 Change version number
+085bb3bcb608e1e8451d4b2432f8ecbe6306e7e7 Remove unnecessary test
+a11bef06a3f659402fe7563abf99ad00de2209e6 Initial commit
+
+
+
جالبترین آپشن format است که به شما اجازه میدهد نوع قالب خروجی لاگ شخصی خود را مشخص کنید.
+این بخصوص زمانی مفید است که میخواهید خروجی را برای تحلیل ماشین بسازید — چون شما قالب را به صراحت تعیین میکنید، میدانید که حتی با آپدیت گیت نیز تغییر نخواهد کرد:
+
+
+
$ git log --pretty=format:"%h - %an, %ar : %s"
+ca82a6d - Scott Chacon, 6 years ago : Change version number
+085bb3b - Scott Chacon, 6 years ago : Remove unnecessary test
+a11bef0 - Scott Chacon, 6 years ago : Initial commit
+
+
+
شاید در تعجب باشید که تفاوت author و committer در چیست.
+نویسنده یا author در واقع شخصی است که برای اولین بار کار را نوشته است، در حالی که کامیتکننده یا committer شخصی است که کامیت کار را اعمال کرده است
+پس اگر پچی را به پروژهای بفرستید و یکی از اعضای هسته پروژه آن را اعمال کند هر دوی شما امتیاز میبرید — شما به عنوان نویسنده و عضو هسته به عنوان شخص کامیتکننده.
+درمورد این تفاوت در گیت توزیعشده به طور مفصل بحث خواهیم کرد.
+
+
آپشن oneline و format به طور خاصی با آپشن دیگری از log به نام --graph مفید واقع میشوند.
+این آپشن یک گراف ASCII کوچک و تمیز برای نمایش شاخهها و تاریخچه مرج نشان میدهد:
+
+
+
$ git log --pretty=format:"%h %s" --graph
+* 2d3acf9 Ignore errors from SIGCHLD on trap
+* 5e3ee11 Merge branch 'master' of git://github.com/dustin/grit
+|\
+| * 420eac9 Add method for getting the current branch
+* | 30e367c Timeout code and tests
+* | 5a09431 Add timeout protection to grit
+* | e1193f8 Support for heads with slashes in them
+|/
+* d6016bc Require time for xmlschema
+* 11d191e Merge branch 'defunkt' into local
+
+
+
مادامی که وارد فصل بعدی که درباره برنچها و مرج است این نوع خروجی بیشتر مورد پسند واقع خواهد شد.
+
+
آنها تنها چند آپشن ساده برای خروجی با فرمت متفاوت هستند که در دستور git log مورد استفاده قرار میگیرد — تعداد خیلی بیشتری از این آپشنها وجود دارد.
+آپشنهای معمول git log آپشنهایی را که تا به اینجا بررسی کردیم، بعلاوه چندی فرمت آپشن معمول دیگر را که ممکن است برایتان مفید باشد را به همراه اینکه چطور خروجی دستور لاگ را تغییر میدهد را لیست میکند.
+
+جدول 2. آپشنهای معمول git log
+
+
+
+
+
+
+
+| آپشنها |
+توضیحات |
+
+
+
+
+-p
|
+پچهای معرفی شده با هر کامیت را نشان بده. |
+
+
+--stat
|
+آمارهای فایلهای ویرایششده در هر کامیت را نشان بده. |
+
+
+--shortstat
|
+فقط خطوط تغییریافته/اضافهشده/حذفشده را از دستور --stat نشان بده. |
+
+
+--name-only
|
+لیست فایلهای ویرایششده را پس از اطلاعات کامیت نشان بده. |
+
+
+--name-status
|
+لیست فایلهای تأثیرگرفته را نیز با اطلاعات اضافهشده/ویرایششده/حذفشده نشان بده. |
+
+
+--abbrev-commit
|
+فقط چند حرف اول چکسام SHA-1 را به جای هر ۴۰ حرف آن نشان بده. |
+
+
+--relative-date
|
+جای استفاده از قالب کامل تاریخ، آن را با قالب نسبی نمایش بده (به طور مثال «دو هفته پیش»). |
+
+
+--graph
|
+یک گراف ASCII از برنچها و تاریخچهٔ مرج در کنار خروجی لاگ نمایش بده. |
+
+
+--pretty
|
+کامیتها را با حالت جایگزین نشان بده. دارای آپشنهای، short، full، fuller و format (که در آن میتوانید قالب خودتان را تعیین کنید). |
+
+
+--oneline
|
+کوتاهشدهٔ --pretty=oneline --abbrev-commit که با هم استفاده میشوند. |
+
+
+
+
+
محدود کردن خروجی لاگ
+
+
علاوهبر انواع آپشنهای فرمت خروجی، git log چندین آپشن محدودکننده مفید قبول میکند؛ این آپشنها به شما این اجازه را میدهند که فقط یک زیرمجموعه از کامیتها را ببینید.
+کمی قبلتر یکی از این آپشنها را دیده بودید — آپشن -2 که دو کامیت آخر را نشان میداد.
+در حقیقت میتوانید -<n> را وارد کنید که در آن n یک عدد برای نمایش n کامیت آخر است.
+در واقعیت، کم پیش میآید که از آن استفاده کنید، چراکه خود گیت به صورت پیشفرض همهٔخروجیها را به یک صفحهبند پایپ میکند تا شما فقط یک صفحه خروجی لاگ را در لحظه ببینید.
+با این حال، آپشنهای محدودکننده زمان مانند --since و --until بسیار مفید هستند.
+برای مثال، این دستور لیست کامیتهای ساخته شده در دو هفتهٔ گذشته را نشان میدهد:
+
+
+
+
$ git log --since=2.weeks
+
+
+
+
این دستور با انواع زیادی از قالبها کار میکند — شما میتوانید تاریخی معیین مانند "2008-01-15" یا تاریخی نسبی مانند "2 years 1 day 3 minutes ago" تعیین کنید.
+
+
+
همچنین این امکان را دارید که لیست کامیتها را با الگوهای جستوجو فیلتر کنید و فقط یافتههای مطابق با الگو یا شرط را ببینید.
+آپشن --author این اجازه را به شما میدهد که کامیتهای یک نویسنده مشخص را فیلتر و آپشن --grep به شما این امکان را میدهد که به دنبال کلماتی کلیدی در پیامهای کامیتها بگردید.
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ میتوانید بیش از یک نمونه از هر دو آپشنهای --author و --grep برای معیار جستوجو تعیین کنید، که
+خروجی کامیتها را به آنهایی محدود میکند که دارای هر نوع الگو مطابق با آپشنهای --author و --grep باشند؛
+با این حال اضافه کردن آپشن --all-match خروجی را به کامیتهایی محدود میکند که با تمام الگوهای --grep تطبیق پیدا کنند.
+ |
+
+
+
+
+
یکی دیگر از فیلترهای مفید آپشن -S است (به طور محاورهای به آن آپشن «pickaxe» گیت گفته میشود)، که یک رشته میگیرد و فقط کامیتهایی را نشان میدهد که تعداد این رشته را در خود تغییر دادهاند.
+برای نمونه، اگر بخواهید که آخرین کامیتی که رفرنسی به یک تابع خاص را حذف یا اضافه کرده است پیدا کنید، میتوانید اینگونه فراخوانی کنید:
+
+
+
+
$ git log -S function_name
+
+
+
+
آخرین آپشن مفید که میتوانید به git log بدهید، یک فیلتر مسیر است.
+اگر یک پوشه یا نام یک فایل را مشخص کنید، میتوانید خروجی را به کامیتهایی محدود کنید که تغییری را به آن فایلها معرفی کردهاند.
+این آپشن همیشه آخرین آپشن است و معمولاً با دو خط تیره (--) برای جدا سازی آدرس از آپشنها استفاده میشود.
+
+
+
+جدول 3. آپشنهای محدودکننده خروجی git log
+
+
+
+
+
+
+
+| آپشنها |
+توضیحات |
+
+
+
+
+-<n>
|
+فقط تعداد n کامیت آخر را نشان بده |
+
+
+--since, --after
|
+کامیتها را به آنهایی که پس از تاریخ تعیین شده ساخته شدهاند محدود کن |
+
+
+--until, --before
|
+کامیتها را به آنهایی که قبل از تاریخ تعیین شده ساخته شدهاند محدود کن |
+
+
+--author
|
+فقط کامیتهایی را نشان بده که نویسندهٔ آنها با رشته متن تعیین شده تطبیق دارد |
+
+
+--committer
|
+فقط کامیتهایی را نشان بده که کامیتکننده آنها با رشته متن تعیین شده تطبیق دارد |
+
+
+--grep
|
+فقط کامیتهایی را نشان بده که پیام کامیت آنها رشته متن تعیین شده را داشته باشد |
+
+
+-S
|
+فقط کامیتهایی را نشان بده که رشته متن تعیین شده در آنها حذف یا اضافه شده باشد |
+
+
+
+
+
به عنوان مثال، اگر میخواهید ببینید چه کامیتهایی فایلهای تست درون تاریخچهٔ سورس کد گیت را ویرایش کردهاند که توسط Junio Hamano در ماه اکتبر ۲۰۰۸ گرفته شدهاند و مرج کامیت نیستند،
+میتوانید چنین چیزی را اجرا کنید:
+
+
+
+
$ git log --pretty="%h - %s" --author='Junio C Hamano' --since="2008-10-01" \
+ --before="2008-11-01" --no-merges -- t/
+5610e3b - Fix testcase failure when extended attributes are in use
+acd3b9e - Enhance hold_lock_file_for_{update,append}() API
+f563754 - demonstrate breakage of detached checkout with symbolic link HEAD
+d1a43f2 - reset --hard/read-tree --reset -u: remove unmerged new paths
+51a94af - Fix "checkout --track -b newbranch" on detached HEAD
+b0ad11e - pull: allow "git pull origin $something:$current_branch" into an unborn branch
+
+
+
+
از ۴۰،۰۰۰ هزار کامیت در تاریخچه سورس کد گیت، این دستور ۶ مورد مطابق الگوهای مورد نظر را نشان داد.
+
+
+
+
+|
+ نکته
+ |
+
+ جلوگیری از نمایش مرج کامیتها
+
+ بسته به روند کاری مورد استفاده در مخزن شما، این امکان وجود دارد که درصد قابل توجهی از کامیتها فقط مرج کامیت باشند که اطلاعات خاصی را ارائه نمیکنند.
+برای جلوگیری از نمایش مرج کامیتهایی که تاریخچهٔ لاگ شما را به هم میریزند، کافیست آپشن لاگ --no-merges را اضافه کنید.
+ |
+
+
+
+
نامهای مستعار در گیت
+
+
+پیش از پایان بخش مقدمات گیت، تنها یک نکته کوچک میماند که میتواند تجربهٔ کارتان با گیت را سادهتر، آسانتر و آشناتر کند: نامهای مستعار (Aliases).
+ما به نامهای مستعار باز نخواهیم گشت یا فرض میکنیم که شمااز آنها در ادامهٔ کتاب استفاده کردهاید، اما احتمالاً بهتر است بدانید که چگونه باید با آنها کار کنید.
+
+
اگر دستوری را خلاصه یا بخش بخصوصی از آن را بنویسید گیت دستور شما را حدس نمیزند.
+اگر نمیخواهید که تمام متن هر کدام از دستورهای گیت را وارد کنید، به سادگی میتوانید یک نام مستعار برای هر دستور با استفاده از git config تنظیم کنید.
+مثالهای زیر نمونههایی هستند که ممکن است بخواهید برای خود داشته باشید:
+
+
+
$ git config --global alias.co checkout
+$ git config --global alias.br branch
+$ git config --global alias.ci commit
+$ git config --global alias.st status
+
+
+
این به آن معناست که اگر، برای مثال، به جای تایپ کردن git commit فقط لازم است git ci را تایپ کنید.
+همین طور که با گیت کار میکنید، شاید از دستورات دیگری نیز مکرراً استفاده کنید؛ برای ساختن نام مستعار جدید تأمل نکنید.
+
+
این تکنیک میتواند در ساخت دستورات جدیدی که فکر میکنید باید وجود میداشت بسیار مفید باشد.
+برای نمونه، برای رفع مشکل استفادهای که هنگام آناستش کردن یک فایل به آن بر میخورید، میتوانید نام مستعار آناستش ویژه خودتان را به گیت بیافزایید:
+
+
+
$ git config --global alias.unstage 'reset HEAD --'
+
+
+
این باعث میشود که دو دستور زیر با یکدیگر برابر باشند:
+
+
+
$ git unstage fileA
+$ git reset HEAD -- fileA
+
+
+
به نظر، کمی قضیه قابل فهم و روشن شد.
+همچنین اضافه کردن دستور last نیز به دین صورت رایج است:
+
+
+
$ git config --global alias.last 'log -1 HEAD'
+
+
+
با این روش، به سادگی میتوانید آخرین کامیت را مشاهده کنید:
+
+
+
$ git last
+commit 66938dae3329c7aebe598c2246a8e6af90d04646
+Author: Josh Goebel <dreamer3@example.com>
+Date: Tue Aug 26 19:48:51 2008 +0800
+
+ Test for current head
+
+ Signed-off-by: Scott Chacon <schacon@example.com>
+
+
+
همانطور که پی بردید گیت به سادگی دستورات جدید را با هرآنچه شما به عنوان نام مستعار میسازید جایگزین میکند.
+با این وجود، شاید بخواهید به جای یک زیردستور گیت، یک دستور خارجی را اجرا کنید.
+در این صورت، دستور را با علامت ! آغاز میکنیم.
+اگر میخواهید ابزار خودتان را برای کار با مخزن گیت بنویسید این مفید واقع میشود.
+با اضافه کردن نام مستعار git visual برای اجرای gitk میتوانیم این را نشان دهیم:
+
+
+
$ git config --global alias.visual '!gitk'
+
+
کار با ریموتها
+
+
برای اینکه بتوانید در هر پروژهٔ گیت همکاری کنید، دانستن شیوهٔ مدیریت مخزنهای ریموت لازم است.
+مخازن ریموت یک نسخه از پروژهٔ شما هستند که در اینترنت یا جایی دیگر در شبکه قرار دارند.
+میتوانید چند تا از آنها داشته باشید که معمولاً هر کدام برای شما یا فقط قابل خواندن یا خواندنی/نوشتی هستند.
+همکاری با دیگران شامل درگیری با مدیریت این مخازن ریموت و پوش و پول کردن داده از و به آنها به هنگام اشتراک کار است.
+مدیریت مخازن ریموت به مفهوم دانستن نحوه افزودن مخازن ریموت، حذف کردن ریموتهای منقضی، مدیریت شاخههای گوناگون ریموت و تعریف آنها به عنوان دنبالشده یا دنبالشنده و غیره است.
+در این بخش ما درباره برخی از مهارتهای مدیریت-ریموت صبحت خواهیم کرد.
+
+
+
+|
+ یادداشت
+ |
+
+ مخازن ریموت میتوانند روی کامپیوتر محلی خودتان باشند.
+
+ به سادگی امکان پذیر است که شما با مخازن «remote» کار کنید که در واقع روی همان میزبانی هستند که شما هستید.
+واژهٔ «remote» لزوماً به معنی این نیست که مخزن دور از دسترس، روی اینترنت یا هرجای دیگری از شبکه باشد، تنها به این معنی است که مخزن جای دیگری است.
+کارکردن با اینگونه مخازن ریموت نیز همانند هر ریموت دیگری نیز شامل عملیاتهای پوش، پول و فچ رایج است.
+ |
+
+
+
+
نمایش ریموتها
+
+
برای دیدن سرورهای ریموت که پیکربندی شدهاند، میتوانید دستور git remote را اجرا کنید.
+این دستور نامهای کوتاه سرورهای ریموتی که شما برگزیدید را نشان خواهد داد.
+اگر مخزن خود را کلون کردهاید، باید دست کم یک origin ببینید — که همان نام پیشفرضی است که گیت به سروری که از آن کلون کردهاید میدهد:
+
+
+
+
$ git clone https://github.com/schacon/ticgit
+Cloning into 'ticgit'...
+remote: Reusing existing pack: 1857, done.
+remote: Total 1857 (delta 0), reused 0 (delta 0)
+Receiving objects: 100% (1857/1857), 374.35 KiB | 268.00 KiB/s, done.
+Resolving deltas: 100% (772/772), done.
+Checking connectivity... done.
+$ cd ticgit
+$ git remote
+origin
+
+
+
+
همچنین میتوانید -v را بکار گیرید که به شما URLهایی که گیت برای اسامی کوتاه ذخیره کرده تا هنگام نوشتن و خواندن به آن ریموت استفاده شود را شامل میشود:
+
+
+
+
$ git remote -v
+origin https://github.com/schacon/ticgit (fetch)
+origin https://github.com/schacon/ticgit (push)
+
+
+
+
اگر بیش از یک سرور ریموت داشته باشید، این دستور همه را لیست میکند.
+برای نمونه، یک مخزن با چند ریموتهای متعدد برای کار با چندین همکار چیزی شبیه این خواهد بود.
+
+
+
+
$ cd grit
+$ git remote -v
+bakkdoor https://github.com/bakkdoor/grit (fetch)
+bakkdoor https://github.com/bakkdoor/grit (push)
+cho45 https://github.com/cho45/grit (fetch)
+cho45 https://github.com/cho45/grit (push)
+defunkt https://github.com/defunkt/grit (fetch)
+defunkt https://github.com/defunkt/grit (push)
+koke git://github.com/koke/grit.git (fetch)
+koke git://github.com/koke/grit.git (push)
+origin git@github.com:mojombo/grit.git (fetch)
+origin git@github.com:mojombo/grit.git (push)
+
+
+
+
این به معنی است که ما میتوانیم مشارکتها را از هر کدام از این کاربرها به راحتی دریافت کنیم.
+شاید ما به علاوه دسترسی برای پوش به یک یا چندی از این مخازن را نیز داشته باشیم، اگرچه در اینجا نمیتوانیم به آن پی ببریم.
+
+
+
دقت کنید که این ریموتها از پروتکلهای متنوعی استفاده میکنند؛ ما درباره این موضوع در راهاندازی گیت در سرور بیشتر خواهیم گفت.
+
+
+
اضافه کردن مخازن ریموت
+
+
پیشتر ذکر کردیم و چند مثال را بررسی کردیم که چگونه دستور git clone به طور ضمنی ریموت origin را برای شما اضافه میکند.
+اینجا نحوهٔ اضافه کردن ریموت به طور صریح قرار دارد.
+برای اضافه کردن یک مخزن گیت ریموت جدید با یک نام کوتاه که برای سهولت مراجعه استفاده میکنید، git remote add <shortname> <url> را اجرا کنید:
+
+
+
+
$ git remote
+origin
+$ git remote add pb https://github.com/paulboone/ticgit
+$ git remote -v
+origin https://github.com/schacon/ticgit (fetch)
+origin https://github.com/schacon/ticgit (push)
+pb https://github.com/paulboone/ticgit (fetch)
+pb https://github.com/paulboone/ticgit (push)
+
+
+
+
حالا میتوانید از pb در محیط ترمینال به جای کل آدرس آن مخزن استفاده کنید.
+برای مثال، اگر بخواهید تمام اطاعاتی را که پاول دارد اما شما ندارید را فچ کنید، میتوانید دستور git fetch pb اجرا کنید:
+
+
+
+
$ git fetch pb
+remote: Counting objects: 43, done.
+remote: Compressing objects: 100% (36/36), done.
+remote: Total 43 (delta 10), reused 31 (delta 5)
+Unpacking objects: 100% (43/43), done.
+From https://github.com/paulboone/ticgit
+ * [new branch] master -> pb/master
+ * [new branch] ticgit -> pb/ticgit
+
+
+
+
برنچ master پاول حالا به صورت محلی در master/pb قابل دسترس دسترس است — شما میتوانید این شاخه را در هر کدام از برنچهای دلخواه خود
+ادغام کنید، یا میتوانید یک برنچ محلی در آن نقطه را چکاوت کنید، اگر مایلید آنرا بازرسی کنید.
+(ما درباره برنچها و چگونگی استفاده از آنها با جزئیات بیشتر در بخش شاخهسازی در گیت خواهیم گفت.)
+
+
+
فچ و پول کردن از مخازن ریموتتان
+
+
همانطور که مشاهده کردید، برای دریافت اطلاعات از پروژههای ریموت خود،میتوانید این دستور را اجرا کنید:
+
+
+
+
دستور به پروژه ریموت مراجعه میکند و همهٔ اطلاعات آن پروژه ریموت را که شما ندارید را پول میکند.
+بعد از انجام این کار، باید رفرنسهایی به تمام برنچهای آن ریموت داشته باشید، که میتوانید آنها را در هر لحظه ادغام یا مورد نمایش قرار دهید.
+
+
+
اگر شما یک مخزن را کلون کنید، دستور به صورت خودکار آن مخزن را تحت عنوان «origin» اضافه میکند.
+پس git fetch origin تمامی کارها و اتفاقات جدیدی را که در آن سرور از وقتی که شما آن را کلون کردهاید (یا آخرین فچی که از آن کردید) دریافت میکند.
+خیلی مهم است که دقت کنید که دستور git fetch فقط اطلاعات را در مخزن محلی شما دانلود میکند — این دستور به صورت خودکار آن را با هیچکدام از کارهای شما ادغام یا کارهای فعلی شما را ویرایش نمیکند.
+
+
+
اگر برنچ جاری شما تنظیم شده باشد تا یک شاخه ریموت را دنبال کند (بخش بعدی و شاخهسازی در گیت را برای اطلاعات بیشتر ببینید)،
+میتوانید از دستور git pull استفاده کنید تا به صورت خودکار فچ و سپس ادغام آن با برنچ ریموت به برنچ فعلی شما انجام شود.
+شاید این، روند کاری راحتتر یا آسانتری برای شما باشد، و به صورت پیشفرض دستور git clone به طور خودکار برنچ master محلی شما را برای
+دنبال کردن برنچ master (یا هر چیزی که شاخه پیش فرض نامیده شود) ریموت آن سروری که از آن کلون کردید تنظیم میکند.
+اجرا کردن git pull به صورت کلی تمام دادهها را از سروری که ابتدا از آن کلون کرده بودید فچ میکند و به صورت خودکار سعی میکند تا آنرا در کدی که اکنون روی آن کار میکنید ادغام کند.
+
+
+
پوش کردن به ریموتهایتان
+
+
زمانی که پروژهای دارید که در درجهای است که میخواهید آن را به اشتراک بگذارید، باید آن را به بالادست پوش کنید.
+دستور این کار ساده است: git push <remote> <branch>.
+اگر میخواهید برنچ master را به سرور origin خود پوش کنید (مجدداً، کلون کردن هر دو این نامها را به طور اتوماتیک برای شما تنظیم میکند)،
+میتوانید این دستور را اجرا کنید تا هر کامیتی که گرفتهاید را به سرور پوش کنید.
+
+
+
+
$ git push origin master
+
+
+
+
این دستور فقط زمانی کار میکند که شما مخزنی را از سروری کلون کرده باشید که دسترسی نوشتن نیز داشته باشید و کسی در این حین پوش نکرده باشد.
+اگر شما و شخصی دیگر در آن واحد کلون کنید و آنها به بالادست پوش کنند و سپس شما به بالادست پوش کنید، پوش شما بلافاصله رد خواهد شد.
+ابتدا شما کار آنها را فچ کنید و آنرا در کار خود تعبیه کنید، پیش از اینکه مجاز به پوش شوید.
+برای جزئیات بیشتر درباره نحوه پوش روی یک سرور ریموت بخش شاخهسازی در گیت را مطالعه کنید.
+
+
+
بازرسی ریموت
+
+
اگر میخواید درباره یک ریموت خاص اطلاعات بیشتری ببینید، میتوانید از دستور git remote show <remote> استفاده کنید.
+اگر این دستور را با یک اسم خاص کوتاه اجرا کنید، مثلاً origin، چیزی شبیه به این را خواهید دید:
+
+
+
+
$ git remote show origin
+* remote origin
+ Fetch URL: https://github.com/schacon/ticgit
+ Push URL: https://github.com/schacon/ticgit
+ HEAD branch: master
+ Remote branches:
+ master tracked
+ dev-branch tracked
+ Local branch configured for 'git pull':
+ master merges with remote master
+ Local ref configured for 'git push':
+ master pushes to master (up to date)
+
+
+
+
این دستور URL مخزن ریموت و همچنین اطلاعات برنچهایی که دنبال میشوند را لیست میکند.
+دستور به طور مفید و مختصر به شما میگوید که اگر بر روی برنچ master هستید و git pull را اجرا کنید، به صورت اتوماتیک، پس از فچ کردن تمام رفرنسهای ریموت، برنچ master را با نسخه ریموت مرج میکند.
+همچنین تمام رفرنسهای ریموتی را که پول کرده را لیست میکند.
+
+
+
این سادهترین مثالی است که غالباً با آن مواجه میشوید.
+هرچند، وقتی از گیت در سطح وسیعتری استفاده کنید، احتمالاً اطلاعات بیشتری git remote show خواهید دید:
+
+
+
+
$ git remote show origin
+* remote origin
+ URL: https://github.com/my-org/complex-project
+ Fetch URL: https://github.com/my-org/complex-project
+ Push URL: https://github.com/my-org/complex-project
+ HEAD branch: master
+ Remote branches:
+ master tracked
+ dev-branch tracked
+ markdown-strip tracked
+ issue-43 new (next fetch will store in remotes/origin)
+ issue-45 new (next fetch will store in remotes/origin)
+ refs/remotes/origin/issue-11 stale (use 'git remote prune' to remove)
+ Local branches configured for 'git pull':
+ dev-branch merges with remote dev-branch
+ master merges with remote master
+ Local refs configured for 'git push':
+ dev-branch pushes to dev-branch (up to date)
+ markdown-strip pushes to markdown-strip (up to date)
+ master pushes to master (up to date)
+
+
+
+
این دستور نشان میدهد که چه برنچی به طور خودکار هنگام اجرای git push روی برنچهای خاص پوش شده است.
+همچنین به شما میگوید کدام برنچ روی سرور را شما ندارید، کدام برنچهای ریموت را شما دارید اما از روی سرور حذف شده است
+و چندین برنچ محلی که قادر هستند به طور خودکار زمانی که دستور git pull را اجرا کنید با برنچهای بر روی سرور ریموت خود مرج شوند.
+
+
+
تغییر نام و حذف ریموتها
+
+
شما میتوانید دستور git remote rename را اجرا کنید تا نام کوتاه ریموت را عوض کنید.
+برای نمونه، اگر میخواهید نام pb را به paul تغییر دهید، میتوانید با دستور git remote rename این کار را انجام دهید:
+
+
+
+
$ git remote rename pb paul
+$ git remote
+origin
+paul
+
+
+
+
شایان ذکر است که دستور بالا نام تمام برنچهای در پی ریموت شما را نیز تغییر میدهد.
+چیزی که سابقاً توسط pb/master به آن اشاره میشد، اکنون در paul/master قرار دارد.
+
+
+
اگر میخواهید یک ریموت را به هر دلیلی حذف کنید — سرور را جابهجا کردهاید دیگر از آن کپی خاص استفاده نمیکنید، یا شاید یک مشارکتکننده دیگر مشارکت نمیکند — میتوانید یا از دستور git remote remove یا از دستور git remote rm استفاده کنید:
+
+
+
+
$ git remote remove paul
+$ git remote
+origin
+
+
+
+
یکبار که مرجع یک ریموت را به این صورت پاک کنید، تمامی برنچهای پیگیر و پیکیربندیهای مرتبط با آن ریموت نیز از بین خواهند رفت.
+
+
Git in Bash
+
+
+If you’re a Bash user, you can tap into some of your shell’s features to make your experience with Git a lot friendlier.
+Git actually ships with plugins for several shells, but it’s not turned on by default.
+
+
First, you need to get a copy of the contrib/completion/git-completion.bash file out of the Git source code.
+Copy it somewhere handy, like your home directory, and add this to your .bashrc:
+
+
+
. ~/git-completion.bash
+
+
+
Once that’s done, change your directory to a Git repository, and type:
+
+
…and Bash will auto-complete to git checkout.
+This works with all of Git’s subcommands, command-line parameters, and remotes and ref names where appropriate.
+
+
It’s also useful to customize your prompt to show information about the current directory’s Git repository.
+This can be as simple or complex as you want, but there are generally a few key pieces of information that most people want, like the current branch, and the status of the working directory.
+To add these to your prompt, just copy the contrib/completion/git-prompt.sh file from Git’s source repository to your home directory, add something like this to your .bashrc:
+
+
+
. ~/git-prompt.sh
+export GIT_PS1_SHOWDIRTYSTATE=1
+export PS1='\w$(__git_ps1 " (%s)")\$ '
+
+
+
The \w means print the current working directory, the \$ prints the $ part of the prompt, and __git_ps1 " (%s)" calls the function provided by git-prompt.sh with a formatting argument.
+Now your bash prompt will look like this when you’re anywhere inside a Git-controlled project:
+
+
+
}}" alt="Customized `bash` prompt.">
+
+
نمودار 163. Customized bash prompt.
+
+
Both of these scripts come with helpful documentation; take a look at the contents of git-completion.bash and git-prompt.sh for more information.
+
Git in Eclipse
+
+
+Eclipse ships with a plugin called Egit, which provides a fairly-complete interface to Git operations.
+It’s accessed by switching to the Git Perspective (Window > Open Perspective > Other…, and select "Git").
+
+
+
}}" alt="Eclipse’s EGit environment.">
+
+
نمودار 161. Eclipse’s EGit environment.
+
+
EGit comes with plenty of great documentation, which you can find by going to Help > Help Contents, and choosing the "EGit Documentation" node from the contents listing.
+
Git in IntelliJ / PyCharm / WebStorm / PhpStorm / RubyMine
+
+
JetBrains IDEs (such as IntelliJ IDEA, PyCharm, WebStorm, PhpStorm, RubyMine, and others) ship with a Git Integration plugin.
+It provides a dedicated view in the IDE to work with Git and GitHub Pull Requests.
+
+
+
}}" alt="Version Control ToolWindow in JetBrains IDEs.">
+
+
نمودار 162. Version Control ToolWindow in JetBrains IDEs.
+
Git in PowerShell
+
+
+
+The legacy command-line terminal on Windows (cmd.exe) isn’t really capable of a customized Git experience, but if you’re using PowerShell, you’re in luck.
+This also works if you’re running PowerShell Core on Linux or macOS.
+A package called posh-git (https://github.com/dahlbyk/posh-git) provides powerful tab-completion facilities, as well as an enhanced prompt to help you stay on top of your repository status.
+It looks like this:
+
+
+
}}" alt="PowerShell with Posh-git.">
+
+
نمودار 166. PowerShell with Posh-git.
+
+
Installation
+
+
Prerequisites (Windows only)
+
+
Before you’re able to run PowerShell scripts on your machine, you need to set your local ExecutionPolicy to RemoteSigned (Basically anything except Undefined and Restricted).
+If you choose AllSigned instead of RemoteSigned, also local scripts (your own) need to be digitally signed in order to be executed.
+With RemoteSigned, only Scripts having the "ZoneIdentifier" set to Internet (were downloaded from the web) need to be signed, others not.
+If you’re an administrator and want to set it for all Users on that machine, use "-Scope LocalMachine".
+If you’re a normal user, without administrative rights, you can use "-Scope CurrentUser" to set it only for you.
+
+
+
+
+
+
> Set-ExecutionPolicy -Scope LocalMachine -ExecutionPolicy RemoteSigned -Force
+
+
+
+
+
PowerShell Gallery
+
+
If you have at least PowerShell 5 or PowerShell 4 with PackageManagement installed, you can use the package manager to install posh-git for you.
+
+
+
+
+
> Install-Module posh-git -Scope CurrentUser -Force
+> Install-Module posh-git -Scope CurrentUser -AllowPrerelease -Force # Newer beta version with PowerShell Core support
+
+
+
+
If you want to install posh-git for all users, use "-Scope AllUsers" instead and execute the command from an elevated PowerShell console.
+If the second command fails with an error like Module 'PowerShellGet' was not installed by using Install-Module, you’ll need to run another command first:
+
+
+
+
> Install-Module PowerShellGet -Force -SkipPublisherCheck
+
+
+
+
Then you can go back and try again.
+This happens, because the modules that ship with Windows PowerShell are signed with a different publishment certificate.
+
+
+
+
Update PowerShell Prompt
+
+
To include git information in your prompt, the posh-git module needs to be imported.
+To have posh-git imported every time PowerShell starts, execute the Add-PoshGitToProfile command which will add the import statement into you $profile script.
+This script is executed everytime you open a new PowerShell console.
+Keep in mind, that there are multiple $profile scripts.
+E. g. one for the console and a separate one for the ISE.
+
+
+
+
> Import-Module posh-git
+> Add-PoshGitToProfile -AllHosts
+
+
+
+
+
From Source
+
+
+
+
> Import-Module <path-to-uncompress-folder>\src\posh-git.psd1
+> Add-PoshGitToProfile -AllHosts
+
+
+
+
+
Git in Sublime Text
+
+
From version 3.2 onwards, Sublime Text has git integration in the editor.
+
+
+-
+
The sidebar will show the git status of files and folders with a badge/icon.
+
+-
+
Files and folders that are in your .gitignore file will be faded out in the sidebar.
+
+-
+
In the status bar, you can see the current git branch and how many modifications you have made.
+
+-
+
All changes to a file are now visible via markers in the gutter.
+
+-
+
You can use part of the Sublime Merge git client functionality from within Sublime Text.
+(This requires that Sublime Merge is installed. See: https://www.sublimemerge.com/)
+
+
+
Git in Visual Studio Code
+
+
Visual Studio Code has git support built in.
+You will need to have git version 2.0.0 (or newer) installed.
+
+
The main features are:
+
+
+-
+
See the diff of the file you are editing in the gutter.
+
+-
+
The Git Status Bar (lower left) shows the current branch, dirty indicators, incoming and outgoing commits.
+
+-
+
You can do the most common git operations from within the editor:
+
+
+-
+
Initialize a repository.
+
+-
+
Clone a repository.
+
+-
+
Create branches and tags.
+
+-
+
Stage and commit changes.
+
+-
+
Push/pull/sync with a remote branch.
+
+-
+
Resolve merge conflicts.
+
+-
+
View diffs.
+
+
+
+-
+
With a extension, you can also handle GitHub Pull Requests:
+https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github
+
+
+
Git in Visual Studio
+
+
+Starting with Visual Studio 2013 Update 1, Visual Studio users have a Git client built directly into their IDE.
+Visual Studio has had source-control integration features for quite some time, but they were oriented towards centralized, file-locking systems, and Git was not a good match for this workflow.
+Visual Studio 2013’s Git support has been separated from this older feature, and the result is a much better fit between Studio and Git.
+
+
To locate the feature, open a project that’s controlled by Git (or just git init an existing project), and select View > Team Explorer from the menu.
+You’ll see the "Connect" view, which looks a bit like this:
+
+
+
}}" alt="Connecting to a Git repository from Team Explorer.">
+
+
نمودار 159. Connecting to a Git repository from Team Explorer.
+
+
Visual Studio remembers all of the projects you’ve opened that are Git-controlled, and they’re available in the list at the bottom.
+If you don’t see the one you want there, click the "Add" link and type in the path to the working directory.
+Double clicking on one of the local Git repositories leads you to the Home view, which looks like The "Home" view for a Git repository in Visual Studio..
+This is a hub for performing Git actions; when you’re writing code, you’ll probably spend most of your time in the "Changes" view, but when it comes time to pull down changes made by your teammates, you’ll use the "Unsynced Commits" and "Branches" views.
+
+
+
}}" alt="The Home view for a Git repository in Visual Studio.">
+
+
نمودار 160. The "Home" view for a Git repository in Visual Studio.
+
+
Visual Studio now has a powerful task-focused UI for Git.
+It includes a linear history view, a diff viewer, remote commands, and many other capabilities.
+For complete documentation of this feature (which doesn’t fit here), go to http://msdn.microsoft.com/en-us/library/hh850437.aspx.
+
Git in Zsh
+
+
+Zsh also ships with a tab-completion library for Git.
+To use it, simply run autoload -Uz compinit && compinit in your .zshrc.
+Zsh’s interface is a bit more powerful than Bash’s:
+
+
+
$ git che<tab>
+check-attr -- display gitattributes information
+check-ref-format -- ensure that a reference name is well formed
+checkout -- checkout branch or paths to working tree
+checkout-index -- copy files from index to working directory
+cherry -- find commits not merged upstream
+cherry-pick -- apply changes introduced by some existing commits
+
+
+
Ambiguous tab-completions aren’t just listed; they have helpful descriptions, and you can graphically navigate the list by repeatedly hitting tab.
+This works with Git commands, their arguments, and names of things inside the repository (like refs and remotes), as well as filenames and all the other things Zsh knows how to tab-complete.
+
+
Zsh ships with a framework for getting information from version control systems, called vcs_info.
+To include the branch name in the prompt on the right side, add these lines to your ~/.zshrc file:
+
+
+
autoload -Uz vcs_info
+precmd_vcs_info() { vcs_info }
+precmd_functions+=( precmd_vcs_info )
+setopt prompt_subst
+RPROMPT=\$vcs_info_msg_0_
+# PROMPT=\$vcs_info_msg_0_'%# '
+zstyle ':vcs_info:git:*' formats '%b'
+
+
+
This results in a display of the current branch on the right-hand side of the terminal window, whenever your shell is inside a Git repository.
+(The left side is supported as well, of course; just uncomment the assignment to PROMPT.)
+It looks a bit like this:
+
+
+
}}" alt="Customized `zsh` prompt.">
+
+
نمودار 164. Customized zsh prompt.
+
+
Zsh is powerful enough that there are entire frameworks dedicated to making it better.
+One of them is called "oh-my-zsh", and it can be found at https://github.com/robbyrussell/oh-my-zsh.
+oh-my-zsh’s plugin system comes with powerful git tab-completion, and it has a variety of prompt "themes", many of which display version-control data.
+An example of an oh-my-zsh theme. is just one example of what can be done with this system.
+
+
+
}}" alt="An example of an oh-my-zsh theme.">
+
+
نمودار 165. An example of an oh-my-zsh theme.
+
If you read through the whole book, you’ve learned a lot about how to use Git at the command line.
+You can work with local files, connect your repository to others over a network, and work effectively with others.
+But the story doesn’t end there; Git is usually used as part of a larger ecosystem, and the terminal isn’t always the best way to work with it.
+Now we’ll take a look at some of the other kinds of environments where Git can be useful, and how other applications (including yours) work alongside Git.
+Graphical Interfaces
+
+
+Git’s native environment is in the terminal.
+New features show up there first, and only at the command line is the full power of Git completely at your disposal.
+But plain text isn’t the best choice for all tasks; sometimes a visual representation is what you need, and some users are much more comfortable with a point-and-click interface.
+
+
It’s important to note that different interfaces are tailored for different workflows.
+Some clients expose only a carefully curated subset of Git functionality, in order to support a specific way of working that the author considers effective.
+When viewed in this light, none of these tools can be called “better” than any of the others, they’re simply more fit for their intended purpose.
+Also note that there’s nothing these graphical clients can do that the command-line client can’t; the command-line is still where you’ll have the most power and control when working with your repositories.
+
+
+gitk and git-gui
+
+
+
+When you install Git, you also get its visual tools, gitk and git-gui.
+
+
+
gitk is a graphical history viewer.
+Think of it like a powerful GUI shell over git log and git grep.
+This is the tool to use when you’re trying to find something that happened in the past, or visualize your project’s history.
+
+
+
Gitk is easiest to invoke from the command-line.
+Just cd into a Git repository, and type:
+
+
+
+
$ gitk [git log options]
+
+
+
+
Gitk accepts many command-line options, most of which are passed through to the underlying git log action.
+Probably one of the most useful is the --all flag, which tells gitk to show commits reachable from any ref, not just HEAD.
+Gitk’s interface looks like this:
+
+
+
+
}}" alt="The `gitk` history viewer.">
+
+
نمودار 153. The gitk history viewer.
+
+
+
On the top is something that looks a bit like the output of git log --graph; each dot represents a commit, the lines represent parent relationships, and refs are shown as colored boxes.
+The yellow dot represents HEAD, and the red dot represents changes that are yet to become a commit.
+At the bottom is a view of the selected commit; the comments and patch on the left, and a summary view on the right.
+In between is a collection of controls used for searching history.
+
+
+
git-gui, on the other hand, is primarily a tool for crafting commits.
+It, too, is easiest to invoke from the command line:
+
+
+
+
And it looks something like this:
+
+
+
+
}}" alt="The `git-gui` commit tool.">
+
+
نمودار 154. The git-gui commit tool.
+
+
+
On the left is the index; unstaged changes are on top, staged changes on the bottom.
+You can move entire files between the two states by clicking on their icons, or you can select a file for viewing by clicking on its name.
+
+
+
At top right is the diff view, which shows the changes for the currently-selected file.
+You can stage individual hunks (or individual lines) by right-clicking in this area.
+
+
+
At the bottom right is the message and action area.
+Type your message into the text box and click “Commit” to do something similar to git commit.
+You can also choose to amend the last commit by choosing the “Amend” radio button, which will update the “Staged Changes” area with the contents of the last commit.
+Then you can simply stage or unstage some changes, alter the commit message, and click “Commit” again to replace the old commit with a new one.
+
+
+
gitk and git-gui are examples of task-oriented tools.
+Each of them is tailored for a specific purpose (viewing history and creating commits, respectively), and omit the features not necessary for that task.
+
+
+
GitHub for macOS and Windows
+
+
+GitHub has created two workflow-oriented Git clients: one for Windows, and one for macOS.
+These clients are a good example of workflow-oriented tools – rather than expose all of Git’s functionality, they instead focus on a curated set of commonly-used features that work well together.
+They look like this:
+
+
+
+
}}" alt="GitHub for macOS.">
+
+
نمودار 155. GitHub for macOS.
+
+
+
+
}}" alt="GitHub for Windows.">
+
+
نمودار 156. GitHub for Windows.
+
+
+
They are designed to look and work very much alike, so we’ll treat them like a single product in this chapter.
+We won’t be doing a detailed rundown of these tools (they have their own documentation), but a quick tour of the “changes” view (which is where you’ll spend most of your time) is in order.
+
+
+
+-
+
On the left is the list of repositories the client is tracking; you can add a repository (either by cloning or attaching locally) by clicking the “+” icon at the top of this area.
+
+-
+
In the center is a commit-input area, which lets you input a commit message, and select which files should be included.
+(On Windows, the commit history is displayed directly below this; on macOS, it’s on a separate tab.)
+
+-
+
On the right is a diff view, which shows what’s changed in your working directory, or which changes were included in the selected commit.
+
+-
+
The last thing to notice is the “Sync” button at the top-right, which is the primary way you interact over the network.
+
+
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ You don’t need a GitHub account to use these tools.
+While they’re designed to highlight GitHub’s service and recommended workflow, they will happily work with any repository, and do network operations with any Git host.
+ |
+
+
+
+
+
Installation
+
+
GitHub for Windows can be downloaded from https://windows.github.com, and GitHub for macOS from https://mac.github.com.
+When the applications are first run, they walk you through all the first-time Git setup, such as configuring your name and email address, and both set up sane defaults for many common configuration options, such as credential caches and CRLF behavior.
+
+
+
Both are “evergreen” – updates are downloaded and installed in the background while the applications are open.
+This helpfully includes a bundled version of Git, which means you probably won’t have to worry about manually updating it again.
+On Windows, the client includes a shortcut to launch PowerShell with Posh-git, which we’ll talk more about later in this chapter.
+
+
+
The next step is to give the tool some repositories to work with.
+The client shows you a list of the repositories you have access to on GitHub, and can clone them in one step.
+If you already have a local repository, just drag its directory from the Finder or Windows Explorer into the GitHub client window, and it will be included in the list of repositories on the left.
+
+
+
+
Recommended Workflow
+
+
Once it’s installed and configured, you can use the GitHub client for many common Git tasks.
+The intended workflow for this tool is sometimes called the “GitHub Flow.”
+We cover this in more detail in The GitHub Flow, but the general gist is that (a) you’ll be committing to a branch, and (b) you’ll be syncing up with a remote repository fairly regularly.
+
+
+
Branch management is one of the areas where the two tools diverge.
+On macOS, there’s a button at the top of the window for creating a new branch:
+
+
+
+
}}" alt="``Create Branch'' button on macOS.">
+
+
نمودار 157. “Create Branch” button on macOS.
+
+
+
On Windows, this is done by typing the new branch’s name in the branch-switching widget:
+
+
+
+
}}" alt="Creating a branch on Windows.">
+
+
نمودار 158. Creating a branch on Windows.
+
+
+
Once your branch is created, making new commits is fairly straightforward.
+Make some changes in your working directory, and when you switch to the GitHub client window, it will show you which files changed.
+Enter a commit message, select the files you’d like to include, and click the “Commit” button (ctrl-enter or ⌘-enter).
+
+
+
The main way you interact with other repositories over the network is through the “Sync” feature.
+Git internally has separate operations for pushing, fetching, merging, and rebasing, but the GitHub clients collapse all of these into one multi-step feature.
+Here’s what happens when you click the Sync button:
+
+
+
+-
+
git pull --rebase.
+If this fails because of a merge conflict, fall back to git pull --no-rebase.
+
+-
+
git push.
+
+
+
+
+
This is the most common sequence of network commands when working in this style, so squashing them into one command saves a lot of time.
+
+
+
+
Summary
+
+
These tools are very well-suited for the workflow they’re designed for.
+Developers and non-developers alike can be collaborating on a project within minutes, and many of the best practices for this kind of workflow are baked into the tools.
+However, if your workflow is different, or you want more control over how and when network operations are done, we recommend you use another client or the command line.
+
+
+
Summary
+
+
You’ve learned how to harness Git’s power from inside the tools that you use during your everyday work, and also how to access Git repositories from your own programs.
+
If your application is for developers, chances are good that it could benefit from integration with source control.
+Even non-developer applications, such as document editors, could potentially benefit from version-control features, and Git’s model works very well for many different scenarios.
If you need to integrate Git with your application, you have essentially two options: spawn a shell and call the git command-line program, or embed a Git library into your application.
+Here we’ll cover command-line integration and several of the most popular embeddable Git libraries.
+Command-line Git
+
+
One option is to spawn a shell process and use the Git command-line tool to do the work.
+This has the benefit of being canonical, and all of Git’s features are supported.
+This also happens to be fairly easy, as most runtime environments have a relatively simple facility for invoking a process with command-line arguments.
+However, this approach does have some downsides.
+
+
One is that all the output is in plain text.
+This means that you’ll have to parse Git’s occasionally-changing output format to read progress and result information, which can be inefficient and error-prone.
+
+
Another is the lack of error recovery.
+If a repository is corrupted somehow, or the user has a malformed configuration value, Git will simply refuse to perform many operations.
+
+
Yet another is process management.
+Git requires you to maintain a shell environment on a separate process, which can add unwanted complexity.
+Trying to coordinate many of these processes (especially when potentially accessing the same repository from several processes) can be quite a challenge.
+
Dulwich
+
+
+There is also a pure-Python Git implementation - Dulwich.
+The project is hosted under https://www.dulwich.io/
+It aims to provide an interface to git repositories (both local and remote) that doesn’t call out to git directly but instead uses pure Python.
+It has an optional C extensions though, that significantly improve the performance.
+
+
Dulwich follows git design and separate two basic levels of API: plumbing and porcelain.
+
+
Here is an example of using the lower level API to access the commit message of the last commit:
+
+
+
from dulwich.repo import Repo
+r = Repo('.')
+r.head()
+# '57fbe010446356833a6ad1600059d80b1e731e15'
+
+c = r[r.head()]
+c
+# <Commit 015fc1267258458901a94d228e39f0a378370466>
+
+c.message
+# 'Add note about encoding.\n'
+
+
+
To print a commit log using high-level porcelain API, one can use:
+
+
+
from dulwich import porcelain
+porcelain.log('.', max_entries=1)
+
+#commit: 57fbe010446356833a6ad1600059d80b1e731e15
+#Author: Jelmer Vernooij <jelmer@jelmer.uk>
+#Date: Sat Apr 29 2017 23:57:34 +0000
+
+
JGit
+
+
+If you want to use Git from within a Java program, there is a fully featured Git library called JGit.
+JGit is a relatively full-featured implementation of Git written natively in Java, and is widely used in the Java community.
+The JGit project is under the Eclipse umbrella, and its home can be found at https://www.eclipse.org/jgit/.
+
+
Getting Set Up
+
+
There are a number of ways to connect your project with JGit and start writing code against it.
+Probably the easiest is to use Maven – the integration is accomplished by adding the following snippet to the <dependencies> tag in your pom.xml file:
+
+
+
+
<dependency>
+ <groupId>org.eclipse.jgit</groupId>
+ <artifactId>org.eclipse.jgit</artifactId>
+ <version>3.5.0.201409260305-r</version>
+</dependency>
+
+
+
+
+
If you would rather manage the binary dependencies yourself, pre-built JGit binaries are available from https://www.eclipse.org/jgit/download.
+You can build them into your project by running a command like this:
+
+
+
+
javac -cp .:org.eclipse.jgit-3.5.0.201409260305-r.jar App.java
+java -cp .:org.eclipse.jgit-3.5.0.201409260305-r.jar App
+
+
+
+
Plumbing
+
+
JGit has two basic levels of API: plumbing and porcelain.
+The terminology for these comes from Git itself, and JGit is divided into roughly the same kinds of areas: porcelain APIs are a friendly front-end for common user-level actions (the sorts of things a normal user would use the Git command-line tool for), while the plumbing APIs are for interacting with low-level repository objects directly.
+
+
+
The starting point for most JGit sessions is the Repository class, and the first thing you’ll want to do is create an instance of it.
+For a filesystem-based repository (yes, JGit allows for other storage models), this is accomplished using FileRepositoryBuilder:
+
+
+
+
// Create a new repository
+Repository newlyCreatedRepo = FileRepositoryBuilder.create(
+ new File("/tmp/new_repo/.git"));
+newlyCreatedRepo.create();
+
+// Open an existing repository
+Repository existingRepo = new FileRepositoryBuilder()
+ .setGitDir(new File("my_repo/.git"))
+ .build();
+
+
+
+
The builder has a fluent API for providing all the things it needs to find a Git repository, whether or not your program knows exactly where it’s located.
+It can use environment variables (.readEnvironment()), start from a place in the working directory and search (.setWorkTree(…).findGitDir()), or just open a known .git directory as above.
+
+
+
Once you have a Repository instance, you can do all sorts of things with it.
+Here’s a quick sampling:
+
+
+
+
// Get a reference
+Ref master = repo.getRef("master");
+
+// Get the object the reference points to
+ObjectId masterTip = master.getObjectId();
+
+// Rev-parse
+ObjectId obj = repo.resolve("HEAD^{tree}");
+
+// Load raw object contents
+ObjectLoader loader = repo.open(masterTip);
+loader.copyTo(System.out);
+
+// Create a branch
+RefUpdate createBranch1 = repo.updateRef("refs/heads/branch1");
+createBranch1.setNewObjectId(masterTip);
+createBranch1.update();
+
+// Delete a branch
+RefUpdate deleteBranch1 = repo.updateRef("refs/heads/branch1");
+deleteBranch1.setForceUpdate(true);
+deleteBranch1.delete();
+
+// Config
+Config cfg = repo.getConfig();
+String name = cfg.getString("user", null, "name");
+
+
+
+
There’s quite a bit going on here, so let’s go through it one section at a time.
+
+
+
The first line gets a pointer to the master reference.
+JGit automatically grabs the actual master ref, which lives at refs/heads/master, and returns an object that lets you fetch information about the reference.
+You can get the name (.getName()), and either the target object of a direct reference (.getObjectId()) or the reference pointed to by a symbolic ref (.getTarget()).
+Ref objects are also used to represent tag refs and objects, so you can ask if the tag is “peeled,” meaning that it points to the final target of a (potentially long) string of tag objects.
+
+
+
The second line gets the target of the master reference, which is returned as an ObjectId instance.
+ObjectId represents the SHA-1 hash of an object, which might or might not exist in Git’s object database.
+The third line is similar, but shows how JGit handles the rev-parse syntax (for more on this, see Branch References); you can pass any object specifier that Git understands, and JGit will return either a valid ObjectId for that object, or null.
+
+
+
The next two lines show how to load the raw contents of an object.
+In this example, we call ObjectLoader.copyTo() to stream the contents of the object directly to stdout, but ObjectLoader also has methods to read the type and size of an object, as well as return it as a byte array.
+For large objects (where .isLarge() returns true), you can call .openStream() to get an InputStream-like object that can read the raw object data without pulling it all into memory at once.
+
+
+
The next few lines show what it takes to create a new branch.
+We create a RefUpdate instance, configure some parameters, and call .update() to trigger the change.
+Directly following this is the code to delete that same branch.
+Note that .setForceUpdate(true) is required for this to work; otherwise the .delete() call will return REJECTED, and nothing will happen.
+
+
+
The last example shows how to fetch the user.name value from the Git configuration files.
+This Config instance uses the repository we opened earlier for local configuration, but will automatically detect the global and system configuration files and read values from them as well.
+
+
+
This is only a small sampling of the full plumbing API; there are many more methods and classes available.
+Also not shown here is the way JGit handles errors, which is through the use of exceptions.
+JGit APIs sometimes throw standard Java exceptions (such as IOException), but there are a host of JGit-specific exception types that are provided as well (such as NoRemoteRepositoryException, CorruptObjectException, and NoMergeBaseException).
+
+
+
Porcelain
+
+
The plumbing APIs are rather complete, but it can be cumbersome to string them together to achieve common goals, like adding a file to the index, or making a new commit.
+JGit provides a higher-level set of APIs to help out with this, and the entry point to these APIs is the Git class:
+
+
+
+
Repository repo;
+// construct repo...
+Git git = new Git(repo);
+
+
+
+
The Git class has a nice set of high-level builder-style methods that can be used to construct some pretty complex behavior.
+Let’s take a look at an example – doing something like git ls-remote:
+
+
+
+
CredentialsProvider cp = new UsernamePasswordCredentialsProvider("username", "p4ssw0rd");
+Collection<Ref> remoteRefs = git.lsRemote()
+ .setCredentialsProvider(cp)
+ .setRemote("origin")
+ .setTags(true)
+ .setHeads(false)
+ .call();
+for (Ref ref : remoteRefs) {
+ System.out.println(ref.getName() + " -> " + ref.getObjectId().name());
+}
+
+
+
+
This is a common pattern with the Git class; the methods return a command object that lets you chain method calls to set parameters, which are executed when you call .call().
+In this case, we’re asking the origin remote for tags, but not heads.
+Also notice the use of a CredentialsProvider object for authentication.
+
+
+
Many other commands are available through the Git class, including but not limited to add, blame, commit, clean, push, rebase, revert, and reset.
+
+
+
Further Reading
+
+
This is only a small sampling of JGit’s full capabilities.
+If you’re interested and want to learn more, here’s where to look for information and inspiration:
+
+
+
Libgit2
+
+
+Another option at your disposal is to use Libgit2.
+Libgit2 is a dependency-free implementation of Git, with a focus on having a nice API for use within other programs.
+You can find it at https://libgit2.org.
+
+
First, let’s take a look at what the C API looks like.
+Here’s a whirlwind tour:
+
+
+
// Open a repository
+git_repository *repo;
+int error = git_repository_open(&repo, "/path/to/repository");
+
+// Dereference HEAD to a commit
+git_object *head_commit;
+error = git_revparse_single(&head_commit, repo, "HEAD^{commit}");
+git_commit *commit = (git_commit*)head_commit;
+
+// Print some of the commit's properties
+printf("%s", git_commit_message(commit));
+const git_signature *author = git_commit_author(commit);
+printf("%s <%s>\n", author->name, author->email);
+const git_oid *tree_id = git_commit_tree_id(commit);
+
+// Cleanup
+git_commit_free(commit);
+git_repository_free(repo);
+
+
+
The first couple of lines open a Git repository.
+The git_repository type represents a handle to a repository with a cache in memory.
+This is the simplest method, for when you know the exact path to a repository’s working directory or .git folder.
+There’s also the git_repository_open_ext which includes options for searching, git_clone and friends for making a local clone of a remote repository, and git_repository_init for creating an entirely new repository.
+
+
The second chunk of code uses rev-parse syntax (see Branch References for more on this) to get the commit that HEAD eventually points to.
+The type returned is a git_object pointer, which represents something that exists in the Git object database for a repository.
+git_object is actually a “parent” type for several different kinds of objects; the memory layout for each of the “child” types is the same as for git_object, so you can safely cast to the right one.
+In this case, git_object_type(commit) would return GIT_OBJ_COMMIT, so it’s safe to cast to a git_commit pointer.
+
+
The next chunk shows how to access the commit’s properties.
+The last line here uses a git_oid type; this is Libgit2’s representation for a SHA-1 hash.
+
+
From this sample, a couple of patterns have started to emerge:
+
+
+-
+
If you declare a pointer and pass a reference to it into a Libgit2 call, that call will probably return an integer error code.
+A 0 value indicates success; anything less is an error.
+
+-
+
If Libgit2 populates a pointer for you, you’re responsible for freeing it.
+
+-
+
If Libgit2 returns a const pointer from a call, you don’t have to free it, but it will become invalid when the object it belongs to is freed.
+
+-
+
Writing C is a bit painful.
+
+
+
+
+That last one means it isn’t very probable that you’ll be writing C when using Libgit2.
+Fortunately, there are a number of language-specific bindings available that make it fairly easy to work with Git repositories from your specific language and environment.
+Let’s take a look at the above example written using the Ruby bindings for Libgit2, which are named Rugged, and can be found at https://github.com/libgit2/rugged.
+
+
+
repo = Rugged::Repository.new('path/to/repository')
+commit = repo.head.target
+puts commit.message
+puts "#{commit.author[:name]} <#{commit.author[:email]}>"
+tree = commit.tree
+
+
+
As you can see, the code is much less cluttered.
+Firstly, Rugged uses exceptions; it can raise things like ConfigError or ObjectError to signal error conditions.
+Secondly, there’s no explicit freeing of resources, since Ruby is garbage-collected.
+Let’s take a look at a slightly more complicated example: crafting a commit from scratch
+
+
+
blob_id = repo.write("Blob contents", :blob) # (1)
+
+index = repo.index
+index.read_tree(repo.head.target.tree)
+index.add(:path => 'newfile.txt', :oid => blob_id) # (2)
+
+sig = {
+ :email => "bob@example.com",
+ :name => "Bob User",
+ :time => Time.now,
+}
+
+commit_id = Rugged::Commit.create(repo,
+ :tree => index.write_tree(repo), # (3)
+ :author => sig,
+ :committer => sig, # (4)
+ :message => "Add newfile.txt", # (5)
+ :parents => repo.empty? ? [] : [ repo.head.target ].compact, # (6)
+ :update_ref => 'HEAD', # (7)
+)
+commit = repo.lookup(commit_id) # (8)
+
+
+
+-
+
Create a new blob, which contains the contents of a new file.
+
+-
+
Populate the index with the head commit’s tree, and add the new file at the path newfile.txt.
+
+-
+
This creates a new tree in the ODB, and uses it for the new commit.
+
+-
+
We use the same signature for both the author and committer fields.
+
+-
+
The commit message.
+
+-
+
When creating a commit, you have to specify the new commit’s parents.
+This uses the tip of HEAD for the single parent.
+
+-
+
Rugged (and Libgit2) can optionally update a reference when making a commit.
+
+-
+
The return value is the SHA-1 hash of a new commit object, which you can then use to get a Commit object.
+
+
+
+
The Ruby code is nice and clean, but since Libgit2 is doing the heavy lifting, this code will run pretty fast, too.
+If you’re not a rubyist, we touch on some other bindings in Other Bindings.
+
+
Advanced Functionality
+
+
Libgit2 has a couple of capabilities that are outside the scope of core Git.
+One example is pluggability: Libgit2 allows you to provide custom “backends” for several types of operation, so you can store things in a different way than stock Git does.
+Libgit2 allows custom backends for configuration, ref storage, and the object database, among other things.
+
+
+
Let’s take a look at how this works.
+The code below is borrowed from the set of backend examples provided by the Libgit2 team (which can be found at https://github.com/libgit2/libgit2-backends).
+Here’s how a custom backend for the object database is set up:
+
+
+
+
git_odb *odb;
+int error = git_odb_new(&odb); // (1)
+
+git_odb_backend *my_backend;
+error = git_odb_backend_mine(&my_backend, /*…*/); // (2)
+
+error = git_odb_add_backend(odb, my_backend, 1); // (3)
+
+git_repository *repo;
+error = git_repository_open(&repo, "some-path");
+error = git_repository_set_odb(repo, odb); // (4)
+
+
+
+
(Note that errors are captured, but not handled. We hope your code is better than ours.)
+
+
+
+-
+
Initialize an empty object database (ODB) “frontend,” which will act as a container for the “backends” which are the ones doing the real work.
+
+-
+
Initialize a custom ODB backend.
+
+-
+
Add the backend to the frontend.
+
+-
+
Open a repository, and set it to use our ODB to look up objects.
+
+
+
+
+
But what is this git_odb_backend_mine thing?
+Well, that’s the constructor for your own ODB implementation, and you can do whatever you want in there, so long as you fill in the git_odb_backend structure properly.
+Here’s what it could look like:
+
+
+
+
typedef struct {
+ git_odb_backend parent;
+
+ // Some other stuff
+ void *custom_context;
+} my_backend_struct;
+
+int git_odb_backend_mine(git_odb_backend **backend_out, /*…*/)
+{
+ my_backend_struct *backend;
+
+ backend = calloc(1, sizeof (my_backend_struct));
+
+ backend->custom_context = …;
+
+ backend->parent.read = &my_backend__read;
+ backend->parent.read_prefix = &my_backend__read_prefix;
+ backend->parent.read_header = &my_backend__read_header;
+ // …
+
+ *backend_out = (git_odb_backend *) backend;
+
+ return GIT_SUCCESS;
+}
+
+
+
+
The subtlest constraint here is that my_backend_struct's first member must be a git_odb_backend structure; this ensures that the memory layout is what the Libgit2 code expects it to be.
+The rest of it is arbitrary; this structure can be as large or small as you need it to be.
+
+
+
The initialization function allocates some memory for the structure, sets up the custom context, and then fills in the members of the parent structure that it supports.
+Take a look at the include/git2/sys/odb_backend.h file in the Libgit2 source for a complete set of call signatures; your particular use case will help determine which of these you’ll want to support.
+
+
+
Other Bindings
+
+
Libgit2 has bindings for many languages.
+Here we show a small example using a few of the more complete bindings packages as of this writing; libraries exist for many other languages, including C++, Go, Node.js, Erlang, and the JVM, all in various stages of maturity.
+The official collection of bindings can be found by browsing the repositories at https://github.com/libgit2.
+The code we’ll write will return the commit message from the commit eventually pointed to by HEAD (sort of like git log -1).
+
+
+
LibGit2Sharp
+
+
+If you’re writing a .NET or Mono application, LibGit2Sharp (https://github.com/libgit2/libgit2sharp) is what you’re looking for.
+The bindings are written in C#, and great care has been taken to wrap the raw Libgit2 calls with native-feeling CLR APIs.
+Here’s what our example program looks like:
+
+
+
+
new Repository(@"C:\path\to\repo").Head.Tip.Message;
+
+
+
+
For desktop Windows applications, there’s even a NuGet package that will help you get started quickly.
+
+
+
+
objective-git
+
+
+If your application is running on an Apple platform, you’re likely using Objective-C as your implementation language.
+Objective-Git (https://github.com/libgit2/objective-git) is the name of the Libgit2 bindings for that environment.
+The example program looks like this:
+
+
+
+
GTRepository *repo =
+ [[GTRepository alloc] initWithURL:[NSURL fileURLWithPath: @"/path/to/repo"] error:NULL];
+NSString *msg = [[[repo headReferenceWithError:NULL] resolvedTarget] message];
+
+
+
+
Objective-git is fully interoperable with Swift, so don’t fear if you’ve left Objective-C behind.
+
+
+
+
pygit2
+
+
+The bindings for Libgit2 in Python are called Pygit2, and can be found at https://www.pygit2.org.
+Our example program:
+
+
+
+
pygit2.Repository("/path/to/repo") # open repository
+ .head # get the current branch
+ .peel(pygit2.Commit) # walk down to the commit
+ .message # read the message
+
+
+
+
+
Further Reading
+
+
Of course, a full treatment of Libgit2’s capabilities is outside the scope of this book.
+If you want more information on Libgit2 itself, there’s API documentation at https://libgit2.github.com/libgit2, and a set of guides at https://libgit2.github.com/docs.
+For the other bindings, check the bundled README and tests; there are often small tutorials and pointers to further reading there.
+
+
go-git
+
+
+In case you want to integrate Git into a service written in Golang, there also is a pure Go library implementation.
+This implementation does not have any native dependencies and thus is not prone to manual memory management errors.
+It is also transparent for the standard Golang performance analysis tooling like CPU, Memory profilers, race detector, etc.
+
+
Here is a basic example of using Go APIs:
+
+
+
import "gopkg.in/src-d/go-git.v4"
+
+r, err := git.PlainClone("/tmp/foo", false, &git.CloneOptions{
+ URL: "https://github.com/src-d/go-git",
+ Progress: os.Stdout,
+})
+
+
+
As soon as you have a Repository instance, you can access information and perform mutations on it:
+
+
+
// retrieves the branch pointed by HEAD
+ref, err := r.Head()
+
+// get the commit object, pointed by ref
+commit, err := r.CommitObject(ref.Hash())
+
+// retrieves the commit history
+history, err := commit.History()
+
+// iterates over the commits and print each
+for _, c := range history {
+ fmt.Println(c)
+}
+
+
+
Advanced Functionality
+
+
go-git has few notable advanced features, one of which is a pluggable storage system, which is similar to Libgit2 backends.
+The default implementation is in-memory storage, which is very fast.
+
+
+
+
r, err := git.Clone(memory.NewStorage(), nil, &git.CloneOptions{
+ URL: "https://github.com/src-d/go-git",
+})
+
+
+
+
+
+
+
+
customClient := &http.Client{
+ Transport: &http.Transport{ // accept any certificate (might be useful for testing)
+ TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
+ },
+ Timeout: 15 * time.Second, // 15 second timeout
+ CheckRedirect: func(req *http.Request, via []*http.Request) error {
+ return http.ErrUseLastResponse // don't follow redirect
+ },
+}
+
+// Override http(s) default protocol to use our custom client
+client.InstallProtocol("https", githttp.NewClient(customClient))
+
+// Clone repository using the new client if the protocol is https://
+r, err := git.Clone(memory.NewStorage(), nil, &git.CloneOptions{URL: url})
+
+
+
Administration
+
+
If you’re administering a Git repository or need to fix something in a big way, Git provides a number of administrative commands to help you out.
+
+
git gc
+
+
The git gc command runs “garbage collection” on your repository, removing unnecessary files in your database and packing up the remaining files into a more efficient format.
+
+
+
This command normally runs in the background for you, though you can manually run it if you wish.
+We go over some examples of this in Maintenance.
+
+
+
git fsck
+
+
The git fsck command is used to check the internal database for problems or inconsistencies.
+
+
+
We only quickly use this once in Data Recovery to search for dangling objects.
+
+
+
git reflog
+
+
The git reflog command goes through a log of where all the heads of your branches have been as you work to find commits you may have lost through rewriting histories.
+
+
+
We cover this command mainly in RefLog Shortnames, where we show normal usage to and how to use git log -g to view the same information with git log output.
+
+
+
We also go through a practical example of recovering such a lost branch in Data Recovery.
+
+
+
git filter-branch
+
+
The git filter-branch command is used to rewrite loads of commits according to certain patterns, like removing a file everywhere or filtering the entire repository down to a single subdirectory for extracting a project.
+
+
+
In Removing a File from Every Commit we explain the command and explore several different options such as --commit-filter, --subdirectory-filter and --tree-filter.
+
+
+
In Git-p4 and TFS we use it to fix up imported external repositories.
+
+
Basic Snapshotting
+
+
For the basic workflow of staging content and committing it to your history, there are only a few basic commands.
+
+
git add
+
+
The git add command adds content from the working directory into the staging area (or “index”) for the next commit.
+When the git commit command is run, by default it only looks at this staging area, so git add is used to craft what exactly you would like your next commit snapshot to look like.
+
+
+
This command is an incredibly important command in Git and is mentioned or used dozens of times in this book.
+We’ll quickly cover some of the unique uses that can be found.
+
+
+
+
+
We go over using it to interactively stage only specific parts of a modified file in Interactive Staging.
+
+
+
Finally, we emulate it at a low level in Tree Objects, so you can get an idea of what it’s doing behind the scenes.
+
+
+
git status
+
+
The git status command will show you the different states of files in your working directory and staging area.
+Which files are modified and unstaged and which are staged but not yet committed.
+In its normal form, it also will show you some basic hints on how to move files between these stages.
+
+
+
We first cover status in بررسی وضعیت فایلها, both in its basic and simplified forms.
+While we use it throughout the book, pretty much everything you can do with the git status command is covered there.
+
+
+
git diff
+
+
The git diff command is used when you want to see differences between any two trees.
+This could be the difference between your working environment and your staging area (git diff by itself), between your staging area and your last commit (git diff --staged), or between two commits (git diff master branchB).
+
+
+
+
We use it to look for possible whitespace issues before committing with the --check option in راهنمای کامیت.
+
+
+
We see how to check the differences between branches more effectively with the git diff A...B syntax in تشخیص تغییرات معرفی شده.
+
+
+
We use it to filter out whitespace differences with -b and how to compare different stages of conflicted files with --theirs, --ours and --base in Advanced Merging.
+
+
+
+
+
+
The git difftool command simply launches an external tool to show you the difference between two trees in case you want to use something other than the built in git diff command.
+
+
+
+
git commit
+
+
The git commit command takes all the file contents that have been staged with git add and records a new permanent snapshot in the database and then moves the branch pointer on the current branch up to it.
+
+
+
We first cover the basics of committing in کامیت کردن تغییراتتان.
+There we also demonstrate how to use the -a flag to skip the git add step in daily workflows and how to use the -m flag to pass a commit message in on the command line instead of firing up an editor.
+
+
+
In بازگردانی کارها we cover using the --amend option to redo the most recent commit.
+
+
+
In شاخهها در یک کلمه, we go into much more detail about what git commit does and why it does it like that.
+
+
+
We looked at how to sign commits cryptographically with the -S flag in Signing Commits.
+
+
+
Finally, we take a look at what the git commit command does in the background and how it’s actually implemented in Commit Objects.
+
+
+
git reset
+
+
The git reset command is primarily used to undo things, as you can possibly tell by the verb.
+It moves around the HEAD pointer and optionally changes the index or staging area and can also optionally change the working directory if you use --hard.
+This final option makes it possible for this command to lose your work if used incorrectly, so make sure you understand it before using it.
+
+
+
+
We then cover it in quite some detail in Reset Demystified, which is entirely devoted to explaining this command.
+
+
+
We use git reset --hard to abort a merge in Aborting a Merge, where we also use git merge --abort, which is a bit of a wrapper for the git reset command.
+
+
+
git rm
+
+
The git rm command is used to remove files from the staging area and working directory for Git.
+It is similar to git add in that it stages a removal of a file for the next commit.
+
+
+
We cover the git rm command in some detail in حذف کردن فایل, including recursively removing files and only removing files from the staging area but leaving them in the working directory with --cached.
+
+
+
The only other differing use of git rm in the book is in Removing Objects where we briefly use and explain the --ignore-unmatch when running git filter-branch, which simply makes it not error out when the file we are trying to remove doesn’t exist.
+This can be useful for scripting purposes.
+
+
+
git mv
+
+
The git mv command is a thin convenience command to move a file and then run git add on the new file and git rm on the old file.
+
+
+
+
git clean
+
+
The git clean command is used to remove unwanted files from your working directory.
+This could include removing temporary build artifacts or merge conflict files.
+
+
+
Branching and Merging
+
+
There are just a handful of commands that implement most of the branching and merging functionality in Git.
+
+
git branch
+
+
The git branch command is actually something of a branch management tool.
+It can list the branches you have, create a new branch, delete branches and rename branches.
+
+
+
Most of شاخهسازی در گیت is dedicated to the branch command and it’s used throughout the entire chapter.
+We first introduce it in ساختن یک شاخه جدید and we go through most of its other features (listing and deleting) in مدیریت شاخه.
+
+
+
In پیگیری شاخهها we use the git branch -u option to set up a tracking branch.
+
+
+
Finally, we go through some of what it does in the background in Git References.
+
+
+
git checkout
+
+
The git checkout command is used to switch branches and check content out into your working directory.
+
+
+
We first encounter the command in تعویض شاخهها along with the git branch command.
+
+
+
We see how to use it to start tracking branches with the --track flag in پیگیری شاخهها.
+
+
+
+
+
Finally, we go into some implementation detail in The HEAD.
+
+
+
git merge
+
+
The git merge tool is used to merge one or more branches into the branch you have checked out.
+It will then advance the current branch to the result of the merge.
+
+
+
The git merge command was first introduced in شاخهسازی مقدماتی.
+Though it is used in various places in the book, there are very few variations of the merge command — generally just git merge <branch> with the name of the single branch you want to merge in.
+
+
+
We covered how to do a squashed merge (where Git merges the work but pretends like it’s just a new commit without recording the history of the branch you’re merging in) at the very end of پروژهٔ عمومی فورک شده.
+
+
+
We went over a lot about the merge process and command, including the -Xignore-space-change command and the --abort flag to abort a problem merge in Advanced Merging.
+
+
+
We learned how to verify signatures before merging if your project is using GPG signing in Signing Commits.
+
+
+
+
+
+
The git mergetool command simply launches an external merge helper in case you have issues with a merge in Git.
+
+
+
+
git log
+
+
The git log command is used to show the reachable recorded history of a project from the most recent commit snapshot backwards.
+By default it will only show the history of the branch you’re currently on, but can be given different or even multiple heads or branches from which to traverse.
+It is also often used to show differences between two or more branches at the commit level.
+
+
+
This command is used in nearly every chapter of the book to demonstrate the history of a project.
+
+
+
We introduce the command and cover it in some depth in دیدن تاریخچهٔ کامیتها.
+There we look at the -p and --stat option to get an idea of what was introduced in each commit and the --pretty and --oneline options to view the history more concisely, along with some simple date and author filtering options.
+
+
+
In ساختن یک شاخه جدید we use it with the --decorate option to easily visualize where our branch pointers are located and we also use the --graph option to see what divergent histories look like.
+
+
+
In تیم خصوصی کوچک and Commit Ranges we cover the branchA..branchB syntax to use the git log command to see what commits are unique to a branch relative to another branch.
+In Commit Ranges we go through this fairly extensively.
+
+
+
In Merge Log and Triple Dot we cover using the branchA...branchB format and the --left-right syntax to see what is in one branch or the other but not in both.
+In Merge Log we also look at how to use the --merge option to help with merge conflict debugging as well as using the --cc option to look at merge commit conflicts in your history.
+
+
+
In RefLog Shortnames we use the -g option to view the Git reflog through this tool instead of doing branch traversal.
+
+
+
In Searching we look at using the -S and -L options to do fairly sophisticated searches for something that happened historically in the code such as seeing the history of a function.
+
+
+
In Signing Commits we see how to use --show-signature to add a validation string to each commit in the git log output based on if it was validly signed or not.
+
+
+
git stash
+
+
The git stash command is used to temporarily store uncommitted work in order to clean out your working directory without having to commit unfinished work on a branch.
+
+
+
+
git tag
+
+
The git tag command is used to give a permanent bookmark to a specific point in the code history.
+Generally this is used for things like releases.
+
+
+
+
We also cover how to create a GPG signed tag with the -s flag and verify one with the -v flag in Signing Your Work.
+
+
Debugging
+
+
Git has a couple of commands that are used to help debug an issue in your code.
+This ranges from figuring out where something was introduced to figuring out who introduced it.
+
+
git bisect
+
+
The git bisect tool is an incredibly helpful debugging tool used to find which specific commit was the first one to introduce a bug or problem by doing an automatic binary search.
+
+
+
It is fully covered in Binary Search and is only mentioned in that section.
+
+
+
git blame
+
+
The git blame command annotates the lines of any file with which commit was the last one to introduce a change to each line of the file and what person authored that commit.
+This is helpful in order to find the person to ask for more information about a specific section of your code.
+
+
+
+
git grep
+
+
The git grep command can help you find any string or regular expression in any of the files in your source code, even older versions of your project.
+
+
+
It is covered in Git Grep and is only mentioned in that section.
+
+
Email
+
+
Many Git projects, including Git itself, are entirely maintained over mailing lists.
+Git has a number of tools built into it that help make this process easier, from generating patches you can easily email to applying those patches from an email box.
+
+
git apply
+
+
The git apply command applies a patch created with the git diff or even GNU diff command.
+It is similar to what the patch command might do with a few small differences.
+
+
+
We demonstrate using it and the circumstances in which you might do so in اعمال وصله از ایمیل.
+
+
+
git am
+
+
The git am command is used to apply patches from an email inbox, specifically one that is mbox formatted.
+This is useful for receiving patches over email and applying them to your project easily.
+
+
+
We covered usage and workflow around git am in اعمال وصله با am including using the --resolved, -i and -3 options.
+
+
+
There are also a number of hooks you can use to help with the workflow around git am and they are all covered in Email Workflow Hooks.
+
+
+
+
+
+
The git format-patch command is used to generate a series of patches in mbox format that you can use to send to a mailing list properly formatted.
+
+
+
+
git imap-send
+
+
The git imap-send command uploads a mailbox generated with git format-patch into an IMAP drafts folder.
+
+
+
We go through an example of contributing to a project by sending patches with the git imap-send tool in پروژههای عمومی روی ایمیل.
+
+
+
git send-email
+
+
The git send-email command is used to send patches that are generated with git format-patch over email.
+
+
+
We go through an example of contributing to a project by sending patches with the git send-email tool in پروژههای عمومی روی ایمیل.
+
+
+
git request-pull
+
+
The git request-pull command is simply used to generate an example message body to email to someone.
+If you have a branch on a public server and want to let someone know how to integrate those changes without sending the patches over email, you can run this command and send the output to the person you want to pull the changes in.
+
+
+
External Systems
+
+
Git comes with a few commands to integrate with other version control systems.
+
+
git svn
+
+
The git svn command is used to communicate with the Subversion version control system as a client.
+This means you can use Git to checkout from and commit to a Subversion server.
+
+
+
+
git fast-import
+
+
For other version control systems or importing from nearly any format, you can use git fast-import to quickly map the other format to something Git can easily record.
+
+
+
Getting and Creating Projects
+
+
There are two ways to get a Git repository.
+One is to copy it from an existing repository on the network or elsewhere and the other is to create a new one in an existing directory.
+
+
git init
+
+
To take a directory and turn it into a new Git repository so you can start version controlling it, you can simply run git init.
+
+
+
We first introduce this in دستیابی به یک مخزن گیت, where we show creating a brand new repository to start working with.
+
+
+
We talk briefly about how you can change the default branch name from “master” in شاخههای ریموت.
+
+
+
+
Finally, we go through some of the details of what it actually does behind the scenes in Plumbing and Porcelain.
+
+
+
git clone
+
+
The git clone command is actually something of a wrapper around several other commands.
+It creates a new directory, goes into it and runs git init to make it an empty Git repository, adds a remote (git remote add) to the URL that you pass it (by default named origin), runs a git fetch from that remote repository and then checks out the latest commit into your working directory with git checkout.
+
+
+
The git clone command is used in dozens of places throughout the book, but we’ll just list a few interesting places.
+
+
+
+
In راهاندازی گیت در سرور we look at using the --bare option to create a copy of a Git repository with no working directory.
+
+
+
In Bundling we use it to unbundle a bundled Git repository.
+
+
+
+
Though it’s used in many other places through the book, these are the ones that are somewhat unique or where it is used in ways that are a little different.
+
+
Inspection and Comparison
+
+
git show
+
+
The git show command can show a Git object in a simple and human readable way.
+Normally you would use this to show the information about a tag or a commit.
+
+
+
+
Later we use it quite a bit in Revision Selection to show the commits that our various revision selections resolve to.
+
+
+
One of the more interesting things we do with git show is in Manual File Re-merging to extract specific file contents of various stages during a merge conflict.
+
+
+
git shortlog
+
+
The git shortlog command is used to summarize the output of git log.
+It will take many of the same options that the git log command will but instead of listing out all of the commits it will present a summary of the commits grouped by author.
+
+
+
We showed how to use it to create a nice changelog in شورتلاگ.
+
+
+
git describe
+
+
The git describe command is used to take anything that resolves to a commit and produces a string that is somewhat human-readable and will not change.
+It’s a way to get a description of a commit that is as unambiguous as a commit SHA-1 but more understandable.
+
+
+
Patching
+
+
A few commands in Git are centered around the concept of thinking of commits in terms of the changes they introduce, as though the commit series is a series of patches.
+These commands help you manage your branches in this manner.
+
+
git cherry-pick
+
+
The git cherry-pick command is used to take the change introduced in a single Git commit and try to re-introduce it as a new commit on the branch you’re currently on.
+This can be useful to only take one or two commits from a branch individually rather than merging in the branch which takes all the changes.
+
+
+
+
git rebase
+
+
The git rebase command is basically an automated cherry-pick.
+It determines a series of commits and then cherry-picks them one by one in the same order somewhere else.
+
+
+
Rebasing is covered in detail in ریبیسکردن, including covering the collaborative issues involved with rebasing branches that are already public.
+
+
+
We use it in practice during an example of splitting your history into two separate repositories in Replace, using the --onto flag as well.
+
+
+
We go through running into a merge conflict during rebasing in Rerere.
+
+
+
+
git revert
+
+
The git revert command is essentially a reverse git cherry-pick.
+It creates a new commit that applies the exact opposite of the change introduced in the commit you’re targeting, essentially undoing or reverting it.
+
+
+
Plumbing Commands
+
+
There were also quite a number of lower level plumbing commands that we encountered in the book.
+
+
The first one we encounter is ls-remote in Pull Request Refs which we use to look at the raw references on the server.
+
+
We also mention rev-parse in Branch References to take just about any string and turn it into an object SHA-1.
+
+
However, most of the low level plumbing commands we cover are in Git Internals, which is more or less what the chapter is focused on.
+We tried to avoid use of them throughout most of the rest of the book.
+
Throughout the book we have introduced dozens of Git commands and have tried hard to introduce them within something of a narrative, adding more commands to the story slowly.
+However, this leaves us with examples of usage of the commands somewhat scattered throughout the whole book.
In this appendix, we’ll go through all the Git commands we addressed throughout the book, grouped roughly by what they’re used for.
+We’ll talk about what each command very generally does and then point out where in the book you can find us having used it.
+Setup and Config
+
+
There are two commands that are used quite a lot, from the first invocations of Git to common every day tweaking and referencing, the config and help commands.
+
+
git config
+
+
Git has a default way of doing hundreds of things.
+For a lot of these things, you can tell Git to default to doing them a different way, or set your preferences.
+This involves everything from telling Git what your name is to specific terminal color preferences or what editor you use.
+There are several files this command will read from and write to so you can set values globally or down to specific repositories.
+
+
+
The git config command has been used in nearly every chapter of the book.
+
+
+
In اولین راهاندازی گیت we used it to specify our name, email address and editor preference before we even got started using Git.
+
+
+
In نامهای مستعار در گیت we showed how you could use it to create shorthand commands that expand to long option sequences so you don’t have to type them every time.
+
+
+
In ریبیسکردن we used it to make --rebase the default when you run git pull.
+
+
+
+
In Keyword Expansion we showed how to set up smudge and clean filters on content coming in and out of Git.
+
+
+
+
git config core.editor commands
+
+
Accompanying the configuration instructions in ویرایشگر شما, many editors can be set as follows:
+
+
+جدول 4. Exhaustive list of core.editor configuration commands
+
+
+
+
+
+
+| Editor |
+Configuration command |
+
+
+
+
+Atom |
+git config --global core.editor "atom --wait"
|
+
+
+BBEdit (Mac, with command line tools) |
+git config --global core.editor "bbedit -w"
|
+
+
+Emacs |
+git config --global core.editor emacs
|
+
+
+Gedit (Linux) |
+git config --global core.editor "gedit --wait --new-window"
|
+
+
+Gvim (Windows 64-bit) |
+git config --global core.editor "'C:/Program Files/Vim/vim72/gvim.exe' --nofork '%*'" (Also see note below)
|
+
+
+Kate (Linux) |
+git config --global core.editor "kate"
|
+
+
+nano |
+git config --global core.editor "nano -w"
|
+
+
+Notepad (Windows 64-bit) |
+git config core.editor notepad
|
+
+
+Notepad++ (Windows 64-bit) |
+git config --global core.editor "'C:/Program Files/Notepad++/notepad++.exe' -multiInst -notabbar -nosession -noPlugin" (Also see note below)
|
+
+
+Scratch (Linux) |
+git config --global core.editor "scratch-text-editor"
|
+
+
+Sublime Text (macOS) |
+git config --global core.editor "/Applications/Sublime\ Text.app/Contents/SharedSupport/bin/subl --new-window --wait"
|
+
+
+Sublime Text (Windows 64-bit) |
+git config --global core.editor "'C:/Program Files/Sublime Text 3/sublime_text.exe' -w" (Also see note below)
|
+
+
+TextEdit (macOS) |
+git config --global --add core.editor "open -W -n"
|
+
+
+Textmate |
+git config --global core.editor "mate -w"
|
+
+
+Textpad (Windows 64-bit) |
+git config --global core.editor "'C:/Program Files/TextPad 5/TextPad.exe' -m (Also see note below)
|
+
+
+Vim |
+git config --global core.editor "vim"
|
+
+
+VS Code |
+git config --global core.editor "code --wait"
|
+
+
+WordPad |
+git config --global core.editor '"C:\Program Files\Windows NT\Accessories\wordpad.exe"'"
|
+
+
+Xi |
+git config --global core.editor "xi --wait"
|
+
+
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ If you have a 32-bit editor on a Windows 64-bit system, the program will be installed in C:\Program Files (x86)\ rather than C:\Program Files\ as in the table above.
+ |
+
+
+
+
+
git help
+
+
The git help command is used to show you all the documentation shipped with Git about any command.
+While we’re giving a rough overview of most of the more popular ones in this appendix, for a full listing of all of the possible options and flags for every command, you can always run git help <command>.
+
+
+
We introduced the git help command in کمک گرفتن and showed you how to use it to find more information about the git shell in نصب و راهاندازی سرور.
+
+
Sharing and Updating Projects
+
+
There are not very many commands in Git that access the network, nearly all of the commands operate on the local database.
+When you are ready to share your work or pull changes from elsewhere, there are a handful of commands that deal with remote repositories.
+
+
git fetch
+
+
The git fetch command communicates with a remote repository and fetches down all the information that is in that repository that is not in your current one and stores it in your local database.
+
+
+
+
+
We use it to fetch a single specific reference that is outside of the default space in Pull Request Refs and we see how to fetch from a bundle in Bundling.
+
+
+
We set up highly custom refspecs in order to make git fetch do something a little different than the default in The Refspec.
+
+
+
git pull
+
+
The git pull command is basically a combination of the git fetch and git merge commands, where Git will fetch from the remote you specify and then immediately try to merge it into the branch you’re on.
+
+
+
+
+
+
Finally, we very quickly mention that you can use the --verify-signatures option to it in order to verify that commits you are pulling have been GPG signed in Signing Commits.
+
+
+
git push
+
+
The git push command is used to communicate with another repository, calculate what your local database has that the remote one does not, and then pushes the difference into the other repository.
+It requires write access to the other repository and so normally is authenticated somehow.
+
+
+
We first look at the git push command in پوش کردن به ریموتهایتان.
+Here we cover the basics of pushing a branch to a remote repository.
+In پوشکردن we go a little deeper into pushing specific branches and in پیگیری شاخهها we see how to set up tracking branches to automatically push to.
+In پاک کردن شاخههای ریموت we use the --delete flag to delete a branch on the server with git push.
+
+
+
Throughout مشارکت در یک پروژه we see several examples of using git push to share work on branches through multiple remotes.
+
+
+
+
In Publishing Submodule Changes we use the --recurse-submodules option to check that all of our submodules work has been published before pushing the superproject, which can be really helpful when using submodules.
+
+
+
In Other Client Hooks we talk briefly about the pre-push hook, which is a script we can setup to run before a push completes to verify that it should be allowed to push.
+
+
+
Finally, in Pushing Refspecs we look at pushing with a full refspec instead of the general shortcuts that are normally used.
+This can help you be very specific about what work you wish to share.
+
+
+
git remote
+
+
The git remote command is a management tool for your record of remote repositories.
+It allows you to save long URLs as short handles, such as “origin” so you don’t have to type them out all the time.
+You can have several of these and the git remote command is used to add, change and delete them.
+
+
+
This command is covered in detail in کار با ریموتها, including listing, adding, removing and renaming them.
+
+
+
It is used in nearly every subsequent chapter in the book too, but always in the standard git remote add <name> <url> format.
+
+
+
git archive
+
+
The git archive command is used to create an archive file of a specific snapshot of the project.
+
+
+
+
git submodule
+
+
The git submodule command is used to manage external repositories within a normal repositories.
+This could be for libraries or other types of shared resources.
+The submodule command has several sub-commands (add, update, sync, etc) for managing these resources.
+
+
+
This command is only mentioned and entirely covered in Submodules.
+
+
خلاصه
+
+
حال باید در مشارکت کردن در پروژهای که تحت گیت است، همچنین در نگهداری پروژهٔ خودتان یا یکپارچهسازی مشارکتهای دیگر کاربران احساس راحتی کنید.
+تبریک که اکنون یک توسعهدهندهٔ گیت مؤثر هستید.
+در فصل بعد خواهید آموخت که چگونه از بزرگترین و محبوبترین سرویس میزبانی گیت، یعنی گیتهاب استفاده کنید.
+
+حال که یک مخزن ریموت گیت راهاندازی شده به عنوان کانونی برای تمام توسعهدهندگان دارید تا کدهایشان را روی آن به اشتراک بگذارند و شما با دستورات پایهٔ گیت در یک روند کاری محلی آشنایی دارید،
+به اینکه چگونه از گیت در جهت روندهای کاری توزیعشدهای که گیت در خدمت شما قرار میدهد استفاده کنید، میپردازیم.
در این فصل خواهید دید که چگونه به عنوان یک مشارکتکننده و یکپارچهساز از گیت در یک محیط توزیعشده استفاده کنید.
+در این مباحث، خواهید آموخت که چگونه در کد یک پروژه مشارکت موفقیتآمیز کنید و این کار را برای خود و نگهدارندهٔ پروژه تا حد امکان آسان کنید؛
+همچنین اینکه چگونه میتوان یک پروژه با تعدادی توسعهدهنده را به طور موفقیتآمیز نگهداری کنید.
+روندهای کاری توزیعشده
+
+
+برخلاف سیستمهای کنترل نسخه متمرکز (CVCS)، نفس توزیعشدهٔ گیت به شما این اجازه میدهد تا در اینکه چگونه توسعهدهندهها روی پروژهها همکاری میکنند انعطاف خیلی بیشتری داشته باشید.
+در سیستمهای متمرکز، هر توسعهدهنده یک گره فعال است که کموبیش به طور برابر با دیگران با هاب مرکزی کار میکند.
+لکن در گیت هر توسعهدهنده میتواند هم یک گره باشد هم یک هاب؛ اینگونه، هر توسعهدهنده هم میتواند در کد مخازن دیگر مشارکت کند و
+یک مخزن عمومی داشته باشد که دیگران میتوانند روی آنها کار کنند و در آن مشارکت کنند.
+این اصل طیف زیادی از روندهای کاری ممکن برای پروژه و/یا تیم شما ارائه میکند؛ به همین دلیل ما چند نمونه از آنها را بررسی خواهیم کرد تا از این انعطافپذیری نهایت استفاده را ببریم.
+به نقاط قوت و ضعف احتمالی هر طراحی خواهیم پرداخت؛ شما میتوانید یکی از این طراحیها را انتخاب کنید، یا میتوانید آنها را ترکیب کنید و از هرکدام یک ویژگی برگزینید.
+
+
روند کاری متمرکز
+
+
+در سیستمهای متمرکز، غالباً یک مدل همکاری وجود دارد — روند کاری متمرکز.
+یک هاب یا مخزن مرکزی قادر است کدها را بپذیرد و همه کار خود را با آن همگامسازی میکنند.
+تعدادی توسعهدهنده گرههای این شبکه هستند — مشتریهای هاب — و با آن نقطهٔ مرکزی همگامسازی میکنند.
+
+
+
+
}}" alt="Centralized workflow.">
+
+
نمودار 54. روند کاری متمرکز.
+
+
+
این بدان معناست که اگر دو توسعهدهنده از هاب کلون کنند و هر دو تغییراتی را اعمال کنند، اولین توسعهدهندهای که تغییرات را پوش کند، میتواند بیمشکل این کار را انجام دهد.
+اما دومین توسعهدهنده باید قبل از پوش کردن کار نفر اول را ادغام کند تا منجر به بازنویسی روی کارهای توسعهدهندهٔ اول نشوند.
+این مفهوم در گیت هم به اندازهٔ سابورژن (یا هر CVCS دیگری) برقرار است و این مدل کاری در گیت هم به طور بینقص کار میکند.
+
+
+
اگر از قبل به روند کاری متمرکز در کمپانی یا تیم خود عادت دارید، به سادگی میتوانید همان روند را ادامه دهید.
+خیلی ساده یک مخزن راهاندازی کنید، به تمام افراد تیم خود دسترسی پوش بدهید؛ گیت اجازه نخواهد داد که کاربران تغییرات یکدیگر را بازنویسی کنند.
+
+
+
فرض کنیم که جان و جسیکا هر دو در حال کار همزمان هستند.
+جان تغییرات خود را تمام میکند و آنها را روی سرور پوش میکند.
+سپس جسیکا سعی میکند که تغییرات خود را پوش کند، اما سرور آنها را رد میکند.
+به او گفته میشود که او سعی در پوش کردن تغییرات غیر fast-forward است و تا زمانی که فچ و مرج نکند، نخواهد توانست چنین کاری را انجام دهد.
+این روند کاری جذابی برای کثیری از افراد است، چرا که روشی است که خیلیها با آن احساس راحتی میکنند و با آن آشنا هستند.
+
+
+
بعلاوه، این روش به تیمهای کوچک محدود نیست.
+با مدل شاخهسازی گیت، ممکن است که صدها توسعهدهنده به طور موفقیتآمیز و همزمان به وسیلهٔ هزاران برنچ، روی یک پروژه کار کنند.
+
+
+
روند کاری مدیر-یکپارچهسازی
+
+
+از این جهت که گیت به شما اجازهٔ داشتن چندین مخزن ریموت را میدهد، این امکان وجود دارد که روند کاری داشته باشید
+که در آن هر توسعهدهنده اجازهٔ نوشتن به مخزن عمومی خودش را دارد و اجازهٔ خواندن از مخازن دیگران را دارد.
+در این سناریو معمولاً یک مخزن استاندارد و مرکزی وجود دارد که نقش پروژهٔ «رسمی» را بازی میکند.
+برای مشارکت در آن پروژه، شما کلون عمومی خود را از پروژه میسازید و تغییرات خود را به آن پوش میکنید.
+سپس میتوانید به نگهدارندهٔ پروژهٔ اصلی درخواستی ارسال کنید تا تغییرات شما را پول کند.
+نگهدارندهٔ مذکور پس از این، میتواند مخزن شما را به عنوان یک ریموت اضافه کند، تغییرات شما را به طور محلی تست کند، آنها را در برنچ خودش مرج کند و به مخزن خودش پوش کند.
+این فرآیند به صورت زیر است (روند کاری مدیر-یکپارچهسازی. را نگاه کنید):
+
+
+
+-
+
نگهدارندهٔ پروژه به مخزن عمومی پوش میکند.
+
+-
+
یک مشارکتکننده آن را کلون میکند و تغییراتی اعمال میکند.
+
+-
+
مشارکتکننده به کپی عمومی خودش پوش میکند.
+
+-
+
مشارکتکننده ایمیلی به نگهدارنده میفرستد و از او میخواهد که تغییرات را پول کند.
+
+-
+
نگهدارنده مخزن مشارکتکننده را به عنوان یک ریموت اضافه میکند به صورت محلی مرج میکند.
+
+-
+
نگدارنده مرج تغییرات را به مخزن اصلی پوش میکند.
+
+
+
+
+
+
}}" alt="Integration-manager workflow.">
+
+
نمودار 55. روند کاری مدیر-یکپارچهسازی.
+
+
+
+این روند کاری رایجی بین ابزارهای هاب-پایه مانند گیتهاب و گیتلب است، در این ابزارها فورک کردن یک پروژه و پوش کردن تغییراتتان به فورکتان جهت استفاده همه آسان است.
+یکی از اصلیترین مزیتهای این روش این است که میتوانید به کار کردن ادامه دهید و نگهدارندهٔ مخزن اصلی میتواند در هر زمانی پول کند.
+مشارکتکنندگان مجبور نیستند منتظر پروژه بمانند تا تغییرات خود را معرفی کنند — هر گروه میتواند با سرعتی که صلاح میداند کار کند.
+
+
+
روند کاری دیکتاتور و ستوانها
+
+
+این روند، نوعی روند کاری چند-مخزنی است.
+عموماًاین روش برای پروژههای بزرگ با صدها مشارکتکننده به کار میرود؛ یکی از مثالهای معروف هستهٔ لینوکس است.
+مدیران یکپارچهسازی مختلف مسئول بخشهای مختلف پروژه هستند؛ به آنها ستوان گفته میشود.
+همهٔ ستوانها یک مدیر یکپارچهسازی به نام دیکتاتور کریم دارند.
+دیکتاتور کریم از پوشهٔ خود به یک مخزن مرجع پوش میکند که همهٔ مشارکتکنندگان مستلزم پول کردن از آن هستند.
+فرآیند به این شکل کار میکند (روندکاری رهبر کریم. را ببینید):
+
+
+
+-
+
توسعهدهندگان معمولی روی برنچ موضوعی خود کار میکنند و تغییرات را به نوک master ریبیس میکنند.
+برنچ master آن برنچی از مخزن مرجع است که دیکتاتور به آن پوش میکند.
+
+-
+
ستوانها برنچهای موضوعی توسعهدهندگان را به برنچ master خود پوش میکنند.
+
+-
+
دیکتاتور برنچهای master ستوانها را با master دیکتاتور ادغام میکند.
+
+-
+
در آخر دیکتاتور به آن برنچ master در مخزن مرجع پوش میکند تا دیگر توسعهدهندگان بتوانند روی آن ریبیس کنند.
+
+
+
+
+
+
}}" alt="Benevolent dictator workflow.">
+
+
نمودار 56. روندکاری رهبر کریم.
+
+
+
این نوع روند کاری رایج نیست، اما میتواند در پروژههای بزرگ یا در محیطهای خیلی سلسله مراتبی مفید باشد.
+به رهبر پروژه (دیکتاتور) این امکان را میدهد تا بخش عظیمی از کار را واگذار کند و پیش از یکپارچهسازی کد بخشهای اعظمی از آنرا از جاهای مختلف گردآوری کند.
+
+
+
خلاصهٔ روندهای کاری
+
+
انگشت شماری روند کاری رایج وجود دارد که معمولاً با سیستم توزیعشدهای مانند گیت اجرا میشود، اما اکنون میبینید که مشتقات بسیار بیشتری قابل پیادهسازی است که میتواند با روند کاری واقعی شما تطبیق پیدا کند.
+حال که (به احتمال زیاد) میتوانید به اینکه چه ترکیبی از روندهای کاری برای شما مناسب است پی ببرید،
+چند مورد جزئیتر از اینکه «چگونه میتوان نقشهای اصلی را به نحوی ایفا کرد که روندهای مختلف را بسازند» بررسی خواهیم کرد.
+در بخش بعد، چند الگوی رایج مشارکت در یک پروژه را یاد خواهید گرفت.
+
+
مشارکت در یک پروژه
+
+
+دشواری اصلی توصیف چگونگی مشارکت در یک پروژه این است که راههای فراوانی برای انجامش وجود دارند.
+از این جهت که گیت انعطافپذیری بالایی دارد، مردم میتوانند به روشهای متفاوتی با یکدیگر کار کنند و توصیف اینکه احتمالاً شما چگونه باید مشارکت کنید مشکلساز است — هر پروژه کمی متفاوت است.
+بعضی از متغییرهای دخیل تعداد مشارکتکنندگان فعال، روند کاری انتخابی، دسترسی کامیتهای شما و احتمالاً روشهای خارجی مشارکت هستند.
+
+
اولین متغییر تعداد مشارکتکنندگان فعال است — چند نفر به طور فعال در کد این پروژه مشارکت دارند و هر چند وقت یکبار این مشارکت انجام میشود؟
+در بسیاری از موارد، شما چندین توسعهدهنده خواهید داشت که به نسبت فعالی در هر روز چند کامیت یا کمتر پروژه انجام میدهند.
+برای پروژهها یا کمپانیهای بزرگتر، شمار توسعهدهندگان ممکن است به هزار و کامیتهای ورودی به صدها هزار در روز برسد.
+این مسئلهٔ مهمی است چرا که با توسعهدهندگان بیشتر و بیشتر، دردسرهای بیشتری دارید تا اطمینان حاصل کنید که کدتان به تمیزی اعمال میشود و یا میتواند به آسانی ادغام شود.
+تا زمانی که روی چیزی کار میکردید یا مادامی که منتظر بودید تا کارتان اعمال یا تأیید شود، ممکن است تغییراتی که اعمال میکنید مازاد یا کاملاً ناکارآمد به چشم بیایند.
+چطور میتوانید دائماً کد خود را به روز و کامیتهایتان را معتبر نگه دارید؟
+
+
متغییر بعدی روند کاری مورد استفادهٔ پروژه است.
+آیا متمرکز و با توسعهدهندگانی است که همه دسترسی یکسانی به خط کد اصلی دارند؟
+آیا پروژه یک نگهدارنده یا مدیر یکپارچهسازی دارد که همهٔ پچها را چک کند؟
+آیا همهٔ پچها بازبینی و تأیید شدهاند؟
+آیا شما جزئی از این فرآیند تأیید هستید؟
+آیا سیستم ستوانی در کار است و آیا شما مجبورید ابتدا کار خود را به آنها نشان دهید؟
+
+
متغییر بعدی دسترسی به کامیت شماست.
+ بسته به اینکه شما دسترسی نوشتن به پروژه را دارید یا خیر روند کاری مورد نیاز برای مشارکت در هر پروژه بسیار متفاوت است.
+اگر دسترسی نوشتن ندارید، پروژه چه شرایطی دارد تا کار مشارکتشده را قبول کند؟ — اگر اصلاً شرایط یا سیاستی دارد.
+هر بار چه مقدار کار را به اشتراک میگذارید؟
+هر چند وقت یک بار شما مشارکت میکنید؟
+
+
تمام این سؤالها میتواند چگونگی مشارکت فعال شما به یک پروژه و اینکه چه روندهای کاری را مناسبتر یا در اختیارتان هست را تحت شعاع قرار دهند.
+ما چند جنبه از هر کدام از این موارد را در مجموعهای از یوزکیس (Use Case)ها و مثالهای از ساده به پیچیده بررسی میکنیم.
+شما باید بتوانید روند کاری خاصی که به آن احتیاج دارید را در هر کدام از این مثالها بسازید.
+
+
راهنمای کامیت
+
+
پیش از اینکه شروع به دیدن یوزکیسها کنیم، اینجا نکتهای دربارهٔ پیغام کامیت باید ذکر شود.
+داشتن راهنمای خوب برای کامیت ساختن و پایبندی به آن کار کردن با گیت و همکاری با دیگران را بسیار آسانتر میکند.
+پروژهٔ گیت سندی ارائه میکند که در آن نکات مفیدی دربارهٔ ساختن کامیتهایی که از آنها پچها را اعمال میکنید وجود دارد — شما میتوانید این سند را در سورس کد گیت در فایل Documentation/SubmittingPatches بخوانید.
+
+
+
+اول اینکه ارائهٔ شما نباید هیچ مشکلی مرتبط با فضاهای سفید داشته باشد.
+گیت برای شما راه سادهای برای چک کردن این موضوع فراهم کرده است — پیش از اینکه کامیت کنید git diff --check را اجرا کنید.
+این دستور مشکلات احتمالی فضاهای سفید را تشخیص میدهد و برای شما لیست میکند.
+
+
+
+
}}" alt="Output of `git diff --check`.">
+
+
نمودار 57. خروجی git diff --check.
+
+
+
اگر پیش از کامیت کردن آن دستور را اجرا کنید میتوانید ببینید که آیا در حال کامیت کردن ایرادات فضای سفیدی هستید که ممکن است دیگر توسعهدهندگان را آزار دهد.
+
+
+
سپس، سعی بر آن باشد که هر کامیت دستهای از تغییرات منطقاً مجزا باشد.
+اگر قادرید سعی کنید تغییراتان را قابل هضم کنید — یک آخر هفتهٔ کامل را دربارهٔ ۵ ایشوی مختلف کد نزنید و سپس همه را شنبه با یک کامیت غولآسا تحویل دهید.
+حتی اگر هم در طی آخر هفته کامیت نمیکنید، شنبه از استیج استفاده کنید تا حداقل کارتان را به یک کامیت به ازای ایشو و با یک پیغام خوب تقسیم کنید.
+اگر بعضی از تغییرات روی یک فایل انجام شده سعی کنید از git add --patch استفاده کنید تا به صورت بخش بخش فایلها را استیج کنید (با جزئیات در Interactive Staging بررسی شده).
+مادامی که همهٔ تغییرات را اضافه کردهاید، اسنپشات پروژه در نوک برنچ یکی خواهد بود، خواه ۵ کامیت کنید یا یکی.
+در نتیجه سعی کنید که کار را برای توسعهدهندگانتان که مجبور هستند تغییرات شما را بازبینی کنند، آسانتر کنید.
+
+
+
این رویکرد همچنین پول یا بازگردانی کردن یک دسته تغییرات را، در صورتی که بعدها لازم باشد، آسانتر میکند.
+Rewriting History ترفندهایی کاربردی از گیت را برای بازنویسی تاریخچه و استیج تعاملی فایلها توصیف میکند — از آن ابزارها برای ساختن یک تاریخچهٔ تمیز و قابل درک پیش از ارسال کار به شخص دیگری استفاده کنید.
+
+
+
آخرین چیزی که باید به خاطر داشته باشید پیغام کامیتتان است.
+عادت به نوشتن پیغامهای کامیت با کیفیت استفاده و همکاری با گیت را بسیار آسانتر میکند.
+به عنوان قانونی کلی، پیغام شما باید با یک خط که بیش از ۵۰ حرف نیست و توصیفکنندهٔ دقیق تغییرات است شروع شود، پس از آن یک خط خالی بیاید و پس از آن توضیحات جزئیتر بیشتر قرار گیرد.
+پیغام کامیت خود را به صورت امری بنویسید: «Fix bug» (مشکل را حل کن) و نه «Fixed bug» (مشکل حل شد) یا «Fixes bug» (مشکل را حل میکند).
+
+
+
+
+
مختصری (۵۰ حرف یا کمتر) با اطلاعات کافی
+
+توضیحات جزئی بیشتر در صورت نیاز. حدود ۷۲ حرف یا کمتر و بیشتر در هر خط باشد.
+در بعضی متنها خط اول به عنوان موضوع یک ایمیل و باقی متن به عنوان بدنهٔ
+نامه استفاده میشود. خط خالی که خلاصه را از بدنه جدا میکند حیاتی است (
+مگر اینکه کلاً بدنه را حذف کنید)؛ ابزارهایی مانند ریبیس درصورت ترکیب کردن
+این دو با مشکل مواجه میشوند.
+
+پیغام کامیت خود را در حالت امری بنویسید: «مشکل را حل کن» و نه
+«مشکل حل شد» یا «مشکل را حل میکند.» این عرف با پیغامهایی که توسط
+دستوراتی مانند گیت مرج و گیت ریورت ساخته میشود تطابق دارد.
+
+بندهای بعدی هر کدام پس از یک خط خالی میآیند.
+
+- بولت زدن هم در این قالب پشتیبانی میشود.
+
+- معمولاً یک خطتیره یا ستاره برای بولت استفاده میشود که با یک
+ فاصله همراه است و بین بولتها خط خالی میآید. اما عرفها در این مورد
+ کمی با یکدیگر تفاوت دارند.
+
+- از تورفتگی آویزان استفاده کنید.
+
+
+
+
در صورتی که تمام پیغامهای کامیتهای شما از این ساختار پیروی کنند، خیلی چیزها برای شما و توسعهدهندگانی که با آنها همکاری میکنید آسانتر میشود.
+پروژهٔ گیت پیغامهای کامیت خوش قالبی دارد — git log --no-merges را در پروژه امتحان کنید تا ببنید یک تاریخچهٔ کامیت خوش قالب چه شکلی است.
+
+
+
+
+|
+ یادداشت
+ |
+
+ کاری که میگوییم را انجام دهید، نه کاری که ما میکنیم.
+
+ برای خلاصه بودن، بسیاری از مثالهای این کتاب پیغام کامیتهای خوش قالبی مانند این ندارد؛ به جای آن، ما به سادگی از آپشن -m برای git commit استفاده میکنیم.
+
+ خلاصه اینکه کاری که میگوییم را انجام دهید، نه کاری که ما میکنیم.
+ |
+
+
+
+
+
تیم خصوصی کوچک
+
+
+سادهترین چینشی که به احتمال زیادی به آن بر خواهید خورد یک پروژهٔ خصوصی کوچک با یک یا دو توسعهدهندهٔ دیگر است.
+«خصوصی» محتوا است، به این معنا که متن-بسته است — توسط دنیای بیرون قابل دسترس نیست.
+شما و دیگر توسعهدهندگان، همه دسترسی پوش به مخزن را دارند.
+
+
+
در این محیط شما احتمالاً میتوانید روند کاری مشابهی با آنچه که هنگام کار با سابورژن یا دیگر سیستمهای متمرکز داشتید دنبال کنید.
+شما همچنان از مزیتهایی مثل کامیت آفلاین و مرج و برنچسازی بسیار سادهتر برخوردارید، اما روند کاری مشابه است؛
+تفاوت اصلی در این است که هنگام مرج، آنها سمت کاربر انجام میشوند به جای سمت سرور.
+بیایید ببینیم هنگامی که دو توسعهدهنده شروع به کار کردن با یکدیگر روی یک مخزن مشترک کنند چه شکلی خواهد بود.
+توسعهدهندهٔ اول، جان، مخزن را کلون، تغییراتی اعمال و به طور محلی کامیت میکند.
+(در این مثالها پیغامهای پروتکل با ... جایگزین شدهاند تا به نحوی خلاصهسازی شود.)
+
+
+
+
# John's Machine
+$ git clone john@githost:simplegit.git
+Cloning into 'simplegit'...
+...
+$ cd simplegit/
+$ vim lib/simplegit.rb
+$ git commit -am 'Remove invalid default value'
+[master 738ee87] Remove invalid default value
+ 1 files changed, 1 insertions(+), 1 deletions(-)
+
+
+
+
دومین توسعهدهنده، جسیکا هم همین کار را میکند — مخزن را کلون میکند و تغییری را کامیت میکند:
+
+
+
+
# Jessica's Machine
+$ git clone jessica@githost:simplegit.git
+Cloning into 'simplegit'...
+...
+$ cd simplegit/
+$ vim TODO
+$ git commit -am 'Add reset task'
+[master fbff5bc] Add reset task
+ 1 files changed, 1 insertions(+), 0 deletions(-)
+
+
+
+
حال جسیکا کار خود را به سرور پوش میکند که به درستی انجام میشود:
+
+
+
+
# Jessica's Machine
+$ git push origin master
+...
+To jessica@githost:simplegit.git
+ 1edee6b..fbff5bc master -> master
+
+
+
+
آخرین خط خروجی بالا پیغام بازگشتی مفیدی را از عملیات پوش نشان میدهد.
+قالب ساده <oldref>..<newref> fromref -> toref است که در آن oldref یعنی مرجع قدیمی، newref یعنی مرجع جدید، fromref نام مرجع محلی است که پوش میشود و toref نام مرجع ریموت است که بروزرسانی میشود.
+در مبحث پایین هم خروجی متفاوتی را خواهید دید، بنابراین داشتن یک ایدهٔ پایه از مفهوم این به درک شما از وضعیتهای متفاوت مخزن کمک میکند.
+جزئیات بیشتر در مستند git-push در دسترس هستند.
+
+
+
به ادامهٔ مثال میرویم. کمی بعد جان کمی تغییرات انجام میدهد، آنها را در مخزن محلی خود کامیت میکند و سپس سعی در پوش کردن روی همان سرور میکند:
+
+
+
+
# John's Machine
+$ git push origin master
+To john@githost:simplegit.git
+ ! [rejected] master -> master (non-fast forward)
+error: failed to push some refs to 'john@githost:simplegit.git'
+
+
+
+
به علت اینکه جسیکا تغییرات خودش را پیشتر پوش کرده بوده، پوش جان با شکست مواجه میشود.
+دانستن این مسئله بسیار مهم است بخصوص اگر به سابورژن عادت دارید، چراکه متوجه خواهید شد که دو توسعهدهنده یک فایل را ویرایش نکردهاند.
+اگرچه فایلهای متفاوتی ویرایش شده باشند، سابورژن به طور خودکار روی سرور مرجی انجام میدهد، اما با گیت، شما باید اول کامیتها را به صورت محلی مرج کنید.
+به بیان دیگر، جان باید اول تغییرات بالادست جسیکا را فچ و آنها را در مخزن محلی خودش مرج کند پیش از اینکه بتواند پوش انجام دهد.
+
+
+
در وهلهٔ اول جان کارهای جسیکا را فچ میکند (این کار فقط کار جسیکا را فچ میکند و در کار جان آنرا مرج نمیکند):
+
+
+
+
$ git fetch origin
+...
+From john@githost:simplegit
+ + 049d078...fbff5bc master -> origin/master
+
+
+
+
در این نقطه، مخزن محلی جان شبیه این است:
+
+
+
+
}}" alt="John’s divergent history.">
+
+
نمودار 58. تاریخچهٔ دوشاخهٔ جان.
+
+
+
حال جان میتواند کار جسیکا را که فچ کرده بود با کار محلی خودش مرج کند:
+
+
+
+
$ git merge origin/master
+Merge made by the 'recursive' strategy.
+ TODO | 1 +
+ 1 files changed, 1 insertions(+), 0 deletions(-)
+
+
+
+
مادامی که مرج محلی به درستی صورت بگیرد، تاریخچهٔ بروز جان به این شکل شبیه خواهد بود:
+
+
+
+
}}" alt="John’s repository after merging `origin/master`.">
+
+
نمودار 59. مخزن جان بعد از مرج کردن origin/master.
+
+
+
اینجا جان ممکن است این کد جدید را تست کند تا مطمئن باشد که کار جسیکا به هیچ نحوی روی کار او تأثیری نذاشته و تا زمانی که همه چیز به نظر مناسب میآید او میتواند کار مرج شدهٔ جدید را به سرور پوش کند:
+
+
+
+
$ git push origin master
+...
+To john@githost:simplegit.git
+ fbff5bc..72bbc59 master -> master
+
+
+
+
در آخر تاریخچهٔ کامیت جان به این شکل خواهد بود:
+
+
+
+
}}" alt="John’s history after pushing to the `origin` server.">
+
+
نمودار 60. تاریخچهٔ جان پس از پوش کردن به سرور origin.
+
+
+
در همین حین، جسیکا یک برنچ موضوعی جدید به نام issue54 ساخته و سه کامیت روی آن برنچ گرفته است.
+او هنوز کارهای جان را فچ نکرده است، پس تاریخچهٔ کامیتهای او شبیه به این است:
+
+
+
+
}}" alt="Jessica’s topic branch.">
+
+
نمودار 61. برنچ موضوعی جسیکا.
+
+
+
ناگهان جسیکا متوجه میشود که جان کار جدیدی به سرور پوش کرده و او میخواهد به آن نگاهی بیاندازد، بنابراین تمام محتوای جدیدی را که ندارد از سرور فچ میکند:
+
+
+
+
# Jessica's Machine
+$ git fetch origin
+...
+From jessica@githost:simplegit
+ fbff5bc..72bbc59 master -> origin/master
+
+
+
+
این عمل تغییراتی را که جان در این حین انجام داده است را میگیرد.
+تاریخچهٔ جسیکا اکنون شبیه به این است:
+
+
+
+
}}" alt="Jessica’s history after fetching John’s changes.">
+
+
نمودار 62. تاریخچهٔ جسیکا پس از فچ کردن تغییرات جان.
+
+
+
جسیکا گمان میکند که برنچ موضوعی او آماده است اما میخواهد بداند که چه بخشی از کار فچ شدهٔ جان را باید با کار خود مرج کند تا بتوانید پوش کند.
+او git log را اجرا میکند تا مطلع شود:
+
+
+
+
$ git log --no-merges issue54..origin/master
+commit 738ee872852dfaa9d6634e0dea7a324040193016
+Author: John Smith <jsmith@example.com>
+Date: Fri May 29 16:01:27 2009 -0700
+
+ Remove invalid default value
+
+
+
+
سینتکس issue54..origin/master یک لاگ فیلتر است که از گیت میخواهد که فقط کامیتهایی را نشان دهد که در برنچ دوم (در این مورد origin/master) موجودند و در برنچ اول (در این مورد issue54) نیستند.
+دربارهٔ این ساختار و سینکس در Commit Ranges با جزئیات توضیح میدهیم.
+
+
+
از خروجی بالا متوجه میشویم که یک کامیت وجود دارد که جان آنرا ساخته است و جسیکا آنرا در کار محلی خود مرج نکرده است.
+اگر او origin/master را مرج کند، آن کامیت کار محلی او را تغییر خواهد داد.
+
+
+
حال جسیکا میتواند برنچ موضوعی خود را به master مرج کند، کار جان (origin/master) را به برنچ master خودش مرج کند. سپس آنها را دوباره به سرور پوش کند.
+
+
+
ابتدا (حین کامیت داشتن همهٔ تغییراتش روی برنچ موضوعی issue54) جسیکا به برنچ master خود باز میگردد تا مقدمات یکپارچهسازی را انجام دهد:
+
+
+
+
$ git checkout master
+Switched to branch 'master'
+Your branch is behind 'origin/master' by 2 commits, and can be fast-forwarded.
+
+
+
+
جسیکا میتواند هر کدام از برنچهای origin/master یا issue54 را ابتدا مرج کند — هر دوی آنها بالادست هستند در نتیجه ترتیب مهم نیست.
+اسنپشات نهایی یکسان خواهد بود، مستقل از ترتیبی که او انتخاب کند. تنها تاریخچه تفاوت خواهد کرد.
+او تصمیم میگیرد که برنچ issue54 را ابتدا مرج کند:
+
+
+
+
$ git merge issue54
+Updating fbff5bc..4af4298
+Fast forward
+ README | 1 +
+ lib/simplegit.rb | 6 +++++-
+ 2 files changed, 6 insertions(+), 1 deletions(-)
+
+
+
+
مشکلی پیش نمیآید؛ همانطور که میبینید یک مرج fast-forward ساده بود.
+جسیکا حال فرآیند مرج محلی خود را با مرج کارهای قبلتر جان که فچ کرده بود و در برنچ origin/master است تمام میکند:
+
+
+
+
$ git merge origin/master
+Auto-merging lib/simplegit.rb
+Merge made by the 'recursive' strategy.
+ lib/simplegit.rb | 2 +-
+ 1 files changed, 1 insertions(+), 1 deletions(-)
+
+
+
+
همه چیز با حالت تمیز خاتمه مییابد (تداخلی پیش نمیآید) و تایخچهٔ جسیکا شبیه به این است:
+
+
+
+
}}" alt="Jessica’s history after merging John’s changes.">
+
+
نمودار 63. تاریخچهٔ جسیکا پس از مرج کردن تغییرات جان.
+
+
+
حال origin/master از برنچ master جسیکا قابل دسترسی است، پس او باید بتواند با موفقیت به آن پوش کند (بر فرض اینکه جان تغییرات بیشتری را در این حین پوش نکرده باشد):
+
+
+
+
$ git push origin master
+...
+To jessica@githost:simplegit.git
+ 72bbc59..8059c15 master -> master
+
+
+
+
هر توسعهدهنده چندین بار کامیت کرده و کارهای دیگران را با موفقیت مرج کرده است.
+
+
+
+
}}" alt="Jessica’s history after pushing all changes back to the server.">
+
+
نمودار 64. تاریخچهٔ جسیکا پس از پوش کردن تمام تغییرات به سرور.
+
+
+
این یکی از سادهترین روندهای کاری است.
+کمی کار میکنید (معمولاً در یک برنچ موضوعی)، و وقتی آمادهٔ یکپارچهسازی و تعبیه است کار خود را به master خودتان مرج میکنید.
+وقتی میخواهید کار خود را به اشتراک بگذارید، اگر تغییری صورت گرفته باشد master خود را فچ و ادغام با origin/master میکنید، و در آخر برنچ master را به سرور پوش میکنید.
+ترتیب کلی چیزی شبیه به این است:
+
+
+
+
}}" alt="General sequence of events for a simple multiple-developer Git workflow.">
+
+
نمودار 65. ترتیب کلی رویدادها برای یک روند کاری چند توسعهدهندهای ساده گیت.
+
+
+
تیمهای خصوصی مدیریتشده
+
+
+در سناریوی بعدی، شما به نقشهای همکاری در یک گروه بزرگتر خصوصی مینگرید.
+میآموزید که چگونه در محیطی کار کنید که گروههای کوچکتر روی ویژگیها و فیچرهای جدید کار میکنند و پس از آن کارهای مشارکت شده توسط تیم، به وسیلهٔ شخص دیگری یکپارچهسازی میشوند.
+
+
+
فرض کنیم که جان و جسیکا هر دو روی یک ویژگی (نام آنرا «featureA» بگذاریم) کار میکنند، مادامی که جسیکا و یک توسعهدهندهٔ سوم، جوزی، روی یک ویژگی دوم هم کار میکنند (بگوییم «featureB»).
+در این حالت، کمپانی از یک نوع روند کاری مدیر-یکپارچهسازی (Integration-Manager) استفاده میکند که در آن کار انجام شده توسط گروههای مختلف و مجزا فقط توسط گروه خاصی از مهندسین تعبیه و یکپارچهسازی میشود و
+برنچ master مخزن فقط توسط آن گروه از مهندسین قابل بروزرسانی است.
+در این سناریو همهٔ کار در برنچهای تیمی انجام میشود و توسط یکپارچهسازها بعدها کنار هم گذاشته میشود.
+
+
+
بیایید روند کاری جسیکا را همچنان که روی دو ویژگیاش به طور موازی و با دو توسعهدهندهٔ متفاوت در این محیط کار میکند دنبال کنیم.
+با فرض اینکه او از قبل مخزن خود را کلون داشته است، تصمیم میگیرد که ابتدا روی featureA کار کند.
+او یک برنچ جدید برای این ویژگی میسازد و آنجا کمی کار روی آن انجام میدهد:
+
+
+
+
# Jessica's Machine
+$ git checkout -b featureA
+Switched to a new branch 'featureA'
+$ vim lib/simplegit.rb
+$ git commit -am 'Add limit to log function'
+[featureA 3300904] Add limit to log function
+ 1 files changed, 1 insertions(+), 1 deletions(-)
+
+
+
+
در این نقطه لازم است که کارش را با جان به اشتراک بگذارد پس کامیتهای برنچ featureA خود را به سمت سرور پوش میکند.
+جسیکا دسترسی پوش به برنچ master ندارد — فقط یکپارچهسازها دارند — پس نیاز است که او به برنچ دیگری پوش کند تا با جان همکاری کند:
+
+
+
+
$ git push -u origin featureA
+...
+To jessica@githost:simplegit.git
+ * [new branch] featureA -> featureA
+
+
+
+
جسیکا به جان ایمیل میزند و به او میگوید که کاری را در برنچی با نام featureA پوش کرده است و او میتواند اکنون آنرا ملاحظه کند.
+مادامی که منتظر بازخورد جان است، جسیکا تصمیم میگیرد که کار روی featureB را با جوزی شروع کند.
+برای شروع به کار او یک برنچ جدید میسازد و آنرا روی master سرور پایهگذاری میکند:
+
+
+
+
# Jessica's Machine
+$ git fetch origin
+$ git checkout -b featureB origin/master
+Switched to a new branch 'featureB'
+
+
+
+
حال جسیکا چند کامیت روی featureB برنچ میگیرد:
+
+
+
+
$ vim lib/simplegit.rb
+$ git commit -am 'Make ls-tree function recursive'
+[featureB e5b0fdc] Make ls-tree function recursive
+ 1 files changed, 1 insertions(+), 1 deletions(-)
+$ vim lib/simplegit.rb
+$ git commit -am 'Add ls-files'
+[featureB 8512791] Add ls-files
+ 1 files changed, 5 insertions(+), 0 deletions(-)
+
+
+
+
مخزن جسیکا الآن به شبیه به این شکل است:
+
+
+
+
}}" alt="Jessica’s initial commit history.">
+
+
نمودار 66. تاریخچهٔ اولیهٔ کامیت جسیکا.
+
+
+
او آماده است تا کار خود را پوش کند، اما ایمیلی از جوزی دریافت میکند که کمی کار اولیه دربارهٔ ویژگی «featureB» از قبل روی سرور با نام برنچ featureBee پوش شده است.
+پیش از اینکه جسیکا بتواند کار خود را روی سرور پوش کند، باید کار خود با آن تغییرات مرج کند.
+ابتدا جسیکا تغییرات جوزی را با git fetch میگیرد:
+
+
+
+
$ git fetch origin
+...
+From jessica@githost:simplegit
+ * [new branch] featureBee -> origin/featureBee
+
+
+
+
با فرض اینکه جسیکا هنوز روی برنچ featureB چکاوت است، اکنون او میتواند کار جوزی را در آن برنچ با git merge مرج کند:
+
+
+
+
$ git merge origin/featureBee
+Auto-merging lib/simplegit.rb
+Merge made by the 'recursive' strategy.
+ lib/simplegit.rb | 4 ++++
+ 1 files changed, 4 insertions(+), 0 deletions(-)
+
+
+
+
اکنون جسیکا میخواهد که تمام کارهای «featureB» که مرج کرده را به سمت سرور پوش کند، اما نمیخواهد صرفاً روی برنچ featureB خودش پوش کند.
+از آنجایی که جوزی از قبل برنچ بالادست featureBee را ساخته است جسیکا میخواهد که روی آن به جای featureB پوش کند، که به وسیلهٔ دستورات زیر این کار را میکند:
+
+
+
+
$ git push -u origin featureB:featureBee
+...
+To jessica@githost:simplegit.git
+ fba9af8..cd685d1 featureB -> featureBee
+
+
+
+
به این refspec میگویند.
+برای بحث جزئیتر دربارهٔ _refspec_های گیت و کارهای دیگری که می توانید با آنها انجام دهید به The Refspec مراجعه کنید.
+همچنین به فلگ -u توجه کنید؛ این مختصری برای --set-upstream است که برنچها را برای پوش و پول آسانتر در آینده تنظیم میکند.
+
+
+
ناگهان جسیکا ایمیلی از جان دریافت میکند که به او میگوید که تغییراتی را به featureA که روی آن همکاری میکردهاند پوش کرده است و از جسیکا میخواهد تا نگاهی به آن بیاندازد.
+باز جسیکا یک git fetch ساده برای گرفتن تمام محتوای جدید از سرور اجرا میکند که (قطعاً) شامل آخرین کارهای جان میباشد:
+
+
+
+
$ git fetch origin
+...
+From jessica@githost:simplegit
+ 3300904..aad881d featureA -> origin/featureA
+
+
+
+
جسیکا میتواند لاگ کارهای جدید جان را با مقایسهٔ محتوای تازه فچ شدهٔ برنچ featureA با کپی محلی خودش از همان برنچ مشاهده کند:
+
+
+
+
$ git log featureA..origin/featureA
+commit aad881d154acdaeb2b6b18ea0e827ed8a6d671e6
+Author: John Smith <jsmith@example.com>
+Date: Fri May 29 19:57:33 2009 -0700
+
+ Increase log output to 30 from 25
+
+
+
+
اگر جسیکا از خروجی که میگیرد راضی است میتواند کار جدید جان را در برنچ محلی featureA محلی خود به شکل زیر مرج کند:
+
+
+
+
$ git checkout featureA
+Switched to branch 'featureA'
+$ git merge origin/featureA
+Updating 3300904..aad881d
+Fast forward
+ lib/simplegit.rb | 10 +++++++++-
+1 files changed, 9 insertions(+), 1 deletions(-)
+
+
+
+
در نهایت جسیکا ممکن است بخواهد که کمی تغییر کوچک به تمام محتوای مرج شده اعمال کند، او میتواند آزادانه چنین کاری کند و آنها را به برنچ محلی featureA خود کامیت و نتایج را به سمت سرور پوش کند.
+
+
+
+
$ git commit -am 'Add small tweak to merged content'
+[featureA 774b3ed] Add small tweak to merged content
+ 1 files changed, 1 insertions(+), 1 deletions(-)
+$ git push
+...
+To jessica@githost:simplegit.git
+ 3300904..774b3ed featureA -> featureA
+
+
+
+
تاریخچهٔ کامیت جسیکا اکنون باید شبیه به این باشد:
+
+
+
+
}}" alt="Jessica’s history after committing on a feature branch.">
+
+
نمودار 67. تاریخچهٔ جسیکا پس از کامیت روی یک برنچ feature.
+
+
+
در این میان، جسیکا، جوزی و جان یکپارچهسازها را مطلع میسازند که برنچهای featureA و featureBee روی سرور آماده برای تعبیه شدن در خط اصلی هستند.
+پس از اینکه یکپارچهسازها این تغییرات را با خط اصلی ادغام میکنند، یک فچ، مرج کامیت جدیدی را نمایش میدهد، تاریخچه شبیه به شکل زیر خواهد شد:
+
+
+
+
}}" alt="Jessica’s history after merging both her topic branches.">
+
+
نمودار 68. تاریخچهٔ جسیکا پس از مرج شدن هر دو برنچهای موضوعی او.
+
+
+
بسیاری از گروهها به دلیل قابلیت داشتن چندین تیم فعال که در موازا با یکدیگر کار میکنند و در ادامهٔ کار خطوط متفاوتی از کار را با یکدیگر ادغام میکنند به گیت روی میآورند.
+قابلیت اینکه زیرگروههای کوچکتر یک تیم میتوانند به واسطهٔ یک برنچ ریموت با یکدیگر همکاری داشته باشند بدون اینکه لزوماً احتیاج باشد کل تیم را درگیر یا معطل کنند یک مزیت بزرگ گیت است.
+ترتیب روند کاری که ملاحظه کردید چیزی شبیه به این است:
+
+
+
+
}}" alt="Basic sequence of this managed-team workflow.">
+
+
نمودار 69. ترتیب پایهٔ روند کاری این تیم مدیریتشده.
+
+
+
پروژهٔ عمومی فورک شده
+
+
+مشارکت در یک پروژهٔ عمومی کمی متفاوت است.
+چرا که شما دسترسی بروزرسانی مستقیم برنچهای پروژه را ندارید و باید کار را به نحو دیگری به نگهدارندهها برسانید.
+مثال اول مشارکت با فورکسازی میزبانان گیت را توصیف میکند که از فورکسازی ساده پشتیبانی میکنند.
+بسیاری از سایتهای میزبانی این ویژگی را پشتیبانی میکنند (شامل گیتهاب، گیتلب، repo.or.cz، و غیره) و بسیاری از نگهدارندگان پروژهها انتظار این نوع از همکاری را دارند.
+بخش بعدی به پروژههایی میپردازد که ترجیح میدهند پچهای مشارکتشده را از طریق ایمیل دریافت کنند.
+
+
+
ابتدا، احتمالاً میخواهید که مخزن اصلی را کلون کنید، یک برنچ موضوعی برای پچ یا دسته پچهایی که قصد دارید مشارکت کنید بسازید و کارتان را آنجا انجام دهید.
+این روند به طور کل ترتیبی اینچنینی دارد:
+
+
+
+
$ git clone <url>
+$ cd project
+$ git checkout -b featureA
+ ... work ...
+$ git commit
+ ... work ...
+$ git commit
+
+
+
+
+
+|
+ یادداشت
+ |
+
+
+ ممکن است بخواهید از rebase -i برای اسکوآش کردن کار خود به یک کامیت یا تغییر ترتیب کارها در کامیتها استفاده کنید تا اعمال پچ را برای نگهدارنده آسانتر کنید — به Rewriting History برای اطلاعات بیشتر دربارهٔ بازنویسی تاریخچه و ریبیس تعاملی مراجعه کنید.
+ |
+
+
+
+
+
هنگامی که کار برنچ تمام شده است و آمادهاید تا آنرا با نگهدارنده به اشتراک بگذارید به صفحهٔ پروژهٔ اصلی بروید و روی دکمهٔ «Fork» کلیک کنید و فورک قابل نوشتن خود را از پروژه بسازید.
+سپس لازم دارید تا آدرس URL این مخزن را به عنوان یک ریموت جدید مخزن محلی خود اضافه کنید؛ در این مثال به آن myfork میگوییم:
+
+
+
+
$ git remote add myfork <url>
+
+
+
+
پس از آن باید کار جدید خود را به این مخزن پوش کنید.
+پوش کردن برنچ موضوعی که روی آن کار میکنید به مخزن فورک شدهتان بسیار آسانتر از مرج کردن کار خود به برنچ master و پوش کردن آن است.
+علت این است که اگر کارتان تأیید یا چری-پیک نشود، مجبور نمیشوید که برنچ master خود را به قبل از مرج بازگردانید
+(عملیات چری پیک-گیت با جزئیات بیشتر در روند کاری ریبیس و چری-پیک بررسی شده است).
+اگر نگهدارنده کار شما را merge، rebase یا cherry-pick کند، شما باز هم مرج شدهٔ آنرا به نحوی از مخزن او دریافت خواهید کرد.
+
+
+
در هر حال، میتوانید کار خود را به این شکل پوش کنید:
+
+
+
+
$ git push -u myfork featureA
+
+
+
+
+هنگامی که کار شما به فورک مخزن پوش شد، لازم است که نگهدارندهٔ اصل پروژه را مطلع کنید که کاری کردهاید که دوست دارید او ادغامش کند.
+غالباً به این حرکت درخواست پول (Pull Request) گفته میشود و شما معمولاً چنین درخواستی را یا با وبسایت انجام میدهید — گیتهاب اکنون سازوکار «پول ریکوئست» خودش را دارد که به آن در GitHub میپردازیم — یا میتوانید دستور git request-pull را اجرا و خروجی حاصله را به طور دستی به نگهدارندهٔ پروژه ایمیل کنید.
+
+
+
دستور git request-pull مبنای برنچ بعلاوه آدرس URL مخزن گیتی که میخواهید از آن پول شوید را میگیرد و به برنچ موضوعی که میخواهید پول شود میبرد و
+خلاصهای از تمام تغییراتی که میخواهید پول شوند تولید میکند.
+به طور مثال اگر جسیکا بخواهد برای جان یک درخواست پول بدهد و دو کامیت روی برنچ موضوعی که تازه پوش کرده است گرفته باشد، میتواند این دستور را اجرا کند:
+
+
+
+
$ git request-pull origin/master myfork
+The following changes since commit 1edee6b1d61823a2de3b09c160d7080b8d1b3a40:
+Jessica Smith (1):
+ Create new function
+
+are available in the git repository at:
+
+ git://githost/simplegit.git featureA
+
+Jessica Smith (2):
+ Add limit to log function
+ Increase log output to 30 from 25
+
+ lib/simplegit.rb | 10 +++++++++-
+ 1 files changed, 9 insertions(+), 1 deletions(-)
+
+
+
+
این خروجی میتواند به نگهدارنده فرستاده شود — به آنها میگوید که کار از کجا شاخه شده، کامیتها را خلاصه میکند و مشخص میکند که از کجا کار جدید باید پول شود.
+
+
+
روی پروژهای که نگهدارندهٔ آن نیستید، عموماً آسانتر است که برنچی مثل master داشته باشید که همیشه origin/master را پیگیری میکند و
+ کار خود را در برنچی موضوعی انجام دهید که در صورت رد شدن به سادگی قابل حذف باشد.
+داشتن تمهای کاری ایزوله در برنچهای موضوعی همچنین ریبیس کردن کار را، در صورتی که نوک مخزن اصلی جابهجا شود و دیگر کامیتهایتان قابلیت اعمال تمیز را نداشته باشند، آسانتر میکند.
+به طور مثال اگر میخواهید یک موضوع دومی برای پروژه ثبت کنید، کار را روی برنچی که پوش کردهاید ادامه ندهید — از ابتدا، از برنچ master مخزن اصلی شروع کنید:
+
+
+
+
$ git checkout -b featureB origin/master
+ ... work ...
+$ git commit
+$ git push myfork featureB
+$ git request-pull origin/master myfork
+ ... email generated request pull to maintainer ...
+$ git fetch origin
+
+
+
+
اکنون هر کدام از موضوعات شما درون یک سیلو — مشابه با صف پچ — است که میتوانید بازنویسی، ریبیس یا ویرایش کنید بدون اینکه موضوعات با یکدیگر تداخل پیدا کنند و یا به یکدیگر وابسته باشند، به این صورت:
+
+
+
+
}}" alt="Initial commit history with `featureB` work.">
+
+
نمودار 70. تاریخچهٔ اولیه کامیت با کار featureB.
+
+
+
فرض کنیم که نگهدارندهٔ پروژه یک برنچ از تعدادی وصلهٔ دیگر پول کرده و برنچ اول شما را امتحان کرده است اما دیگر به طور تمیز قابل اعمال نیست.
+در این حالت شا میتوانید که آن برنچ را به نوک origin/master ریبیس و تداخلات را برای نگهدارنده حل کرده و دگربار تغییرات خود را ارائه کنید:
+
+
+
+
$ git checkout featureA
+$ git rebase origin/master
+$ git push -f myfork featureA
+
+
+
+
+
+
}}" alt="Commit history after `featureA` work.">
+
+
نمودار 71. تاریخچهٔ کامیت پس از کار featureA.
+
+
+
از جهت اینکه شما برنچ را ریبیس کردهاید، باید -f را به دستور پوش خود بدهید تا بتوانید برنچ featureA سرور را با کامیتی که فرزند آن نیست بازنویسی کنید.
+همچنین به جای آن میتوانید که این کار جدید را به برنچ جدید روی سرور (احتمالاً featureAv2 نام) پوش کنید.
+
+
+
بیایید نگاهی به یک سناریو که احتمال بیشتری دارد بیاندازیم: نگهدارنده به کار شما در برنچ دوم نگاه کرده و از مفهوم کلی آن راضی است اما دوست دارد که تغییراتی در جزئیات پیادهسازی آن اعمال کنید.
+علاوهبر آن، این فرصت را پیدا میکنید تا کار خود را بر نوک برنچ master حاضر پایهگذاری کنید.
+یک برنچ جدید میسازید که بر پایهٔ برنچ origin/master است، تغییرات featureB را آنجا اسکوآش، تداخلات را حل، جزئیات پیادهسازی را اعمال و آنرا به عنوان یک برنچ جدید پوش میکنید.
+
+
+
+
+
$ git checkout -b featureBv2 origin/master
+$ git merge --squash featureB
+ ... change implementation ...
+$ git commit
+$ git push myfork featureBv2
+
+
+
+
آپشن --squash تمام کار روی برنچ مرج شده را میگیرد و آنرا به یک دسته تغییرات تبدیل میکند که حالتی برای مخزن ایجاد میکند که یک مرج واقعی ایجاد میکرد، بدون ساختن یک مرج کامیت واقعی.
+این به این معناست که کامیت آیندهٔ شما یک والد خواهد داشت و به شما این اجازه را خواهد داد تا تمام تغییرات خود را از برنچی دیگر اضافه کنید و پس از آن قبل از کامیت جدید ساختن تغییراتی به آنها اعمال کنید.
+همچنین آپشن --no-commit میتواند برای به تعویق انداختن کامیت در حالتی که مرج معمولی انجام میدهید مفید واقع شود.
+
+
+
در این نقطه میتوانید نگهدارنده را مطلع کنید که تغییرات درخواست شده را اعمال کردهاید و میتواند آنها را در برنچ featureBv2 مشاهده کند.
+
+
+
+
}}" alt="Commit history after `featureBv2` work.">
+
+
نمودار 72. تاریخچهٔ کامیت پس از کار featureBv2.
+
+
+
پروژههای عمومی روی ایمیل
+
+
+بسیاری از پروژهها فرآیندهایی را برای قبولکردن پچها به ثبات رساندهاند — لازم است برای جزئیات قوانین هر پروژه بررسی بیشتری کنید چرا که هر کدام با دیگری متفاوت است.
+از آنجایی که پروژههای قدیمیتر، بزرگتر زیادی هستند که پچها را از طریق یک لیست صندوق توسعهدهندگان قبول میکنند، حال به بررسی مثالی از آن میپردازیم.
+
+
+
روند کاری شبیه به مورد قبلی است — برنچهای موضوعی میسازید که هر کدام دستهای از پچهایی دارد که روی آنها کار کردهاید.
+تفاوت در نحوهٔ ارائهٔ پچهایتان به پروژه است.
+به جای فورک کردن پروژه و پوش کردن به نسخهٔ قابل نوشتن خودتان، شما نسخهٔ ایمیلی هر مجموعه کامیت را میسازید و آنرا به لیست صندوق توسعهدهندگان ارسال میکنید.
+
+
+
+
$ git checkout -b topicA
+ ... work ...
+$ git commit
+ ... work ...
+$ git commit
+
+
+
+
+حال شما دو کامیت دارید و میخواهید آنها را به لیست صندوق ارسال کنید.
+از git format-patch برای ساختن فایلهای در قالب mbox استفاده میکنید تا بتوانید آنها را به صندوق ایمیل کنید — این دستور هر کامیت را به ایمیلی تبدیل میکند که خط اول پیغام کامیت موضوع آن و در بدنهٔ ایمیل جزئیات بعلاوهٔ پچی است که در کامیت معرفی شده است.
+نکتهٔ خوب آن این است که اعمال پچی که از طریق format-patch ساخته شده تمام اطلاعات کامیت را به درستی نگهداری میکند.
+
+
+
+
$ git format-patch -M origin/master
+0001-add-limit-to-log-function.patch
+0002-increase-log-output-to-30-from-25.patch
+
+
+
+
دستور format-patch نام پچ فایلهایی که میسازد را چاپ میکند.
+آپشن -M به گیت میگوید که دنبال بازنامگذاریها بگردد.
+در آخر فایلها اینچنین خواهند شد:
+
+
+
+
$ cat 0001-add-limit-to-log-function.patch
+From 330090432754092d704da8e76ca5c05c198e71a8 Mon Sep 17 00:00:00 2001
+From: Jessica Smith <jessica@example.com>
+Date: Sun, 6 Apr 2008 10:17:23 -0700
+Subject: [PATCH 1/2] Add limit to log function
+
+Limit log functionality to the first 20
+
+---
+ lib/simplegit.rb | 2 +-
+ 1 files changed, 1 insertions(+), 1 deletions(-)
+
+diff --git a/lib/simplegit.rb b/lib/simplegit.rb
+index 76f47bc..f9815f1 100644
+--- a/lib/simplegit.rb
++++ b/lib/simplegit.rb
+@@ -14,7 +14,7 @@ class SimpleGit
+ end
+
+ def log(treeish = 'master')
+- command("git log #{treeish}")
++ command("git log -n 20 #{treeish}")
+ end
+
+ def ls_tree(treeish = 'master')
+--
+2.1.0
+
+
+
+
همچنین شما میتوانید این پچ فایلها را ویرایش کنید تا اطلاعات بیشتری برای ایمیل لیست اضافه کنید که نمیخواهید در پیغام کامیتتان باشند.
+اگر میخواهید میتوانید متنی بین خطوط --- و ابتدای پچ قرار دهید (خط diff --git)، توسعهدهندگان میتوانند آنرا بخوانند، اما آن محتوا توسط فرآیند پچ کردن نادیده گرفته میشود.
+
+
+
برای ارسال این لیست نامهها، یا میتوانید محتوای فایلها را به برنامهٔ ایمیلتان الحاق کنید یا آنرا با یک برنامهٔ خط فرمان ارسال کنید.
+الحاق کردن متن معمولاً منجر به مشکلات قالببندی میشود، مخصوصاً با کلاینتهای «هوشمندتر» که خطوط جدید و دیگر فضاهای سفید را به درستی نگه نمیدارند.
+خوشبختانه گیت ابزاری برای فرستادن اصولی پچها از طریق IMAP دارد که ممکن است استفاده از آن برای شما آسانتر باشد.
+ما نحوه ارسال پچها با جیمیل را نشان خواهیم داد، جیمیلی که شناختهشدهترین ایمیل ایجنتی است که ما میدانیم؛
+شما میتوانید دستورالعملهای جزئیتر را برای چندی برنامهٔ ایمیل دیگر در آخر فایل Documentation/SubmittingPatches پیشتر ذکرشده در سورس کد گیت بخوانید.
+
+
+
+ابتدا لازم است که بخش imap را در فایل ~/.gitconfig تنظیم کنید.
+شما میتوانید هر مقدار را جداگانه با مجموعهای از دستورات git config اجرا کنید یا به طور دستی آنها را اضافه کنید، در هر صورت فایل کانفیگتان در آخر باید به شبیه به این باشد:
+
+
+
+
[imap]
+ folder = "[Gmail]/Drafts"
+ host = imaps://imap.gmail.com
+ user = user@gmail.com
+ pass = YX]8g76G_2^sFbd
+ port = 993
+ sslverify = false
+
+
+
+
اگر سرور IMAP شما از SSL استفاده نمیکند، دو خط آخر احتمالاًاحتیاج نیستند و مقدار هاست به جای imaps:// مقدار imap:// خواهد بود.
+وقتی که تنظیم شد میتوانید از git imap-send استفاده کنید تا دستهٔ پچها را در پوشهٔ پیشنویسهای سرور IMAP مشخصشده قرار دهید.
+
+
+
+
$ cat *.patch |git imap-send
+Resolving imap.gmail.com... ok
+Connecting to [74.125.142.109]:993... ok
+Logging in...
+sending 2 messages
+100% (2/2) done
+
+
+
+
در این نقطه باید بتوانید به پوشهٔ پیشنویس خود بروید، بخش گیرندهٔ نامه را به لیست صندوقی که برای آنها پچها را میفرستید تنظیم کنید و احتمالاً رونوشتی از آنرا برای مسئول آن بخش و یا نگهدارنده ارسال کنید
+و آنرا بفرستید.
+
+
+
همچنین میتوانید پچها را از طریق یک سرور SMTP ارسال کنید.
+مانند قبل میتوانید به طور جداگانه با دستهای از دستورات git config هر مقدار را تنظیم کنید یا میتوانید به طور دستی بخش sendemail را به فایل ~/.gitconfig خود بیافزایید:
+
+
+
+
[sendemail]
+ smtpencryption = tls
+ smtpserver = smtp.gmail.com
+ smtpuser = user@gmail.com
+ smtpserverport = 587
+
+
+
+
بعد از اینکه تمام شد میتوانید از git send-email استفاده کنید تا پیغامهای خود را ارسال کنید:
+
+
+
+
$ git send-email *.patch
+0001-add-limit-to-log-function.patch
+0002-increase-log-output-to-30-from-25.patch
+Who should the emails appear to be from? [Jessica Smith <jessica@example.com>]
+Emails will be sent from: Jessica Smith <jessica@example.com>
+Who should the emails be sent to? jessica@example.com
+Message-ID to be used as In-Reply-To for the first email? y
+
+
+
+
سپس، گیت برای هر پچی که ارسال میکنید دستهای از لاگها را خروجی خواهد داد که اینچنین خواهند:
+
+
+
+
(mbox) Adding cc: Jessica Smith <jessica@example.com> from
+ \line 'From: Jessica Smith <jessica@example.com>'
+OK. Log says:
+Sendmail: /usr/sbin/sendmail -i jessica@example.com
+From: Jessica Smith <jessica@example.com>
+To: jessica@example.com
+Subject: [PATCH 1/2] Add limit to log function
+Date: Sat, 30 May 2009 13:29:15 -0700
+Message-Id: <1243715356-61726-1-git-send-email-jessica@example.com>
+X-Mailer: git-send-email 1.6.2.rc1.20.g8c5b.dirty
+In-Reply-To: <y>
+References: <y>
+
+Result: OK
+
+
+
+
خلاصه
+
+
این بخش شماری از روندهای کاری رایج را برای کار با پروژههای بسیار متفاوت گیت که احتمالاً به آنها بر خواهید خورد را پوشش داد و چندین ابزار جدید که به شما کمک میکنند این فرآیند را مدیریت کنید معرفی کرد.
+در ادامه خواهید دید چگونه در آن روی سکه کار کنید: نگهداری یک پروژهٔ گیت.
+یاد خواهید گرفت چگونه یک دیکتاتور کریم یا مدیر یکپارچهسازی باشید.
+
+
نگهداری یک پروژه
+
+
+علاوه بر دانستن چگونگی مشارکت مؤثر در یک پروژه، شما احتمالاً میبایست بدانید که چگونه یک پروژه را نگهداری (Maintain) کنید.
+این فعل میتواند شامل قبول و اعمال پچهای تولید شده توسط format-patch و پیچهای ایمیلشده به شما یا یکپارچهسازی تغییرات در برنچهای ریموت برای مخازنی که به عنوان ریموت به پروژهتان اضافه کردهاید باشد.
+در صورتی که یک مخزن استاندارد را نگهداری میکنید یا میخواهید با تأیید و احراز پچها کمک کنید، لازم است بدانید که چگونه به واضحترین روش ممکن در نظر دیگر مشارکتکنندگان کار را قبول کنید که
+که در دراز مدت نیز قابل مدیریت باشد.
+
+
کار در شاخههای موضوعی
+
+
+وقتی به یکپارچهسازی کار جدید فکر میکنید، به طور کل امتحان کردنش روی یک برنچ موضوعی راه خوبی است — یک برنچ موقت مختص به امتحان آن کار جدید.
+بدین طریق ویرایش پچهای جدید به طور مستقل آسان است و در صورت کار نکردن میتوانید آنها را تا زمان ثانوی معلق کنید.
+اگر یک نام ساده برنچ بر اساس کاری که در حال امتحان آن هستید انتخاب کنید، مثلاً ruby_client
+یا چیزی با محتوای مشابه، در صورتی که بخواهید آنرا ترک کنید و بعداً به آن بازگردید، میتوانید به سادگی آنرا به خاطر بسپارید.
+نگهدارندهٔ پروژهٔ گیت سعی در این دارد که این برنچها را در فضانامهای مختلف هم قرار دهد — مانند sc/ruby_clinet که sc آن مخفف نام شخصی است که در کار همکاری داشته است.
+همانطور که به خاطر دارید، میتوانید از master به این صورت برنچ بسازید:
+
+
+
+
$ git branch sc/ruby_client master
+
+
+
+
یا اگر ترجیح میدهید به طور آنی به آن انتقال پیدا کنید، میتوانید از آپشن checkout -b استفاده کنید:
+
+
+
+
$ git checkout -b sc/ruby_client master
+
+
+
+
حال آمادهاید که کاری که در برنچ موضوعی دریافت کردهاید را اضافه کنید و به این فکر کنید که میخواهید آنرا در برنچهای اصلیتر ادغام کنید:
+
+
+
اعمال وصله از ایمیل
+
+
+اگر یک پچ از ایمیل دریافت کردهاید، لازم است آنرا در برنچ موضوعی خود تعبیه و یکپارچهسازی کنید تا بتوانید آنرا ارزیابی کنید.
+دو راه برای اعمال یک پچ ایمیل شده وجود دارد: با git apply یا با git am.
+
+
+
اعمال وصله با apply
+
+
+
+اگر پچی دریافت کردهاید که با git diff یا مدلی از دستور یونیکس diff تولید شده است (اگرچه توصیه نمیشود؛ بخش بعد را ببینید)، میتوانید آنرا با دستور git apply اعمال کنید.
+با فرض اینکه پچ را در /tmp/patch-ruby-client.patch ذخیره کردهاید، میتوانید آنرا اینگونه اعمال کنید:
+
+
+
+
$ git apply /tmp/patch-ruby-client.patch
+
+
+
+
این دستور فایلهای درون پوشهٔ کاری شما را ویرایش میکند.
+تقریباً معادل اجرای دستور patch -p برای اعمال پچ است، هرچند کمی شکاکتر است و تطابیق فازی کمتری را به نسبت دستور پچ قبول میکند.
+همچنین این دستور توانایی اضافه، پاککردن و تغییر نام فایلها را هم دارد اگر در قالب git diff شرح داده شود در حالی که patch این تواناییها را ندارد.
+در آخر git applly یک «همه را اعمال کن یا همه را لغو کن» است که یا همه چیز یا هیچچیزی را اعمال نمیکند؛ در patch میتوان به صورت جزئی پچفایلها را اعمال کرد که پوشهٔ کاری را به وضعی عجیب در میآورد.
+git apply به طور کل بسیار بیشتر از patch محافظ کارانه است.
+کامیت جدیدی برای شما نمیسازد — پس از اجرای آن باید تغییرات را به طور دستی استیج و کامیت کنید.
+
+
+
شما همچنین میتوانید از git apply استفاده کنید تا ببینید که آیا قبل از اعمال واقعی پچ، پچ امکان اعمال شدن به صورت تمیز را دارد — میتوانید git apply --check را با پچ مورد نظر اجرا کنید:
+
+
+
+
$ git apply --check 0001-see-if-this-helps-the-gem.patch
+error: patch failed: ticgit.gemspec:1
+error: ticgit.gemspec: patch does not apply
+
+
+
+
اگر خروجی نداشته باشد، باید بتوانید به صورت تمیز پچ را اعمال کنید.
+همچنین این دستور اگر شکست بخورد یک وضعیت غیرصفر باز میگرداند تا در صورت نیاز بتوانید در اسکریپتها از آن استفاده کنید.
+
+
+
+
اعمال وصله با am
+
+
+
+اگر مشارکتکننده یک کاربر گیت است و به اندازهای ماهر بود که از دستور format-patch برای ساختن پچ خود استفاده کند، آنگاه کار شما آسانتر است چرا که این پچ شامل اطلاعات نویسنده و متن کامیت هم میباشد.
+اگر میتوانید، مشارکتکنندگانتان را تشویق کنید تا با استفاده از format-patch به جای diff برایتان پچ بسازند.
+بهتر است از git apply فقط برای پچهای سنتی مانند قبل استفاده کنید.
+
+
+
برای اعمال پچی که با format-patch ساخته شده، از git am استفاده میکنید (این دستور am نامیده شده بخاطر اینکه برای «اعمال یک سری پچ از صندوق مــیلها یا ایمیلها» (from a mailbox) به کار میرود).
+از لحاظ فنی git am ساخته شده تا از یک فایل mbox محتویات را بخواند، که به طور ساده یک قالب متن-خالی (Plain-Text) برای ذخیرهٔ یک یا چند پیغام ایمیل در یک فایل متنی است.
+این فایل چیزی شبیه این است:
+
+
+
+
From 330090432754092d704da8e76ca5c05c198e71a8 Mon Sep 17 00:00:00 2001
+From: Jessica Smith <jessica@example.com>
+Date: Sun, 6 Apr 2008 10:17:23 -0700
+Subject: [PATCH 1/2] Add limit to log function
+
+Limit log functionality to the first 20
+
+
+
+
این ابتدای خروجی دستور git format-patch ایست که در بخش قبل ملاحظه نمودید؛ همچنین نمایانگر یک قالب mbox معتبر است.
+اگر کسی برای شما به درستی git send-email ارسال کرد و شما آنرا به یک قالب mbox دانلود کنید، میتوانید git am را به آن فایل mbox سوق دهید و دستور شروع به اعمال پچهایی خواهد کرد که میبیند.
+اگر از یک کلاینت ایمیل استفاده میکنید که میتواند چندین ایمیل را در قالب mbox ذخیره کند، میتوانید تمام دسته پچها را درون یک فایل ذخیره کنید و سپس با git am آنها را یکی یکی اعمال کنید.
+
+
+
هرچند اگر کسی برای شما پچ فایلی که با git format-patch ساخته شده است را به یک سیستم تیکتزنی یا چیز مشابهی ارسال کرد،
+میتوانید آن فایل را بطور محلی ذخیره کنید و فایل ذخیره شده روی دیسک را به git am دهید تا آنرا اعمال کند:
+
+
+
+
$ git am 0001-limit-log-function.patch
+Applying: Add limit to log function
+
+
+
+
شما میتوانید ملاحظه کنید که به تمیزی اعمال شد و به طور خودکار کامیت جدید را برای شما ساخت.
+اطلاعات نویسنده از هدرهای بخش فرستده و تاریخ ایمیل رونوشت و پیغام کامیت از موضوع و بدنهٔ (قبل از خود پچ) ایمیل گرفته میشود.
+
+
+
به طور مثال اگر پچ مثال mbox بالا اعمال میشد، کامیت اینچنینی میساخت:
+
+
+
+
$ git log --pretty=fuller -1
+commit 6c5e70b984a60b3cecd395edd5b48a7575bf58e0
+Author: Jessica Smith <jessica@example.com>
+AuthorDate: Sun Apr 6 10:17:23 2008 -0700
+Commit: Scott Chacon <schacon@gmail.com>
+CommitDate: Thu Apr 9 09:19:06 2009 -0700
+
+ Add limit to log function
+
+ Limit log functionality to the first 20
+
+
+
+
اطلاعات Commit فرد و زمان اعمال پچ را نشان میدهد.
+اطلاعات Author فردی که اصل پچ را ساخته و زمانی که پچ اصلی ساخته شده را نشان میدهد.
+
+
+
اما ممکن است که پچ به طور تمیز اعمال نشود.
+احتمالاً برنچ اصلی شما خیلی دورتر از جایی که پچ ساختهشده دوشاخه شده است و یا پچ وابسته به پچ دیگری است که اعمال نشده است.
+در این حالت عملیات git am شکست میخورد و از شما میپرسد که میخواهید چکار انجام دهید:
+
+
+
+
$ git am 0001-see-if-this-helps-the-gem.patch
+Applying: See if this helps the gem
+error: patch failed: ticgit.gemspec:1
+error: ticgit.gemspec: patch does not apply
+Patch failed at 0001.
+When you have resolved this problem run "git am --resolved".
+If you would prefer to skip this patch, instead run "git am --skip".
+To restore the original branch and stop patching run "git am --abort".
+
+
+
+
این دستور علامتهای تداخل را در هر فایلی که با آن مشکل دارد میگذارد، بسیار شبیه به عملیات مرج یا ریبیس تداخل دار.
+شما این مشکل را به روش بسیار مشابهی حل میکنید — برای حل تداخل فایل را ویرایش میکند، فایل جدید را استیج کرده و بعد git am --resolved را برای ادامه دادن به پچ بعدی اجرا میکنید:
+
+
+
+
$ (fix the file)
+$ git add ticgit.gemspec
+$ git am --resolved
+Applying: See if this helps the gem
+
+
+
+
اگر از گیت میخواهید راه کمی هوشمندانهتری را برای حل تداخل پیش گیرد، یک آپشن -3 به آن دهید تا باعث شود گیت سعی کند یک مرج سه طرفه انجام دهد.
+این آپشن به طور پیشفرض فعال نیست و اگر کامیت پچ میگوید که کامیت بر مبنای چیزی است که در مخزن شما نیست کار نمیکند.
+اگر آن کامیت را دارید — اگر پچ بر مبنای یک کامیت عمومی بود — پس آپشن -3 غالباً بسیار هوشمندانهتر یک پچ تداخلآمیز را اعمال میکند:
+
+
+
+
$ git am -3 0001-see-if-this-helps-the-gem.patch
+Applying: See if this helps the gem
+error: patch failed: ticgit.gemspec:1
+error: ticgit.gemspec: patch does not apply
+Using index info to reconstruct a base tree...
+Falling back to patching base and 3-way merge...
+No changes -- Patch already applied.
+
+
+
+
در این مورد، بدون آپشن -3 پچ به عنوان یک تداخل در نظر گرفته میشد.
+اما از زمانی که آپشن -3 استفاده شد پچ به تمیزی اعمال شد.
+
+
+
اگر تعدادی پچ را از یک mbox اعمال میکنید،
+این امکان را نیز دارید که دستور am را در حالت تعاملی اجرا کنید که با هر پچی که پیدا میکند میایستد و از شما میپرسد که آیا میخواهید آنرا اعمال کنید:
+
+
+
+
$ git am -3 -i mbox
+Commit Body is:
+--------------------------
+See if this helps the gem
+--------------------------
+Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all
+
+
+
+
اگر چند پچ ذخیره شده دارید این مفید است، چراکه اگر به خاطر نمیآورید که چیست میتوانید ابتدا پچ را ببینید و یا اگر از قبل اعمال کردهاید آنرا اعمال نکنید.
+
+
+
وقتی تمام پچهای موضوع خود را اعمال و به برنچ خود کامیت کردید میتوانید انتخاب کنید که آیا میخواهید تغییرات را به برنچ قدیمیتر خود اعمال کنید و اگر میخواهید چگونه این کار انجام شود.
+
+
+
+
چکاوت کردن برنچهای ریموت
+
+
+اگر مشارکت شما از یک کاربر گیت آمده که مخزن خود را دارد و تعدادی تغییرات به آن اعمال کرده و سپس برای شما URL مخزن و نام برنچ ریموتی که تغییرات در آن قرار دارند را ارسال کرده است،
+میتوانید آنها را به عنوان یک ریموت اضافه و به طور محلی مرج کنید.
+
+
+
به طور مثال اگر جسیکا برای شما ایمیلی با این مضمون میفرست که ویژگی عالی در برنچ ruby-client مخزن خودش دارد، شما میتوانید آنرا با اضافه کردن ریموت و چکاوت کردن آن برنچ به طور محلی امتحان کنید:
+
+
+
+
$ git remote add jessica git://github.com/jessica/myproject.git
+$ git fetch jessica
+$ git checkout -b rubyclient jessica/ruby-client
+
+
+
+
اگر بعداً او دوباره به شما ایمیلی زد و برنچ دیگری که شامل ویژگی عالی دیگر بود را اضافه کرده بود، شما به طور مستقیم میتوانید فچ و چکاوت کنید چرا که از قبل ریموت را اضافه کردهاید.
+
+
+
این ویژگی بخصوص زمانی مفید است که شما به طور مادام با یک فرد کار میکنید.
+اگر شخصی فقط یک پچ دارد و فقط هر از گاهی مشارکت میکند، ممکن است قبول کردن تغییرات از طریق ایمیل آسانتر باشد چرا که هرکسی میتواند سرور خود را راهاندازی کند و شما را وادار کند که
+ریموت اضافه و حذف کنید تا بتوانید پچها را دریافت کنید.
+همچنین احتمال اینکه بخواهید صدها ریموت داشته باشید، هر ریموت برای یک نفر که فقط قرار است یک یا دو پچ را اضافه کرده باشد کم است.
+هرچند اسکریپتها و سرویسهای میزبانی شده ممکن است که این را کمی آسانتر کنند — تا حد زیادی بستگی به چگونگی توسعهدادن شما و همکارانتان دارد.
+
+
+
از دیگر مزایای این روش این است که شما میتوانید تاریخچهٔ کامیتها را هم بگیرید.
+اگرچه ممکن است مشکلات مشروع مرجی داشته باشید، که میدانید که کار آنها بر اساس چه نقطهای از تاریخچهٔ شماست؛ یک مرج سه طرفه مناسب پیشفرض است، جای اینکه مجبور باشید یک -3 ارائه کنید و به این امیدوار
+باشید که پچ از کامیت عمومی آمده باشد که شما به آن دسترسی دارید.
+
+
+
اگر به طور دائم با فردی کار نمیکنید اما باز هم میخواهید از این طریق پول کنید، میتوانید URL مخزن ریموت را به دستور git pull بدهید.
+این کار یک ساده انجام میدهد و URL مرجع ریموت را ذخیره نمیکند:
+
+
+
+
$ git pull https://github.com/onetimeguy/project
+From https://github.com/onetimeguy/project
+ * branch HEAD -> FETCH_HEAD
+Merge made by the 'recursive' strategy.
+
+
+
+
تشخیص تغییرات معرفی شده
+
+
+حال شما یک برنچ موضوعی که شامل کار مشارکتشده است دارید.
+در این نقطه میتوانید تصمیم بگیرید میخواهید که با آن چکار کنید.
+این بخش تعدادی دستور را بازبینی میکند تا بتوانید ببینید چگونه میتوانید از آنها برای بررسی دقیق اتفاقاتی که در صورت مرج کردن به برنچ اصلی رخ میدهد استفاده کنید.
+
+
+
معمولاً گرفتن یک بازبینی از تمام کامیتهایی که در این برنچ میباشند اما در برنچ master نیستند کار مفیدی است.
+میتوانید دربارهٔ کامیتهایی که در برنچ master هستند، با اضافه کردن آپشن --not قبل از نام برنچ، استثنا قائل شوید.
+این همان کاری را میکند که قالب master..contrib، که پیشتر از آن استفاده کردیم، انجام میدهد.
+به طور مثال اگر همکار شما برای شما دو پچ میفرستد و شما برنچی با نام contrib میسازید و آنها را به آنجا اعمال میکنید میتوانید این را اجرا کنید:
+
+
+
+
$ git log contrib --not master
+commit 5b6235bd297351589efc4d73316f0a68d484f118
+Author: Scott Chacon <schacon@gmail.com>
+Date: Fri Oct 24 09:53:59 2008 -0700
+
+ See if this helps the gem
+
+commit 7482e0d16d04bea79d0dba8988cc78df655f16a0
+Author: Scott Chacon <schacon@gmail.com>
+Date: Mon Oct 22 19:38:36 2008 -0700
+
+ Update gemspec to hopefully work better
+
+
+
+
برای دیدن تغییراتی که هر کامیت ارائه میکند، به خاطر داشته باشید که میتوانید آپشن -p را به git log بدهید و دستور در انتهای هر کامیت دیف آنرا هم اضافه میکند.
+
+
+
برای دیدن دیف کامل اتفاقاتی که میتوانست در صورت مرج برنچ موضوعی با master بیافتد، میتوانید از یک ترفند عجیب استفاده کنید که خروجی درست را میدهد.
+ممکن است گمان کنید که باید این را اجرا کنید:
+
+
+
+
این دستور به شما یک دیف میدهد، اما ممکن است گمراه کننده باشد.
+اگر برنچ master از زمانی که برنچ موضوعی را از آن ساختهاید جلو رفته است، خروجی ظاهراً غریبی خواهید گرفت.
+این اتفاق به این دلیل میافتد که گیت به طور مستقیم اسنپشات آخرین کامیت برنچ موضوعی که روی آن هستید و آخرین کامیت برنچ master را با یکدیگر مقایسه میکند.
+به فرض مثال اگر یک خط به یک فایل روی برنچ master اضافه کرده باشید، یک مقایسهٔ مستقیم اسنپشاتها اینگونه نمایش میدهد که انگار برنچ موضوعی میخواهد آن خط را حذف کند.
+
+
+
اگر master والد مستقیم برنچ موضوعی شما است، این مسئله مشکل نیست؛
+اما اگر دو تاریخچه دو شاخه شده باشند، دیف به گونهای نمایش میدهد که انگار در حال اضافه کردن محتوای جدید به برنچ موضوعی هستید و هر چیزی که مختص به برنچ master است را پاک میکنید.
+
+
+
به جای این، چیزی که واقعاً میخواهید ببینید تغییراتی است که به برنچ موضوعی اضافه شده است — کاری که در صورت مرج برنچ با master معرفی میشود.
+شما این کار را با واداری گیت به مقایسهٔ آخرین کامیت برنچ موضوعیتان با اولین والد مشترکی که با برنچ master دارد انجام میدهید.
+
+
+
از لحاظ فنی میتوانید با تشخیص صریح والد مشترک و سپس اجرای دیف با آن والد این کار را به انجام برسانید:
+
+
+
+
$ git merge-base contrib master
+36c7dba2c95e6bbb78dfa822519ecfec6e1ca649
+$ git diff 36c7db
+
+
+
+
+
+
$ git diff $(git merge-base contrib master)
+
+
+
+
هرچند هیچکدام از این دو خیلی عرف نیست، بنابراین گیت مختصری برای انجام همین کار ارائه میکند: سینتکس سه نقطه.
+در متن دستور git diff میتوانید سه نقطه بعد از برنچ دیگری بگذارید تا یک diff بین آخرین کامیت برنچی که روی آن هستید و والد مشترکش با برنچ دیگری بگیرید:
+
+
+
+
$ git diff master...contrib
+
+
+
+
این دستور فقط کاری که این برنچ موضوعی فعلی از آخرین والد مشترکش با master معرفی کرده را نشان میدهد.
+این سینتکس بسیار مفیدی برای به خاطر سپردن است.
+
+
+
تعبیه و یکپارچهسازی کار مشارکتشده
+
+
+هنگامی که تمام کار در برنچ موضوعی آماده است تا یکپارچهسازی به یک برنچ اصلیتر است، سؤال این میشود که چگونه میتوان این کار را کرد.
+علاوه بر آن میخواهید از چه روند کاری کلی برای نگهداری پروژه خود استفاده کنید؟
+شما تعدادی انتخاب دارید، ما چندی از آنها را بررسی میکنیم.
+
+
+
ادغام روندهای کاری
+
+
+یک روند کاری ساده این است که تمام کار را مستقیماً با master مرج کنید.
+در این سناریو شما یک برنچ master دارید که شامل کد باثبات شماست.
+وقتی که کاری در برنچ موضوعی دارید که فکر میکنید کامل است یا کاری از کسی دیگر دارید که به شما داده شده و شما آنرا تأیید کردهاید،
+آنرا با برنچ مستر مرج، آن برنچ تازه مرج شدهٔ موضوعی را پاک و این فرآیند را تکرار میکنید.
+
+
+
+
+
}}" alt="History with several topic branches.">
+
+
نمودار 73. تاریخچه با تعدادی برنچ موضوعی.
+
+
+
+
}}" alt="After a topic branch merge.">
+
+
نمودار 74. بعد مرج یک برنچ موضوعی.
+
+
+
این احتمالاً سادهترین روند کاری است، اما اگر با پروژههای بزرگتر یا باثباتتر سروکار دارید و میخواهید به آنچه ارائه میکنید محتاط باشید، میتواند مشکلساز باشد.
+
+
+
اگر پروژهٔ مهمتری دارید، ممکن است بخواهید از یک چرخهٔ مرج دوفازی استفاده کنید.
+در این سناریو شما دو برنچ با قدمت دارید، master و develop که master فقط موقعی بروزرسانی میشود که یک نسخه خیلی باثبات تهیه شده و همهٔ کدهای جدید در برنچ develop تعبیه میشوند.
+عموماً شما هردوی این برنچها را به مخزن عمومی پوش میکنید.
+هر بار که برنچ موضوعی جدیدی برای مرج کردن دارید (قبل از مرج یک برنچ موضوعی.)، آنرا به develop مرج میکنید (بعد مرج یک برنچ موضوعی.)؛
+سپس هنگامی که یک تگ انتشار داشتید، master را به هرجایی که برنچ موقتاً باثبات develop هست fast-forward میکنید (بعد از یک انتشار از پروژه.).
+
+
+
+
}}" alt="Before a topic branch merge.">
+
+
نمودار 75. قبل از مرج یک برنچ موضوعی.
+
+
+
+
}}" alt="After a topic branch merge.">
+
+
نمودار 76. بعد مرج یک برنچ موضوعی.
+
+
+
+
}}" alt="After a topic branch release.">
+
+
نمودار 77. بعد از یک انتشار از پروژه.
+
+
+
از این طریق هنگامی که مخزن پروژهٔ شما را کلون میکنند، یا master را برای ساختن آخرین نسخهٔ باثبات چکاوت میکنند و آنرا به روز نگه میدارند و یا برنچ develop را چکاوت میکنند که
+شامل محتوای بروز بیشتری است.
+همچنین می توانید با داشتن یک برنچ integrate که در آن تمام کارها مرجشده است این مفهوم را گسترش دهید.
+پس از این هنگامی که کدبیس شما روی آن برنچ باثبات است و تستها را میگذراند، میتوانید آنرا در برنچ develop بریزید؛ و وقتی که برای مدتی باثبات جلوه کرد برنچ master خود را fast-forward کنید.
+
+
+
+
روند کاری ادغام-بزرگ
+
+
+پروژهٔ گیت چهار برنچ باقدمت دارد: master، next، و pu (Proposed Updates، بروزرسانی پیشنهادی) برای کارهای جدید و maint (Maintenance Backports، بکپورتهای نگهداری).
+وقتی کار جدید توسط مشارکتکنندگان معرفی میشود، درون برنچ موضوعی در مخزن نگهدارنده، مشابه چیزی که توصیف کردیم، جمعآوری میشود (مدیریت مجموعهای پیچیده از برنچهای موضوعی موازی مشارکتشده. را ببینید).
+در این نقطه موضوعات در پی دریافتن اینکه آیا برای استفاده آماده و امن هستند و یا احتیاج است بیشتر روی آنها کار شود ارزیابی میشوند.
+اگر امن بودند به next مرج میشوند و آن برنچ پوش میشود تا همه بتوانند موضوعاتی که با هم یکپارچهسازی شدهاند را امتحان کنند.
+
+
+
+
}}" alt="Managing a complex series of parallel contributed topic branches.">
+
+
نمودار 78. مدیریت مجموعهای پیچیده از برنچهای موضوعی موازی مشارکتشده.
+
+
+
اگر موضوعات هنوز احتیاج به کار دارند، بهجای next در pu مرج میشوند.
+وقتی تعیین شد که کاملاً باثبات هستند، موضوعات در master بازادغام میشوند.
+برنچهای next و pu پس از آن از master بازسازی میشوند.
+این به آن معناست که master تقریباً همیشه رو به جلو حرکت میکند، next هر از گاهی ریبیس میشود و pu حتی بیشتر ریبیس میشود:
+
+
+
+
}}" alt="Merging contributed topic branches into long-term integration branches.">
+
+
نمودار 79. مرج برنچهای موضوعی مشارکتشده به برنچهای یکپارچهسازی باقدمت.
+
+
+
هنگامی که یک برنچ موضوعی بالآخره به master مرج شده، از مخزن حذف میشود.
+پروژهٔ گیت علاوه بر این یک برنچ maint دارد که از آخرین انتشار فورک میشود تا پچهای بکپورت را ارائه کند، در حالتی که انتشار نگهدارندهای لازم باشد.
+بنابراین وقتی مخزن گیت را کلون میکنید چهار برنچ دارید که میتوانید برای ارزیابی پروژه در مراحل مختلف توسعه، با توجه به اینکه چقدر میخواهید بروز باشید یا چگونه میخواهید مشارکت کنید، چکاوت کنید؛
+و نگهدارنده یک روند کاری ساختاریافته برای کمک به تیمار مشارکتهای جدید دارد.
+روند کاری پروژهٔ گیت تخصصیشده است.
+برای درک بهتر این موضوع میتوانید به راهنمای نگهدارندهٔ گیت مراجعه کنید.
+
+
+
+
روند کاری ریبیس و چری-پیک
+
+
+دیگر نگهدارندهها ترجیح میدهند که کار مشارکتشده را بجای مرج به نوک برنچ master خود ریبیس یا چری-پیک کنند تا بیشتر تاریخچه را خطی نگهدارند.
+هنگامی که کار خود را در یک برنچ موضوعی دارید و تصمیم گرفتهاید که آنرا یکپارچه کنید، به آن برنچ میروید و دستور ریبیس را برای بازسازی تغییرات روی نوک برنچ master (یا develop و امثالهم) اعمال میکنید.
+اگر درست کار کرد، میتوانید برنچ master خود را fast-forward کنید و به یک تاریخچهٔ خطی برخواهید خورد.
+
+
+
+راه دیگر انتقال کار ارائه شده از یک برنچ به برنچ دیگر چری-پیک کردن آن است.
+یک چری-پیک (دستچینی) مانند ریبیس برای یک کامیت واحد است.
+این عملیات پچی که در یک کامیت ارائه شده را میگیرید و سعی میکنید که آنرا روی برنچی که در حال حاضر روی آن هستید بازاعمال کند.
+اگر تعدادی کامیت روی یک برنچ موضوعی دارید و فقط میخواهید یکی از آنها را اعمال کنید یا اگر یک کامیت روی یک برنچ موضوعی دارید و ترجیح میدهید که بجای ریبیس آنرا دستچین کنید، این دستور مفید است.
+به طور مثال، فرض کنید که پروژهای شبیه این دارید:
+
+
+
+
}}" alt="Example history before a cherry-pick.">
+
+
نمودار 80. مثال تاریخچهای قبل از چری-پیککردن.
+
+
+
اگر میخواهید تغییرات کامیت e43a6 را به برنچ master خود پول کنید میتوانید دستور زیر را اجرا کنید:
+
+
+
+
$ git cherry-pick e43a6
+Finished one cherry-pick.
+[master]: created a0a41a9: "More friendly message when locking the index fails."
+ 3 files changed, 17 insertions(+), 3 deletions(-)
+
+
+
+
این کار همان تغییراتی را که در e43a6 معرفی شدهاند را پول میکند، لکن یک کامیت جدید با یک مقدار SHA-1 جدید خواهید گرفت چرا که تاریخ اعمال شدن آن متفاوت است.
+حال تاریخچهٔ شما شبیه به این است:
+
+
+
+
}}" alt="History after cherry-picking a commit on a topic branch.">
+
+
نمودار 81. تاریخچه پس از چری-پیک کردن یک کامیت از یک برنچ موضوعی.
+
+
+
حال میتوانید برنچ موضوعی را پاک کنید و کامیتهایی را که نمیخواستید پول کنید پاک کنید.
+
+
+
+
ررره
+
+
+اگر کلی ریبیس و مرج انجام میدهید و یک برنچ موضوعی باقدمت را نگهداری میکنید، گیت قابلیتی با نام «rerere» دارد که به شما کمک میکند.
+
+
+
ررره مخفف «Reuse Recorded Resolution» — راهی برای مخفف کردن حل کردن دستی تداخلات — است.
+هنگامی که ررره فعال است، گیت مجموعهای از ایمیجهای پیش و پس از مرج موفق را نگه میدارد و پس از این اگر متوجه شد که تداخلی دقیقاً مشابه چیزی که سابقاً حل کردهاید وجود دارد،
+بدون اینکه سر شما را درد بیاورد، خودش از راهحل سابق شما استفاده میکند.
+
+
+
این ویژگی با دو بخش میآید: گزینه تنظیمات و یک دستور.
+گزینهٔ تنظیمات آن rerere.enabled است و آنقدر کاربرد دارد که آنرا در تنظیمات جهانی خود قرار دهید:
+
+
+
+
$ git config --global rerere.enabled true
+
+
+
+
حال هرگاه که مرجی که تداخلی را حل میکند انجام دهید، برای روز مبادا حلال آن در کش ذخیره میشود.
+
+
+
اگر لازم است میتوانید با کش ررره به وسیلهٔ دستور git rerere تعامل داشته باشید.
+هنگامی که تنها اجرا شود، گیت پایگاه دادهٔ حلالهایش را چک میکند و سعی میکند تطبیقی با هر تداخل مرج فعلی پیدا کرده و آن را حل کند
+(اگرچه اگر rerere.enabled روی true تنظیم شده باشد این کار به طور خودکار انجام میشود).
+همچنین زیردستوراتی برای مشاهدهٔ آنچه که ذخیره خواهد شد، پاک کردن حلالهای خاص از کش و پاک کردن کل کش وجود دارد.
+ررره را با جزئیات بیشتر در Rerere مورد بررسی قرار میدهیم.
+
+
+
+
برچسب زدن انتشاراتتان
+
+
+هنگامی که تصمیم گرفتید نسخهٔ انتشاری تهیه کنید، احتمالاً خواهید خواست که تگ متناسبی برای اینکه بتوانید آن انتشار را در آینده بازسازی کنید اعمال کنید.
+شما میتوانید مطابق آنچه که در مقدمات گیت توصیف شد تگ جدیدی ایجاد کنید.
+اگر به عنوان نگهدارنده تصمیم گرفتهاید که تگی را امضا کنید، تگ کردنتان ممکن است شبیه به این باشد:
+
+
+
+
$ git tag -s v1.5 -m 'my signed 1.5 tag'
+You need a passphrase to unlock the secret key for
+user: "Scott Chacon <schacon@gmail.com>"
+1024-bit DSA key, ID F721C45A, created 2009-02-09
+
+
+
+
اگر تگهایتان را امضا میکنید، ممکن است مسئله انتشار کلید PGP عمومی مورد استفاده در تگها را نیز داشته باشید.
+نگهدارندههای پروژه گیت این مشکل را با اضافه کردن کلید عمومی خود به عنوان یک بلاب به مخزن و سپس اضافه کردن تگی که مستقیماً به آن محتوا اشاره میکند حل کردهاند.
+برای انجام این کار میتوانید با اجرای gpg --list-keys دریابید چه کلیدی را میخواهید:
+
+
+
+
$ gpg --list-keys
+/Users/schacon/.gnupg/pubring.gpg
+---------------------------------
+pub 1024D/F721C45A 2009-02-09 [expires: 2010-02-09]
+uid Scott Chacon <schacon@gmail.com>
+sub 2048g/45D02282 2009-02-09 [expires: 2010-02-09]
+
+
+
+
سپس میتوانید مستقیماً کلید را به پایگاهداده گیت به واسطهٔ صادر و پایپ کردن آن به git hash-object وارد کنید، که یک بلاب جدید با آن محتوا در گیت میسازد و به شما SHA-1 بلاب را میدهد.
+
+
+
+
$ gpg -a --export F721C45A | git hash-object -w --stdin
+659ef797d181633c87ec71ac3f9ba29fe5775b92
+
+
+
+
حال که محتوای کلید خود را در گیت دارید، میتوانید یک تگ که با مقدار SHA-1 جدیدی که دستور hash-object به شما داد، مستقیماً به آن اشاره میکنید بسازید:
+
+
+
+
$ git tag -a maintainer-pgp-pub 659ef797d181633c87ec71ac3f9ba29fe5775b92
+
+
+
+
اگر دستور git push --tags را اجرا کنید تگ maintainer-pgp-pub با همه به اشتراک گذاشته میشود.
+اگر شخصی بخواهد که صحت یک تگ را تأیید کند میتواند با پول مستقیم بلاب کلید PGP شما از پایگاهداده و وارد کردن مستقیم آن به GPG این کار را انجام دهد:
+
+
+
+
$ git show maintainer-pgp-pub | gpg --import
+
+
+
+
همچنین افراد میتوانند که از آن کلید برای تأیید صحت تمام تگهایی که شما امضا کردهاید استفاده کنند.
+همچنین اگر دستورالعملهایی را در پیغام تگ اضافه کنید، git show <tag> به کاربر نهایی دستورات دقیقتر دربارهٔ تأیید صحت تگ را نشان میدهد.
+
+
+
ساختن یک شمارهٔ بیلد
+
+
+از آنجایی که گیت شمارههای افزایشی یکنواختی مانند v123 یا معادل آنرا ندارد تا به هر کامیت اعمال کند، اگر میخواهید یک نام خوانا با یک کامیت ارائه شود میتوانید git describe را روی آن کامیت اجرا کنید.
+در جواب گیت رشتهای محتوی نام جدیدترین تگهایی که پیش از آن کامیت معرفی شدهاند میسازد که به همراه شمارهٔ کامیت از زمان آن تگ و در آخر بخشی از مقدار SHA-1 کامیت توصیفشده میباشد (با پیشوند «g» به معنی گیت):
+
+
+
+
$ git describe master
+v1.6.2-rc1-20-g8c5b85c
+
+
+
+
از این طریق میتوانید یک اسنپشات یا بیلد صادر کنید و آنرا با نامی قابل فهم برای مردم نامگذاری کنید.
+فیالواقع اگر گیت را از سورس کد کلون شده از مخزن گیت بسازید git --version به شما چیزی را مشابه با همین نشان میدهد.
+اگر کامیتی را توصیف (describe) میکنید که به طور مستقیم تگ کردهاید، صرفاً به شما نام تگ را میدهد.
+
+
+
به طور پیشفرض دستور git describe به تگهای توصیفشده احتیاج دارد (تگهایی که با فلگهای -a یا -s ساخته شدهاند)؛
+اگر میخواهید از مزیتهای تگهای سبک (توصیف نشده) هم استفاده کنید، آپشن --tags را نیز به دستور اضافه کنید.
+همچنین میتوانید از این رشته برای دستور git checkout یا git show استفاده کنید، هرچند وابسته به مقدار SHA-1 مختصر در آخر خروجی است که ممکن است همیشه کارا نماند.
+به طور مثال هستهٔ لینوکس از ۸ به ۱۰ حرف پرید تا از یکتا بودن آبجکتهای SHA-1 مطمئن باشد، بنابراین نامهای خروجیهای قدیمی git describe نامعتبر شدند.
+
+
+
آمادهسازی یک انتشار
+
+
+حال میخواهید یک بیلد را منتشر کنید.
+یکی از چیزهایی که میخواهید انجام دهید ساختن آرشیوی از آخرین اسنپشاتهای کدتان برای آن دسته از بیچارگانی است که از گیت استفاده نمیکنند.
+دستور این کار git archive است:
+
+
+
+
$ git archive master --prefix='project/' | gzip > `git describe master`.tar.gz
+$ ls *.tar.gz
+v1.6.2-rc1-20-g8c5b85c.tar.gz
+
+
+
+
اگر شخصی آن تاربال را باز کند، آخرین اسنپشات پروژه شما را زیر یک پوشهٔ project نام پیدا میکند.
+همچنین شما میتوانید یک آرشیو زیپشده را به شکل مشابهی بسازید، اما با فرستادن آپشن --format=zip به git archive:
+
+
+
+
$ git archive master --prefix='project/' --format=zip > `git describe master`.zip
+
+
+
+
حال میتوانید یک زیپ و تاربال زیبا از انتشار پروژهٔ خود داشته باشید تا بتوانید آنرا روی وبسایت خود آپلود کرده یا به دیگران ایمیل کنید.
+
+
+
شورتلاگ
+
+
+وقت این است که به لیست ایمیل افرادی که میخواهند بدانند چه اتفاقی در پروژه افتاده ایمیل بزنید.
+یک راه مفید سریع برای گرفتن نوعی لاگ تغییراتی که زمان آخرین انتشار یا ایمیل به پروژه شما اضافه شده استفاده از دستور git shortlog است.
+این دستور تمام کامیتهای بردی را که به آن دادهاید را خلاصه میکند؛ به طور مثال، اگر انتشار قبلی شما v1.0.1 نام داشت، دستور زیر به شما خلاصهای از تمام کامیتهایی که از انتشار قبل داشتهاید را میدهد:
+
+
+
+
$ git shortlog --no-merges master --not v1.0.1
+Chris Wanstrath (6):
+ Add support for annotated tags to Grit::Tag
+ Add packed-refs annotated tag support.
+ Add Grit::Commit#to_patch
+ Update version and History.txt
+ Remove stray `puts`
+ Make ls_tree ignore nils
+
+Tom Preston-Werner (4):
+ fix dates in history
+ dynamic version method
+ Version bump to 1.0.2
+ Regenerated gemspec for version 1.0.2
+
+
+
+
خلاصهای از تمام کامیتهایی را که میتوانید به لیستتان ایمیل بزنید، از v1.0.1 به بعد با دستهبندی بر اساس نویسنده، میگیرید.
+
+
HTTP هوشمند
+
+
+
تا اینجا، ما از طریق SSH و git:// تصدیق هویت انجام دادیم، اما پروتکل دیگری هم وجود دارد که میتواند هر دو حالت را در آن واحد پشتیبانی کند.
+راهاندازی HTTP هوشمند به طور کل فعالسازی یک اسکریپت CGI همراه گیت با نام git-http-backend روی سرور است.
+این CGI، مسیر و هدری را که با git fetch یا git push به یک HTTP URL ارسال شدهاند، میخواند و تعیین میکند که
+آیا کلاینت میتواند بر بستر HTTP ارتباط برقرار کند یا خیر (که پاسخ برای هر کلاینت نسخه 1.6.6 بالاتر بله است).
+اگر CGI ببنید که کاربر هوشمند است به صورت هوشمند با او ارتباط برقرار میکند؛ در غیر این صورت به رفتار جاگیزین غیرهوشمند
+باز میگردد (بنابراین سازگار با کلاینتهای قدیمی است).
+
+
اجازه دهید تا گام به گام این راهاندازی خیلی ابتدایی را دنبال کنیم.
+ما این را با آپاچی، به عنوان سرور CGI، انجام خواهیم داد.
+اگر آپاچی را نصب ندارید، میتوانید روی یک سیستم لینوکسی با دستوری مانند این آنرا نصب کنید:
+
+
+
$ sudo apt-get install apache2 apache2-utils
+$ a2enmod cgi alias env
+
+
+
این کار همچنین ماژولهای mode_cgi، mode_alias و mode_env را فعال میکند که احتمالاً همه لازمه کارکرد درست این اسکریپت هستند.
+
+
همچنین نیاز خواهید داشت که گروه کاربری یونیکس (Unix user group) پوشههای /srv/git را www-data قرار دهید تا وب سرورتان بتواند دسترسیهای مخازن را بنویسد و بخواند، چراکه اینستنس آپاچی که اسکریپت CGI را
+اجرا میکند (به صورت پیشفرض) به عنوان آن کاربر فعالیت میکند:
+
+
+
$ chgrp -R www-data /srv/git
+
+
+
سپس لازم داریم تا چند مورد را به تنظیمات آپاچی اضافه کنیم تا git-http-backend به عنوان هندلر هر چیزی که به مسیر /git وب سرور شما بیاید اجرا شود.
+
+
+
SetEnv GIT_PROJECT_ROOT /srv/git
+SetEnv GIT_HTTP_EXPORT_ALL
+ScriptAlias /git/ /usr/lib/git-core/git-http-backend/
+
+
+
اگر شما متغییر GIT_HTTP_EXPORT_ALL را حذف کنید، گیت مخازنی را به کلاینتهای احراز هویت نشده ارائه میکند که فایل git-daemon-export-ok درون آنهاست، همانگونه که دیمن گیت این کار را میکرد.
+
+
در آخر، احتمالاً با یک بلاک تصدیق هویت مثل این خواهید خواست که به آپاچی بگویید درخواستهای git-http-backend را مجاز بداند و به طریقی نوشتنها را احراز شده کند:
+
+
+
<Files "git-http-backend">
+ AuthType Basic
+ AuthName "Git Access"
+ AuthUserFile /srv/git/.htpasswd
+ Require expr !(%{QUERY_STRING} -strmatch '*service=git-receive-pack*' || %{REQUEST_URI} =~ m#/git-receive-pack$#)
+ Require valid-user
+</Files>
+
+
+
آن از شما را مستلزم به ساختن یک فایل .htpasswd خواهد کرد که شامل رمزهای عبور همهٔ کاربران تأیید شده است.
+اینجا یک مثال از اضافه کردن کاربری به نام «schacon» به فایل هست:
+
+
+
$ htpasswd -c /srv/git/.htpasswd schacon
+
+
+
صدها راه برای وادار کردن آپاچی به تصدیق هویت کاربران وجود دارد، شما باید یکی را انتخاب و پیادهسازی کنید.
+این صرفاً سادهترین مثالی بود که ما میتوانستیم تألیف کنیم.
+قریب به یقین، پس از این شما خواهید خواست تا این را با پروتکل SSL هم راهاندازی کنید تا تمام این دادهها رمزنگاری باشند.
+
+
ما نمیخواهیم خیلی به جزئیات پیکربندی آپاچی بپردازیم، ازآنجایی که ممکن است شما از یک سرور متفاوت استفاده کنید یا نیازهای احراز هویتی متفاوتی داشته باشید.
+مفهوم کلی این است که گیت به همراه CGI که آن را git-http-backend مینامیم همراه است که هنگامی که صدا زده میشود تمام مذاکرات لاز برای ارسال و دریافت داده بر بستر HTTP را انجام میدهد.
+این به تنهایی و توسط خودش هیچ احراز هویتی انجام نمیدهد، اما میتواند به سادگی در لایه وب سروری که آنرا صدا میزند کنترل شود.
+شما میتوانید این کار را با هر وب سرور با پشتبانی از CGI انجام دهید، بنابراین سراغ موردی بروید که به بهترین نحو میشناسید.
+
خلاصه
+
+
شما چندین گزینه برای راهاندازی و به کار انداختن یک مخزن ریموت گیت دارید تا با دیگران همکاری کنید یا کارتان را به اشتراک بگذارید.
+
+
راهاندازی سرور شخصی خودتان دسترسیها و کنترلهای زیادی به شما میدهد و به شما اجازه میدهد تا سرور را در فایروال خودتان اجرا کنید، امامعمولاً راهاندازی و نگهداری چنین سروری نیازمند سهم زیادی از وقت شماست.
+اگر دادههای خود را بر روی یک سرور میزبانی شده قرار دهید، راهاندازی و نگهداری آن آسان خواهد بود؛ با این حال شما باید قادر باشید تا
+کد خود را بر روی سرورهای شخص دیگری نگهداری کنید و بعضی از سازمانها این اجازه را نمیدهند.
+
+
تعیین این که چه راهحل یا ترکیبی از راهحلها مناسب شما و سازمان شما است باید نسبتاً ساده باشد.
+
دیمن گیت
+
+
+در مرحله بعد یک دیمن میزبان مخازن را با پروتکل «گیت» راه خواهیم انداخت.
+این انتخاب رایج برای دسترسی سریع و تصدیق هویت نشده به دادههای گیتتان است.
+یادتان باشد که از آنجایی که این یک سرویس تصدیق هویت شده نیست، هر چیزی که بر پایه این پروتکل در شبکه میزبانی شود، عمومی است.
+
+
اگر این پروتکل را روی سروری خارج از فایروال خود اجرا میکنید، بهتر است فقط برای پروژههایی که به صورت عمومی برای تمام جهان قابل مشاهده است استفاده شود.
+اگر سروری که با آن سروکار دارید درون فایروالتان است، ممکن است از آن برای پروژههای که تعداد کثیری از مردم یا کامپیوترها (یکپارچهسازی مداوم یا سرورهای ساخت)
+به آن دارند دسترسی فقط-خواندن استفاده کنید، زمانی که نخواهید برای هر کدام یک کلید SSH اضافه کنید.
+
+
در هر صورت نصب و راهاندازی پروتکل گیت نسبتاً آسان است.
+اصولاً، لازم است این دستور را مانند دیمنهای دیگر (دیمنیزه) اجرا کنید:
+
+
+
$ git daemon --reuseaddr --base-path=/srv/git/ /srv/git/
+
+
+
آپشن --reuseaddr به سرور این امکان را میدهد که بدون اینکه لازم باشد تا اتصالات قدیمی تایم-اوت دهند ریسارت شود، مادامی که آپشن --base-path
+به مردم اجازه میدهد تا بدون وارد کردن کامل مسیر ورودی پروژه را کلون کنند و مسیر در آخر به دیمن گیت خواهد گفت در کجا به دنبال مخازن برای خروجی گرفتن بگردد.
+اگر فایروال دارید، مستلزم خواهید بود که تا راهی بر روی پورت ۹۴۱۸ روی آن باز کنید.
+
+
با توجه به سیستمعاملی که استفاده میکنید، چندین راه برای دیمنیزه کردن این فرآیند دارید.
+
+
از آنجایی که systemd یکی از رایجترین اینیتسیستمها بین توزیعهای مدرن لینوکس است، میتوانید از آن برای این کار استفاده کنید.
+خیلی ساده، فایلی را با محتویات زیر در /etc/systemd/systemm/git-daemon.service قرار دهید:
+
+
+
[Unit]
+Description=Start Git Daemon
+
+[Service]
+ExecStart=/usr/bin/git daemon --reuseaddr --base-path=/srv/git/ /srv/git/
+
+Restart=always
+RestartSec=500ms
+
+StandardOutput=syslog
+StandardError=syslog
+SyslogIdentifier=git-daemon
+
+User=git
+Group=git
+
+[Install]
+WantedBy=multi-user.target
+
+
+
ممکن است متوجه شده باشید که دیمن گیت اینجا با git، هم به عنوان گروه و کاربر، شروع شده است.
+آن را با توجه به نیاز خود اصلاح کنید و مطمئن شوید که کاربر نام برده در سیستم وجود دارد.
+همچنین، چک کنید که باینری گیت در مسیر /usr/bin/git قرار داشته باشد و اگر لازم است مسیرش را تغییر دهید.
+
+
در آخر، دستور systemctl enable git-daemon را اجرا خواهید کرد تا این سرویس به صورت خودکار در موقع بوت سیستم نیز اجرا شود،
+و همچنین میتوانید این سرویس را، به ترتیب با دستورهای systemctl start git-daemon و systemct stop git-daemon، شروع یا متوقف کنید.
+
+
بعد، باید به گیت بگویید که برای کدام مخازن اجازه دسترسی بدون تصدیق هویت وجود داشته باشد.
+میتوانید این کار را برای هر مخزن با ساخت یک فایل به نام git-daemon-export-ok انجام دهید.
+
+
+
$ cd /path/to/project.git
+$ touch git-daemon-export-ok
+
+
+
حضور آن فایل به گیت میگوید که میزبانی این پروژه بدون تصدیق هویت مشکلی ندارد.
+
راهاندازی گیت در سرور
+
+
در این بخش درباره راهاندازی یک سرور گیت که اینپروتکلها را اجرا میکند خواهیم خواند.
+
+
+
+|
+ یادداشت
+ |
+
+
+ ما در اینجا مراحل اولیه و ساده نصب و راهاندازی بر روی سرور مبتنی بر لینوکس را یاد خواهیم گرفت، اگرچه راهاندازی این سرویسها بر روی مک و ویندوز نیز امکانپذیر هستند.
+در واقع راهاندازی چنین سروری در سیستمهای شما از نظر ابزاری و امنیتی مشکلات و تفاوتهای زیادی را درپی خواهد داشت اما در هر صورت هدف ما، ارائه یک ایدهٔ کلی درباره راهاندازی سرور گیت به شما است.
+ |
+
+
+
+
برای راهاندازی اولیه هر سرور گیت، باید یک مخزن موجود را به یک مخزن بِر جدید صادر کنیم — مخزنی که شامل هیچ working directory نباشد.
+معمولاً این کار بسیار ساده است.
+برای اینکه مخزن خود را کلون کنید و یک مخزن بر جدید بسازید، دستور clone را با آپشن --bare اجرا میکنید.
+به طور قرار دادی، نامهای پوشه مخزن بر با پسوند git. تمام میشود، به این صورت:
+
+
+
$ git clone --bare my_project my_project.git
+Cloning into bare repository 'my_project.git'...
+done.
+
+
+
در حال حاضر شما باید یک کپی از اطلاعات پوشه گیت در پوشه my_project.git خود داشته باشید.
+
+
تقریباً و به طور خیلی کلی این معادل چنین چیزی است:
+
+
+
$ cp -Rf my_project/.git my_project.git
+
+
+
مقدار کمی تفاوتهای جزئی در فایل پیکربندی وجود دارد اما برای هدف شما، این تقریباً همان کار را میکند.
+خودش مخزن گیت را همراه دارد؛ بدون پوشه کاری و یک پوشه به طور اختصاصی، تنها برای آن میسازد.
+
+
قرار دادن مخزن بِر در سرور
+
+
حالا که شما یک کپی بِر از مخزنتان دارید، تمام کاری باید انجام دهید این است که آن را در یک سرور قرار دهید و پروتکلهای خودتان را نصب و راهاندازی کنید.
+فرض کنیم شما سروری با نام git.example.come را نصب و راهاندازی کردهاید که به آن دسترسی SSH دارید و میخواهید تمام مخزنهای گیت خود را زیر پوشه /srv/git ذخیره کنید.
+فرض کنیم پوشه /srv/git در سرور وجود دارد، شما میتوانید مخزن جدید خود را با کپی کردن مخزن بِر به آنجا راهاندازی کنید:
+
+
+
+
$ scp -r my_project.git user@git.example.com:/srv/git
+
+
+
+
در این لحظه، دیگر کاربران که دسترسی خواندن پوشه /srv/git بر بستر SSH در آن سرور را دارند میتوانند مخزن را با استفاده از دستور زیر کلون کنند:
+
+
+
+
$ git clone user@git.example.com:/srv/git/my_project.git
+
+
+
+
اگر یک کاربر با SSH به سرور وارد شود و دسترسی نوشتن به پوشه /srv/git/my_project.git داشته باشد، به طور خودکار دسترسی پوش نیز خواهد داشت.
+
+
+
اگر دستور git init را با آپشن --shared اجرا کنید، گیت به طور خودکار دسترسیهای نوشتن گروه را به مخزن اضافه خواهد کرد.
+توجه داشته باشید که با اجرای این دستور، شما هیچ کامیت، رف، و… دیگری را نابود نخواهید کرد:
+
+
+
+
$ ssh user@git.example.com
+$ cd /srv/git/my_project.git
+$ git init --bare --shared
+
+
+
+
حالا میبینید که گرفتن یک مخزن گیت، ساخت نسخه بِر و قرار دادن آن روی سروری که شما و مشارکت کنندگان به آن دسترسی دارید، چقدر ساده است.
+اکنون آماده هستید تا بر روی یک پروژه همکاری کنید.
+
+
+
خیلی مهم است که به خاطر داشته باشید که این به معنای واقعی کلمه تمام چیزی هست که نیاز دارید تا یک سرور گیت کاربردی راهاندازی کنید که
+چندین کاربر به آن دسترسی دارند — فقط حسابهایی با قابلیت SSH به سرور اضافه کنید و مخزن بِر را جایی بگذارید تا همهٔ کاربران دسترسی خواندن و نوشتن به آن داشته باشند.
+حالا شما آماده کار هستید — هیچ کار دیگری نیاز نیست.
+
+
+
در چند قسمت بعدی، خواهید دید که نحوه گسترش راهاندازیهای پیچیدهتر چگونه است.
+این بحث شامل مجبور نبودن به ساخت حسابهای کاربری به ازای هر کاربر، اضافه کردن دسترسی خواندن عمومی به مخزنها، راهاندازی رابطهای کاربری وب و بیشتر خواهد بود.
+با این حال، به خاطر داشته باشید که تمام چیزی که برای مشارکت با تعدادی کمی از افراد بر روی یک پروژه خصوصی لازم دارید، یک مخزن بِر و یک سرور SSH است.
+
+
+
راهاندازیهای کوچک
+
+
اگر شما گروه کوچکی هستید یا فقط درحال امتحان گیت در سازمانتان هستید و تعداد کمی توسعهدهنده دارید، برای شما خیلی چیزها میتواند ساده باشند.
+یکی از پیچیدهترین جنبههای راهاندازی سرور گیت مدیریت کاربران است.
+اگر شما بخواهید بعضی از مخزنها، برای کاربران مشخصی فقط خواندنی و برای دیگران نوشتنی/خواندنی باشند، مدیریت و تعیین دسترسی و سطح دسترسیها میتواند کمی سختتر باشد.
+
+
+
دسترسی SSH
+
+
+اگر سروری دارید که همهٔ توسعهدهندگان شما از قبل به آن دسترسی SSH دارند، عموماً راحتترین جا برای راهاندازی اولین مخزنتان است،
+چرا که تقریباً هیچکاری نیاز نیست انجام دهید (همانطور که در بخش آخر درباره آن گفته بودیم).
+اگر انواع پیچیدهتری از مجوزهای کنترل دسترسی بر روی مخزنتان میخواهید، میتوانید آنها را به وسیله مجوزهای معمولی فایلسیستم در سیستمعامل سرور خود کنترل کنید.
+
+
+
اگر میخواهید مخزنتان را در سروری قرار دهید که هیچ حساب کاربری برای هیچ یک از اعضای تیم شما که میخواهید به آنها دسترسی نوشتن اعطا کنید ندارد، باید برای آنها دسترسی SSH راهاندازی کنید.
+ما فرض میکنیم که اگر شما سروری دارید که میخواهید با آن این کار را کنید، از قبل سرور SSH نصب شده دارید و نحوه دسترسی شما به سرور هم همین است.
+
+
+
چندین راه وجود دارد که میتوانید از طریق آنها اجازه دسترسی به هر شخص در تیمتان بدهید.
+اول راهاندازی حسابهای کاربری برای همه است که ساده است، اما میتواند دستوپاگیر باشد.
+ممکن است نخواهید هربار دستور adduser (یا دستور جایگزین احتمالی useradd) را اجرا کنید و مجبور به تنظیم رمزهای عبور موقتی برای هر کاربر جدید باشید.
+
+
+
دومین روش ساخت یک حساب «git» واحد بر روی دستگاه، درخواست دریافت کلید SSH عمومی از هر کاربری که دسترسی نوشتن دارد و اضافه کردن آن کلید به فایل ~/.ssh/autorized_keys آن حساب جدید «git» است.
+پس از این، همه قادر به دسترسی به آن ماشین به وسیله همان اکانت «git» هستند.
+این کار به هیچ وجه هیچ تأثیری بر روی اطلاعات کامیت نخواهد داشت — کاربر SSH که از طریق آن متصل هستید هیچ تأثیری بر کامیتهایی که شما ضبط کردهاید نمیگذارد.
+
+
+
راه دیگری که میتوانید بروید این است که سرور SSH خود را وادار به احراز هویت از یک سرور LDAP یا نوعی دیگر از منابع تصدیق هویت متمرکزی کنید که شاید از قبل راهاندازی کردهاید.
+تا زمانی که هر کاربر بتواند به دستگاه دسترسی شل داشته باشد، هر مکانیزم تصدیق هویت SSH دیگری که میتوانید به آن فکر کنید باید کار کند.
+
+
+
ساختن کلید عمومی SSH
+
+
+بسیاری از سرورهای گیت به وسیله کلید عمومی SSH تصدیق هویت میکنند.
+برای تهیه کردن یک کلید عمومی، هر کاربر در سیستمتان، در صورتی که ندارد، ملزم است یکی بسازد.
+این فرایند در همهٔ سیستمعاملها یکسان است.
+اول، باید اطمینان حاصل کنید که از قبل کلید کلیدی ندارید.
+به صورت پیش فرض، کلید SSH هر کاربر در پوشه ~/.ssh ذخیره میشود.
+شما میتوانید به سادگی با رفتن به آن پوشه و لیست کردن محتویات آن را بررسی کنید:
+
+
+
$ cd ~/.ssh
+$ ls
+authorized_keys2 id_dsa known_hosts
+config id_dsa.pub
+
+
+
شما به دنبال یک جفت فایل با نامهایی شبیه به id_dsa یا id_rsa و فایلی مشابه با پسوند .pub هستید.
+فایل .pub کلید عمومی شما است و فایل دیگر کلید خصوصی نظیر آن است.
+اگر این فایلها (و یا حتی پوشه .ssh) را ندارید، میتوانید آنها را با اجرای برنامهای به نام ssh-keygen بسازید،
+که همراه پکیج SSH در سیستمعاملهای لینوکس/مک و همراه «گیت برای ویندوز» ارائه میشود:
+
+
+
$ ssh-keygen -o
+Generating public/private rsa key pair.
+Enter file in which to save the key (/home/schacon/.ssh/id_rsa):
+Created directory '/home/schacon/.ssh'.
+Enter passphrase (empty for no passphrase):
+Enter same passphrase again:
+Your identification has been saved in /home/schacon/.ssh/id_rsa.
+Your public key has been saved in /home/schacon/.ssh/id_rsa.pub.
+The key fingerprint is:
+d0:82:24:8e:d7:f1:bb:9b:33:53:96:93:49:da:9b:e3 schacon@mylaptop.local
+
+
+
ابتدا از شما میپرسد که کلید را کجا میخواهید ذخیره کنید (.ssh/id_rsa)، سپس دو بار از شما یک رمز (Passphrase) میخواهد،
+که میتوانید آنرا خالی بگذارید اگر مایل نیستید هر بار که از کلید استفاده میکنید رمز وارد کنید.
+هرچند، اگر از رمزی استفاده میکنید، مطمئن شوید که از آپشن -o در دستور استفاده میکنید؛
+این کار کلید خصوصی را به نحوی ذخیره میکند که در برابر حملات شکستن رمز Brute-force مقاومتر است که فرمت پیشفرض فایل کلید خصوصی است.
+همچنین میتوانید از ابزار ssh-agent برای اجتناب از هر بار رمزعبور وارد کردن رمز عبور استفاده کنید.
+
+
حالا، هر کاربر باید این کار را انجام دهد و کلید عمومی خود را به شما یا هرکسی که سرور گیت را مدیریت میکند ارسال کند (با فرض اینکه شما از سرور SSH استفاده میکند که نیازمند کلیدهای عمومی است).
+تمام کاری که آنها باید انجام دهند کپی کردن محتویات فایل .pub و ایمیل کردن آن به شما است.
+کلید عمومی چیزی شبیه به این است:
+
+
+
$ cat ~/.ssh/id_rsa.pub
+ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAklOUpkDHrfHY17SbrmTIpNLTGK9Tjom/BWDSU
+GPl+nafzlHDTYW7hdI4yZ5ew18JH4JW9jbhUFrviQzM7xlELEVf4h9lFX5QVkbPppSwg0cda3
+Pbv7kOdJ/MTyBlWXFCR+HAo3FXRitBqxiX1nKhXpHAZsMciLq8V6RjsNAQwdsdMFvSlVK/7XA
+t3FaoJoAsncM1Q9x5+3V0Ww68/eIFmb1zuUFljQJKprrX88XypNDvjYNby6vw/Pb0rwert/En
+mZ+AW4OZPnTPI89ZPmVMLuayrD2cE86Z/il8b+gw3r3+1nKatmIkjn2so1d01QraTlMqVSsbx
+NrRFi9wrf+M7Q== schacon@mylaptop.local
+
+
نصب و راهاندازی سرور
+
+
اجازه دهید تا گام به گام به راهاندازی دسترسی SSH روی سرور بپردازیم.
+در این مثال شما از متد authorized_keys برای تصدیق هویت کاربرانتان استفاده خواهید کرد.
+همچنین ما فرض میکنیم که از یک توزیع استاندارد لینوکس مانند اوبونتو استفاده میکنید.
+
+
+
+|
+ یادداشت
+ |
+
+
+ به جای کپی و نصب دستی کلیدهای عمومی، بخش اعظمی از چیزهایی که در اینجا در اینجا توضیح داده شدهاند را میتواند با دستور ssh-copy-id خودکار کرد.
+ |
+
+
+
+
اول یک حساب کاربری git و یک پوشه .ssh برای همان کاربر میسازید.
+
+
+
$ sudo adduser git
+$ su git
+$ cd
+$ mkdir .ssh && chmod 700 .ssh
+$ touch .ssh/authorized_keys && chmod 600 .ssh/authorized_keys
+
+
+
بعد از آن، لازم است که چند کلید عمومی SSH از توسعهدهندگان را به فایل authorized_keys کاربر git اضافه کنید.
+فرض کنیم شما چند کلید عمومی قابل اعتماد دارید و آن را در فایلهای موقتی ذخیره کردهاید.
+مجدداً، کلید عمومی چیزی شبیه به این است:
+
+
+
$ cat /tmp/id_rsa.john.pub
+ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCB007n/ww+ouN4gSLKssMxXnBOvf9LGt4L
+ojG6rs6hPB09j9R/T17/x4lhJA0F3FR1rP6kYBRsWj2aThGw6HXLm9/5zytK6Ztg3RPKK+4k
+Yjh6541NYsnEAZuXz0jTTyAUfrtU3Z5E003C4oxOj6H0rfIF1kKI9MAQLMdpGW1GYEIgS9Ez
+Sdfd8AcCIicTDWbqLAcU4UpkaX8KyGlLwsNuuGztobF8m72ALC/nLF6JLtPofwFBlgc+myiv
+O7TCUSBdLQlgMVOFq1I2uPWQOkOWQAHukEOmfjy2jctxSDBQ220ymjaNsHT4kgtZg2AYYgPq
+dAv8JggJICUvax2T9va5 gsg-keypair
+
+
+
شما آنها را به انتهای فایل authorized_keys در پوشه .ssh کاربر git اضافه میکنید:
+
+
+
$ cat /tmp/id_rsa.john.pub >> ~/.ssh/authorized_keys
+$ cat /tmp/id_rsa.josie.pub >> ~/.ssh/authorized_keys
+$ cat /tmp/id_rsa.jessica.pub >> ~/.ssh/authorized_keys
+
+
+
حالا میتوانید با اجرای دستور git init همراه با آپشن --bare یک مخزن خالی، یا در واقع بدون پوشه کاری، برای آنها راهاندازی کنید:
+
+
+
$ cd /srv/git
+$ mkdir project.git
+$ cd project.git
+$ git init --bare
+Initialized empty Git repository in /srv/git/project.git/
+
+
+
سپس، John، Josie یا Jessica میتوانند با افزودن آن به عنوان یک ریموت و ارائه یک برنچ، اولین نسخه از پروژه خود را به آن مخزن پوش کنند.
+توجه داشته باشید که هر زمان بخواهید پروژه جدیدی بسازید حتماً شخصی باید به شل آن سیستم وصل شود و یک مخزن بِر بسازد.
+حالا بیایید از gitserver به عنوان نام هاست (Hostname) سروری که روی آن مخزن و کاربر git را راهاندازی کردیم استفاده کنیم.
+اگر آن را به صورت داخلی کار میکنید و DNS برای`gitserver` راهاندازی میکنید تا به آن سرور اشاره کند، میتوانید از دستورات، تقریباً،
+همانگونه که هستند استفاده کنید (با فرض اینکه myproject پروژهای از پیش موجود با فایلهایی در خود است).
+
+
+
# on John's computer
+$ cd myproject
+$ git init
+$ git add .
+$ git commit -m 'Initial commit'
+$ git remote add origin git@gitserver:/srv/git/project.git
+$ git push origin master
+
+
+
حال، دیگران میتوانند به راحتی آنرا کلون کنند یا تغییرات را به همین سادگی به سرور پوش کنند:
+
+
+
$ git clone git@gitserver:/srv/git/project.git
+$ cd project
+$ vim README
+$ git commit -am 'Fix for README file'
+$ git push origin master
+
+
+
بدین طریق شما سریعاً میتوانید سرور گیتی با قابلیت خواندن/نوشتن راهاندازی کنید و آن در اختیار توسعهدهندگان قرار دهید.
+
+
باید به این نکته توجه کنید که در حال حاضر تمامی کاربران میتوانند به داخل سرور ورود کنند و به عنوان کاربر git یک شل در دست بگیرند.
+اگر میخواهید از این موضوع جلوگیری کنید، میبایست شل را در داخل /etc/passwd به چیز دیگری تغییر دهید.
+
+
شما به سادگی میتوانید حساب کاربر git را فقط به فعالیتهای مربوط به گیت و با ابزار شل محدودی به نام git-shell که با گیت میآید محدود کنید.
+اگر شما این ابزار را به عنوان شل ورودی حساب کاربری git تنظیم کنید، آن حساب کاربری نمیتواند دسترسی شل معمولی به سرور شما داشته باشد.
+برای انجام این کار، باید ابتدا مسیر کامل دستور git-shell را به /etc/shells اضافه کنید:
+
+
+
$ cat /etc/shells # see if git-shell is already in there. If not...
+$ which git-shell # make sure git-shell is installed on your system.
+$ sudo -e /etc/shells # and add the path to git-shell from last command
+
+
+
حالا میتوانید با استفاده از chsh <username> -s <shell> شل هر کاربر را تغییر دهید:
+
+
+
$ sudo chsh git -s $(which git-shell)
+
+
+
اکنون کاربر git همچنان میتواند از SSH برای پوش و پول از مخازن گیت استفاده کند اما نمیتواند به شل دستگاه وصل شود.
+اگر یکبار امتحان کنید، پیغام رد درخواستی مانند پیغام پایین را مشاهده خواهید کرد:
+
+
+
$ ssh git@gitserver
+fatal: Interactive git shell is not enabled.
+hint: ~/git-shell-commands should exist and have read and execute access.
+Connection to gitserver closed.
+
+
+
در حال حاضر، کاربران همچنان میتوانند از پورت-فورواردینگ SSH برای دسترسی به هر میزبانی که سرور گیت میتواند به آن برسد استفاده کنند.
+اگر میخواهید از این موضوع جلوگیری کنید میتوانید فایل authorized_keys را اصلاح کنید و آپشنهای زیر را پیش از هر کلیدی که میخواهید محدود شود اضافه کنید:
+
+
+
no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty
+
+
+
نتیجه کار باید چیزی شبیه به این باشد:
+
+
+
$ cat ~/.ssh/authorized_keys
+no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty ssh-rsa
+AAAAB3NzaC1yc2EAAAADAQABAAABAQCB007n/ww+ouN4gSLKssMxXnBOvf9LGt4LojG6rs6h
+PB09j9R/T17/x4lhJA0F3FR1rP6kYBRsWj2aThGw6HXLm9/5zytK6Ztg3RPKK+4kYjh6541N
+YsnEAZuXz0jTTyAUfrtU3Z5E003C4oxOj6H0rfIF1kKI9MAQLMdpGW1GYEIgS9EzSdfd8AcC
+IicTDWbqLAcU4UpkaX8KyGlLwsNuuGztobF8m72ALC/nLF6JLtPofwFBlgc+myivO7TCUSBd
+LQlgMVOFq1I2uPWQOkOWQAHukEOmfjy2jctxSDBQ220ymjaNsHT4kgtZg2AYYgPqdAv8JggJ
+ICUvax2T9va5 gsg-keypair
+
+no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty ssh-rsa
+AAAAB3NzaC1yc2EAAAADAQABAAABAQDEwENNMomTboYI+LJieaAY16qiXiH3wuvENhBG...
+
+
+
حالا دستورات شبکه گیت همچنان به خوبی کار خواهند کرد اما کاربران قادر به گرفتن شل نخواهند بود.
+همانطور که خروجی بیان میکند، شما همچنین میتوانید یک پوشه درون پوشه خانه کاربر git بسازید که دستور git-shell را کمی سفارشی میکند.
+برای مثال، میتوانید دستوراتی که سرور قبول خواهد کرد را محدود کنید یا میتوانید پیامی که کاربران در صورت تلاش به استفاده از SSH میبینند را سفارشی سازی کنید.
+برای اطلاعات بیشتر درمورد سفارشی سازی شل git help shell را اجرا کنید.
+
+در این لحظه شما باید قادر باشید که بیشتر وظایف روزمره که برای آنها از گیت استفاده خواهید کرد را انجام دهید.
+با این حال، به منظور انجام هرگونه مشارکت در گیت، لازم است که یک مخزن گیت ریموت داشته باشید.
+با اینکه شما از لحاظ فنی میتوانید تغییرات را از مخزنهای افراد پوش و پول کنید، انجام چنین کاری توصیه نمیشود چرا که اگر مراقب نباشید به سادگی میتوانید چیزی که روی آن کار میکنند را به هم بریزید.
+علاوهبر این شما میخواهید مشارکت کنندههای شما توانایی دسترسی به مخزن را، حتی اگر کامپیوتر شما خاموش باشد داشته باشند — داشتن مخزنی مشترک و قابل اعتمادتر اغلب مفید است.
+بنابراین، روش ارجح برای مشارکت و همکاری با شخصی، راهاندازی یک مخزن واسط است که هر دوی شما به آن دسترسی دارید و به آن پوش و از آن پول میکنید.
راهاندازی یک سرور گیت بسیار راحت و سر راست است.
+اول پروتکلهایی که میخواهید سرور شما از آنها پشتیبانی کند را انتخاب میکنید.
+قسمت اول از این فصل درباره پروتکلهای در دسترس و مزایا و معایب هر کدام خواهد گفت.
+قسمتهای بعدی راهاندازیها و تنظیمات معمولی با استفاده از آن پروتکلها و چگونگی اجرای سرور گیت به وسیلهٔ آنها شرح داده خواهد شد.
+در آخر، اگر مشکلی با میزبانی کدهایتان در سرور شخص دیگری ندارید و نمیخواهید در دردسر تنظیم و راهاندازی سرور گیت شخصی خود بیوفتید، ما درباره چند گزینه میزبانی خواهیم گفت.
اگر علاقهای به راهاندازی سرور خودتان ندارید، میتوانید مستقیماً به قسمت آخر این فصل بروید تا چند گزینه برای راهاندازی یک حساب میزبانی شده ببینید و بعد از آن به فصل بعد بروید که در آن دربارهٔ
+سیر تا پیاز کار در یک محیط کنترل سورس توزیع شده بحث میکنیم.
یک مخزن ریموت به طور کلی یک مخزن بِر (Bare) است — مخزن گیتی که هیچ پوشه کاری ندارد.
+به این دلیل که مخزن فقط به عنوان یک نقطه مشارکت استفاده میشود، هیچ دلیلی برای چکاوت داشتن یک اسنپشات بر روی دیسک وجود ندارد؛ فقط دادههای گیت است.
+به بیان ساده، یک مخزن بِر محتوای پوشه .git پروژه شما است و نه چیز دیگری.
+پروتکلها
+
+
گیت میتواند از چهار پروتکل متفاوت برای جابهجایی دادهها استفاده کند: محلی، HTTP، شل ایمن (SSH) و گیت.
+در اینجا درباره اینکه این پروتکلها چه هستند و اینکه در کدام یک از موقعیتهای پایه ممکن است بخواهید از آنها استفاده کنید یا نکنید بحث خواهیم کرد.
+
+
پروتکل محلی
+
+
+ابتداییترین پروتکل، پروتکل محلی است، که در آن مخزن ریموت در پوشهای دیگر در همان میزبان قرار دارد.
+اکثراً از این پروتکل اگر شخصی در تیم شما به یک فایل سیستم مونت شده دسترسی دارد استفاده میشود یا بعضی وقتا که افراد
+این پروتکل غالباً زمانی استفاده میشود که همه افراد تیم شما به یک فایلسیستم اشتراکی مثلا یک NFS مونت شده دسترسی دارند، یا در موقعیت کمتر رایجی که در آن همه به یک کامپیوتر وارد میشوند.
+موقعیت دوم زیاد ایدهآل نخواهد بود، چون از آنجایی که تمام نمونههای مخزن کد شما در یک کامپیوتر قرار میگیرند، احتمال تخریبهای فاجعهبار را خیلی بیشتر میکنند.
+
+
+
اگه یک فایل سیستم مونت شده اشتراکی دارید، پس میتوانید از یک مخزن فایل-پایهٔ محلی کلون، پوش و پول کنید.
+برای کلون کردن چنین مخزنی، یا اضافه کردن آن به عنوان ریموت به یک پروژه موجود، از مسیر مخزن به عنوان URL استفاده کنید.
+برای مثال، برای کلون کردن یک مخزن محلی میتوانید چنین دستوری را اجرا کنید:
+
+
+
+
$ git clone /srv/git/project.git
+
+
+
+
یا میتوانید این کار را کنید:
+
+
+
+
$ git clone file:///srv/git/project.git
+
+
+
+
اگر در شروع URL صراحتاً file:// را مشخص کنید، گیت کمی متفاوت عمل میکند.
+اگر فقط مسیر را مشخص کنید، گیت سعی میکند از لینکهای سخت استفاده کند یا مستقیماً فایلهایی را که نیاز دارد کپی کند.
+اگر file:// را در مشخص کنید، گیت فرآیندهایی را اجرا میکند که معمولاً برای انتقال داده از شبکه استفاده میکند، که عموماً بسیار کم کارآمدتر هستند.
+دلیل اصلی ارائه پیشوند file:// برای وقتی است که شما یک کپی تمیز از مخزن با رفرنسهای خارجی یا آبجکتهای حذف شده میخواهید — معمولاً هنگام ایمپورت کردن از یک VCS دیگر یا حالتی مشابه (برای مراحل نگهداری به Git Internals مراجعه کنید).
+ما از آدرس مسیر معمولی در اینجا استفاده خواهیم کرد چون این کار تقریباً همیشه سریعتر است.
+
+
+
برای اضافه کردن یک مخزن محلی به یک پروژه گیت موجود، میتوانید از چنین دستوری استفاده کنید:
+
+
+
+
$ git remote add local_proj /srv/git/project.git
+
+
+
+
سپس، میتوانید با نام جدید مخزن local_proj، درست مانند اینکه روی یک شبکه این کار را میکردید، به آن مخزن پوش و از آن پول کنید.
+
+
+
مزایا
+
+
مزایای مخزنهای مبتنی بر فایل این است که ساده هستند و اینکه از مجوزهای فایل موجود و دسترسی شبکه استفاده میکنند.
+اگر شما از قبل یک فایلسیستم اشتراکگذاری شده دارید که همهٔ تیم به آن دسترسی دارند، راهاندازی یک مخزن بسیار آسان است.
+شما نسخه بِر مخزن را جایی که همه دسترسی اشتراکی به آن را دارند میگذارید و مجوزهای خواندن/نوشتن را همانطور که روی هر پوشه اشتراکی دیگری تنظیم میکردید، تنظیم میکنید.
+درباره نحوه صادر کردن یک نسخه بر مخزن برای این کار در راهاندازی گیت در سرور بحث خواهیم کرد.
+
+
+
همچنین این یک گزینه قشنگ برای برداشتن سریع کار از مخزن کاری شخص دیگری است.
+اگر شما و همکارتان در حال کار بر روی یک پروژه هستید و او از شما میخواهد که چیزی را بررسی کنید، اجرای دستوری
+مثل git pull /home/john/project اغلب خیلی راحتتر از این است که او به یک سرور ریموت پوش کند و متعاقباً شما از آن فچ کنید.
+
+
+
+
معایب
+
+
از معایب این متد این است که دسترسی اشتراکی به طور کلی از نظر راهاندازی و دسترسی از چندین موقعیت دشوارتر از دسترسی ساده شبکه است.
+اگر بخواهید از زمانی که خانه هستید از لپتاپتان پوش کنید، باید دیسک ریموت را مونت کنید که میتواند در مقایسه با دسترسی برمبنای شبکه سخت و کند باشد.
+
+
+
لازم به ذکر است که اگر در حال استفاده از مونت اشتراکگذاری شده خاصی هستید، این لزوماً سریعترین گزینه نیست.
+یک مخزن محلی تنها زمانی سریع است که دسترسی سریع به داده آن داشته باشید.
+یک مخزن بر روی NFS گاهاً کندتر از یک مخزن بر روی همان سرور اما به واسطه SSH است، که به گیت اجازه میدهد تا اطلاعات را به دیسکهای محلی هر سیستم منتقل کند.
+
+
+
در نهایت، این پروتکل از مخزن در برابر آسیب تصادفی محافظت نخواهد کرد.
+هر کابری دسترسی شل کامل به پوشه «ریموت» دارد و هیچ چیز جلوگیری آنها را نمیگیرد که فایلهای داخلی گیت را پاک نکنند یا تغییر ندهند و به مخزن آسیب نزنند.
+
+
+
+
پروتکلهای HTTP
+
+
گیت میتواند از طریق HTTP با استفاده از دو حالت متفاوت ارتباط برقرار کند.
+پیش از گیت ۱.۶.۶، فقط یک راه وجود داشت که این کار را انجام میداد که بسیار ساده و به طور کلی فقط-خواندنی بود.
+در نسخه ۱.۶.۶، پروتکل جدید و هوشمندتری معرفی شد که گیت را قادر میساخت تا هوشمندانه بر سر انتقال اطلاعات مذاکره کند همانند کاری SSH انجام میدهد.
+در چند سال اخیر، این نوع جدید از پروتکل HTTP از آنجایی که برای کاربر سادهتر است و نحوه ارتباطاتش هوشمندتر شده است، بسیار محبوب شده اس.
+نسخه جدیدتر را معمولاً پروتکل HTTP «هوشمند» و نسخه قدیمیتر را HTTP «غیرهوشمند» مینامند.
+ما اول درباره پروتکل جدیدتر میگوییم.
+
+
+
HTTP هوشمند
+
+
+پروتکل HTTP هوشمند بسیار شبیه به SSH یا پروتکلهای گیت عمل میکند منتهی بر بستر استاندارد درگاههای HTTPS اجرا میشود و میتواند از مکانیزمهای گوناگون
+تصدیق هویت HTTP استفاده کند، به این معنا که معمولاً برای کاربر از چیزی مثل SSH راحتتر است، چراکه شما میتوانید از چیزهایی مانند
+نام کاربری/رمزعبور برای تصدیق هویت استفاده کنید جای اینکه اجباراً کلیدهای SSH را راهاندازی کنید.
+
+
+
احتمالاً در حال حاضر این محبوبترین راه برای استفاده از گیت است، از آنجا که میتواند تنظیم شود تا هم به طور ناشناس خدمت کند، مانند پروتکل git://
+و همچنین میتواند تنظیم شود تا همراه تصدیق هویت و رمزگذاری مانند پروتکل SSH کار کند.
+به جای اینکه مجبور باشید چندین URL متفاوت برای چنین چیزهایی راهاندازی کنید، حال میتوانید از یک URL برای هر دو استفاده کنید.
+اگر سعی در پوش کردن به مخزن دارید و تصدیق هویت ضروری باشد (که معمولاً هست)، سرور میتواند از شما نام کاربری و رمزعبور درخواست کند.
+همین روند نیز برای دسترسی خواندن وجود دارد.
+
+
+
در واقع، برای سرویسهای مانند گیتهاب، URL که شما برای نمایش آنلاین مخزن خود استفاده میکنید (برای مثال، https://github.com/schacon/simplegit)
+همان URL است که میتوانید برای کلون کردن، و در صورت داشتن دسترسی، پوش کردن استفاده کنید.
+
+
+
+
HTTP غیرهوشمند
+
+
+اگر سرور با پروتکل HTTP هوشمند پاسخ ندهد، کلاینت گیت تلاش میکند تا به پروتکل سادهتر HTTP غیرهوشمند (Dumb) بازگردد.
+پروتکل غیرهوشمند انتظار دارد که مخزن بِر گیت مانند فایلهای معمولی از طرف وب سرور میزبانی شود.
+قشنگی HTTP غیرهوشمند سادگی راهاندازی آن است.
+در اصل، تمام کاری که شما باید انجام دهید این است که مخزن بِر گیت را زیر HTTP داکیومنت-روت قرار دهید و قلاب مشخصی برای post-update («بعد از بروزرسانی»)
+راهاندازی کنید و تمام (به Git Hooks مراجعه کنید).
+
+
+
+
$ cd /var/www/htdocs/
+$ git clone --bare /path/to/git_project gitproject.git
+$ cd gitproject.git
+$ mv hooks/post-update.sample hooks/post-update
+$ chmod a+x hooks/post-update
+
+
+
+
همهٔ کار همین است.
+قلاب post-update که همراه گیت میآید به طور پیش فرض دستورات مناسب را اجرا میکند (git update-server-info) تا فچ و کلون HTTP به درستی کار کنند.
+این دستور زمانی اجرا میشود که شما به این مخزن پوش کنید (احتمالاً بر بستر SSH)؛ سپس دیگر افراد میتوانند توسط چنین چیزی کلون کنند
+
+
+
+
$ git clone https://example.com/gitproject.git
+
+
+
+
در این مورد خاص، ما از مسیر /var/www/htodcs استفاده میکنیم که مرسوم سیستمهای آپاچی است، اما شما میتواند از هر وب سرور ایستای دیگری استفاده کنید — کافیست مخزن بِر را در مسیر آن قرار دهید.
+دادههای گیت به عنوان فایلهای ایستای معمولی میزبانی میشوند (برای جزئیات دقیق نحوهٔ میزبانی شدن به Git Internals مراجعه کنید).
+
+
+
عموماً یا مجبور خواهید شد که یک سرور خواندنی/نوشتنی هوشمند HTTP راهاندازی کنید یا صرفاً فایلها را با دسترسی فقط-خواندنی به روش غیرهوشمند فراهم کنید.
+استفاده از ترکیب این دو سرویس نادر است.
+
+
+
+
مزایا
+
+
ما تمرکزمان را بر روی مزایای نسخه هوشمند پروتکل HTTP خواهیم گذاشت.
+
+
+
سادگی داشتن فقط یک URL برای انواع دسترسیها و داشتن اعلان سرور فقط در زمانی نیاز به که تصدیق هویت، همه چیز را برای کاربر نهایی بسیار ساده میکند.
+قابلیت تصدیق هویت با نام کاربری و رمزعبور بر بستر SSH یک مزیت بزرگ است، چرا که کاربران نیاز به ساخت محلی کلیدهای SSH به صورت محلی و
+آپلود کلید عمومی خود به روی سرور پیش از اجازه گرفتن برای برقراری تعامل با آن ندارند.
+برای کاربرانی که در سطح پایینتری هستند یا کاربران سیستمهایی که SSH روی آنها کمتر متداول است، این مزیت اصلی در استفادهپذیری است.
+همچنین پروتکلی بسیار سریع و کارآمد همانند پروتکل SSH است.
+
+
+
همچنین میتوانید مخزنهای فقط-خواندنی خود را بر بستر HTTPS نیز میزبانی کنید که به این معنا است که شما میتوانید انتقال محتوا را رمزگذاری کنید؛
+یا میتوانید اجبار کلاینتها به استفاده از یک گواهی SSL امضا شده خاص پیش روید.
+
+
+
نکته قشنگ دیگر این است که هر دو پروتکل HTTP و HTTPS پروتکلهایی آنچنان پر استفاده هستند که فایروالهای شرکتی اغلب به نحوی راهاندازی میشوند تا اجازه عبور و مرور از طریق پروتکلها را مجاز بدانند.
+
+
+
+
معایب
+
+
ممکن است بر روی بعضی از سرورها، راهاندازی گیت بر بستر HTTPS به مهارت بیشتری در مقایسه با SSH احتیاج داشته باشد.
+سوای این مورد، مزیتهای خیلی کمی در دیگر پروتکلها در مقایسه با HTTP هوشمند برای میزبانی محتوای گیت است.
+
+
+
اگر از HTTP برای پوش احراز هویت شده استفاده میکنید، تهیه گواهیهایتان گاهی اوقات پیچیدهتر از استفاده از کلیدها بر بستر SSH است.
+با این حال چندین ابزار ذخیرهساز گواهی وجود دارد که میتوانید استفاده کنید که شامل «Keychain access» در سیستمعامل مک و «Credential Manager» در ویندوز است که این مشکل را آسانتر کند.
+بخش Credential Storage را مطالعه کنید تا چگونگی راهاندازی ذخیرهسازی امن رمزعبور بر بستر HTTP بر روی سیستم خودتان را بدانید.
+
+
+
+
پروتکل SSH
+
+
+یک پروتکل رایج انتقال برای گیت به هنگام خودمیزبانی، بر بستر SSH است.
+این به این خاطر است که دسترسی SSH به سرورها در اکثر جاها از قبل راهاندازی شده است — و اگر نشده باشند، راهاندازی آن کار راحتی است.
+همچنین SSH یک پروتکل شبکه تصدیق هویت شده است و چون در همه جا هست، به طور کلی راهاندازی و استفاده از آن آسان است.
+
+
+
برای کلون کردن یک مخزن بر بستر SSH، میتوانید یک آدرس ssh:// مانند این مشخص کنید:
+
+
+
+
$ git clone ssh://[user@]server/project.git
+
+
+
+
یا میتوانید از نگارش علامت گونه («spc-like») کوتاهتر برای پروتکل SSH استفاده کنید:
+
+
+
+
$ git clone [user@]server:project.git
+
+
+
+
در هر دو مورد بالا، اگر نام کاربری اختیاری را تعیین نکنید، گیت نام کاربری را، نام کاربری که در حال حاضر با آن ورود کردهاید پیشفرض میگیرد.
+
+
+
مزایا
+
+
مزایای استفاده از پروتکل SSH بسیار زیاد است.
+اول، SSH نسبتاً راهاندازی سادهای دارد — دیمنهای SSH پیش افتاده هستند، خیلی از مدیریان شبکه تجربه کار با آنها را دارند و خیلی از
+توزیعهای سیستمعاملها همراه آنها راهاندازی میشوند یا ابزارهایی برای مدیریت آنها دارند.
+سپس اینکه، دسترسی بر بستر SSH امن است — کل انتقال دادهها رمزگذاری شده و تصدیق هویت شده است.
+در آخر، مانند HTTPS، گیت و پروتکلهای محلی، SSH نیز کارآمد است، قبل از ارسال اطلاعات تا جایی که ممکن است دادهها را فشرده میکند.
+
+
+
+
معایب
+
+
وجه منفی پروتکل SSH این است که از دسترسی ناشناس به مخزن گیت شما پشتیبانی نمیکند.
+اگر از SSH استفاده میکنید، افراد باید دسترسی SSH به سیستم شما داشته باشند، حتی در حد فقط-خواندن؛ این باعث میشود که SSH
+برای پروژههای متن باز که شاید افراد بخواهند صرفاً مخزن شما را کلون کرده و آن را بررسی کنند مناسب نباشد.
+اگر از SSH فقط در شبکه شرکتی استفاده میکنید، شاید SSH تنها پروتکلی باشد که لازم باشد با آن سروکار داشته باشد.
+اگر میخواهید دسترسی ناشناس فقط-خواندن به پروژههای خود بدهید و همچنان از SSH هم استفاده کنید،
+ ملزم خواهید بود که SSH را برای پوش کردن خودتان، اما برای دیگران چیز دیگری راهاندازی کنید تا از آن فچ کنند.
+
+
+
+
پروتکل گیت
+
+
+در آخر، پروتکل گیت را داریم.
+این پروتکل یک دیمون خاص است که همراه گیت میآید؛ به یک پورت اختصاصی (۹۴۱۸) گوش میکند که یک سرویس شبیه به پروتکل SSH، اما بدون هیچ تصدیق هویتی، ارائه میکند.
+پیش از اینکه یک مخزن برای بر بستر پروتکل گیت میزبانی شود، شما باید یک فایل git-daemon-export-ok بسازید — که دیمن مخزنی را که این فایل را ندارد میزبانی نمیکند — هرچند به جز آن، هیچ ضامن دیگری نیست.
+یا مخزن گیت برای همه در دسترس است تا کلون کند یا نیست.
+این بدین معناست که عموماً پوش کردن بر بستر این پروتکل وجود ندارد.
+شما میتوانید دسترسی پوش را فعال کنید اما، با توجه به نبود تصدیق هویت، هر کسی در اینترنت که URL پروژه شما را پیدا کند میتواند به آن پروژه پوش کند.
+خلاصه اینکه این حالتی نادر است.
+
+
+
مزایا
+
+
پروتکل گیت اغلب سریعترین پروتکل موجود شبکه است.
+اگر حجم عظیمی از ترافیک را برای یک پروژه عمومی یا بزرگ که نیاز به تصدیق هویت کاربر برای دسترسی خواندن ندارد را میزبانی میکنید،
+احتمالاً که خواهید خواست که یک دیمون گیت را برای میزبانی پروژتان راهاندازی کنید.
+این از همان مکانیزم انتقال-اطلاعاتی که پروتکل SSH دارد استفاده میکند اما بدون رمزگذاری و تصدیق هویت.
+
+
+
+
معایب
+
+
نقطه ضعف پروتکل گیت نداشتن تصدیق هویت است.
+اصلاً مطلوب نیست که پروتکل گیت تنها راه دسترسی به پروژه شما باشد.
+عموماً، برای تعدادی از توسعه دهندگان یا برنامهنویسان که دسترسی پوش (نوشتن) دارند آن را با پروتکل SSH یا HTTPS همراه خواهید کرد و
+برای بقیه با دسترسی فقط خواندنی از git://، استفاده خواهید کرد.
+احتمالاً سختترین پروتکلها برای راهاندازی است.
+باید روی دیمون خودش اجرا شود که نیازمند پیکربندی systemd و xinetd یا چیزی مشابه است که میتوان گفت همیشه به آسانی آب خوردن نیست.
+همچنین نیازمند دسترسی فایروال به پورت ۹۴۱۸ است که چون یک پورت استاندارد نیست شاید فایروالهای شرکتی همیشه اجازه آنرا ندهند.
+پشت فایروالهای بزرگ شرکتی غالباً پورتهای ناامن این چنینی را مسدود هستند.
+
+
+
گزینههای شخصی ثالث میزبانی شده
+
+
اگر نمیخواهید وارد تمام این فرآیند و کار راهاندازی سرور گیت شخصیتان شوید، گزینههای معتددی برای میزبانی پروژه گیت خود روی سایتهای میزبانی اختصاصی خارجی پیش رو دارید.
+این کار چندین مزایت برای شما دارد: یک سایت میزبانی به طور کلی راهاندازی و نصب سریعی دارد و شروع پروژهها روی آن آسان است و هیچ نگهداری سرور یا مانیتورینگ در کار نیست.
+حتی اگر شما سرور داخلی خودتان را نصب و راهاندازی کنید، شاید هنوز بخواهید از میزبانهای عمومی برای پروژه متن-باز خود استفاده کنید –
+معمولاً اینگونه برای جامعه متن-باز آسانتر است تا پروژه را پیدا و شما را در آن یاری کنند.
+
+
این روزها، تعداد عظیمی از میزبانیهای وب دارید که میتوانید از بین آن یکی را انتخاب کنید که هر کدام مزایا و معایب خود را دارد.
+برای دیدن لیستی به روز، صفحه GitHosting بر روی ویکی اصلی گیت را به آدرس https://git.wiki.kernel.org/index.php/GitHosting بررسی کنید.
+
+
ما به جزئیات بیشتر استفاده از گیتهاب رادر بخش GitHub توضیح خواهیم داد؛
+از آنجایی که گیتهاب بزرگترین میزبان گیت است و به هر طریقی شاید نیاز داشته باشید تا با پروژههایی که آنجا میزبانی میشوند تعامل برقرار کنید،
+لکن در صورتی که نمیخواهید سرور گیت خودتان را راهاندازی کنید، هزاران گزینه دیگر برای شما وجود دارد تا از بین آنها انتخاب کنید.
+
گیتلب
+
+
+با این همه گیتوب بسیار ساده است.
+اگر به دنبال یک گیت سرور مدرنتر و با امکانات کامل هستید، چنیدن راه حل متن-باز موجود جایگزین موجود است که میتوانید نصب کنید.
+از آنجایی که گیتلب یکی از معروفترینهاست، ما نصب و استفاده از آن را به عنوان یک مثال بررسی خواهیم کرد.
+این مورد کمی پیچیدهتر از گزینه گیتوب است و احتمالاً نگهداری بیشتری نیز میطلبد، اما گزینهای با امکانات بسیار کاملتر است.
+
+
نصب
+
+
گیتلب یک نرمافزار وب مبتنی بر پایگاهداده است، بنابراین نصب آن کمی درگیرکنندهتر از بعضی دیگر از گیت سرورها است.
+خوشبختانه، این فرآیند کاملاً پشتیبانی شده و به خوبی مستند شده است.
+
+
+
چندین متد و راه برای دنبال کردن نصب گیتلب وجود دارد.
+بری شروع سریع، میتوانید یک ایمیج ماشین مجازی یا نرمافزار نصب آسان از https://bitnami.com/stack/gitlab دانلود کنید، و تنظیمات آنرا ویرایش کنید تا متناسب با محیط شما شود.
+یکی از کارهای قشنگ Bitnami شامل کردن یک صفحه لاگین است (قابل دسترسی با تایپ →+alt)؛ این صفحه به شما آدرس آیپی و نامکاربری و رمز پیشفرض گیتلب نصب شده را میگوید.
+
+
+
+
}}" alt="The Bitnami GitLab virtual machine login screen.">
+
+
نمودار 50. صفحه لاگین ماشین مجازی گیتلب Bitnami.
+
+
+
برای هر چیز دیگری، راهنماییهای در فایل readme گیتلب ویرایش جامعه را بخوانید که در آدرس
+https://gitlab.com/gitlab-org/gitlab-ce/tree/master پیدا میشود.
+آنجا با استفاده از فرمول سرآشپز، ماشین مجازی روی Digital Ocean، پکیجهای RPM و DEB (که به وقت این نوشته در بتا هستند) کمک خواهید یافت.
+ همچنین یک راهنما «غیررسمی» راهاندازی گیتلب با سیستمعاملها و پایگاهدادههای غیراستاندارد، یک اسکریپت نصب دستی و بسیاری تاپیکهای دیگر موجود است،
+
+
+
مدیریت
+
+
رابط مدیریتی گیتلب به وسیله وب قابل دسترسی است.
+کافیست مرورگر خود را به آدرس هاست یا آدرس آیپی جایی که گیتلب در آنجا نصب شده است هدایت کنید، و به عنوان کاربر مدیر وارد شوید.
+نام کاربری پیش فرض admin@local.host و رمز عبور پیش 5iveL!fe است (که به محض ورود برای تغییر آن به شما اعلان داده میشود).
+هنگامی که وارد شدید بر روی آیکن بالا سمت راست منو «Admin area» کلیک کنید.
+
+
+
+
کاربران
+
+
کابران در گیتلب، حسابهایی متناظر با هر فرد هستند.
+حسابهای کاربری پیچیدگی خاصی ندارند؛ به طور کل، مجموعهای از اطلاعات شخصی الحاق شده به اطلاعات ورود هستند.
+هر نام کاربری با یک فضانام (Namespace) میآید، که گروهبندی منطقی از پروژههای مربوطی به آن کاربر است.
+اگر کاربر jane پروژهای به نام project داشته باشد، آدرس آن پروژه http://server/jane/project خواهد بود.
+
+
+
+
}}" alt="The GitLab user administration screen.">
+
+
نمودار 52. صفحه مدیریت کاربر گیتلب.
+
+
+
حذف یک کاربر به وسیله دو راه انجام میشود.
+«Blocking» یا مسدود کردن یک کاربر باعث جلوگیری از لاگین کردن آنها به اینستنس گیتلب میشود، اما همهٔ دادههای کاربر زیر
+فضانام او خواهد باقی ماند و همچنین کامیتهای ثبت شده با ایمیل آن کاربر همچنان به حساب کاربری اون لینک خواهند ماند.
+
+
+
از سویی دیگر، «Destroying» یا نابود کردن یک کاربر، به طور کلی او را از پایگاهداده و فایلسیستم حذف میکند.
+همه پروژهها و دادههای درون فضانام او پاک خواهد شد، و هر گروهی که داشته باشند نیز نیز پاک خواهد شد.
+بدیهی است که این فعلی بسیار مخربتر و دائمیتر است و کاربردهای آن نادر هستند.
+
+
+
+
گروهها
+
+
یک گروه گیتلب مشتکله از پروژههایی همراه با اطلاعاتی درباره نحوه دسترسی کاربران به آن پروژهها است.
+هر گروه یک فضانام پروژه (به همان صورتی که کاربران دارند) دارد، بنابراین اگر گروه training پروژهای به نام materials داشته باشند، آدرس آن http://server/training/materials خواهد بود.
+
+
+
+
}}" alt="The GitLab group administration screen.">
+
+
نمودار 53. صفحه مدیریت گروه گیتلب.
+
+
+
هر گروه به تعدادی از کاربران وصل است، که هر کدام سطح دسترسی نسبت به پروژههای گروه و خود گروه را دارند.
+این طیف دسترسیها از «Guest» (فقط چت و ایشوها) تا «Owner» (کنترل کامل گروه، اعضای آن و پروژههای آن) میباشد.
+سطوح دسترسی برای لیست کردن در اینجا بسیار زیاد هستند، منتهی گیتلب لینکی مفید در این رابطه در صفحه مدیریت دارد.
+
+
+
+
پروژهها
+
+
یک پروژه گیتلب به سختی متناظر با یک واحد پروژه گیت است.
+هر پروژه متعلق به یک فضانام واحد، یا مال کاربر یا گروه، است.
+اگر پروژهآی متعلق به یک کاربر باشد، مالک پروژه کنترل مستقیم روی تمام افرادی به پروژه دسترسی دارند دارد؛ اگر پروژه متعلق به یک گروه باشد، دسترسیهای سطح کاربری گروه نیز تأثیرگذار خواهند بود.
+
+
+
بعلاوه هر پروژه دارای یک سطح وضوح است که تعیین میکند چه کسی دسترسی خواندن صفحات و مخزن پروژه را دارد.
+اگر پروژهای خصوصی باشد، مالک پروژه باید صراحتاً دسترسی به هر کاربر را دهد.
+یک پروژه داخلی برای هر کاربری که ورود کرده باشد قابل مشاهده است، و یک پروژه عمومی برای همهٔ افراد قابل مشاهده است.
+به خاطر داشته باشید که این هر دو دسترسی git fetch و دسترسی از طریق رابطه کاربری وب را کنترل میکند.
+
+
+
+
قلابها
+
+
گیتلب از هوکها یا قلابها هم پشتیبانی میکند، هم در سطح پروژه و هم در سطح سیستمی.
+برای هر کدام از اینها، در هر لحظه که رویدادهای مرتبط اتفاق بیوفتد، سرور گیتلب یک درخواست HTTP POST همراه کمی JSON توصیفی میفرستد.
+این روش عالی برای اتصال به مخازن گیت و اینستنس گیتلب برای دیگر اتوماسیونهای توسعه شما مانند سرورهای CI، چت رومها یا ابزاهای توسعه است.
+
+
+
+
استفاده ابتدایی
+
+
اولین کاری که میخواهید در گیتلب انجام دهید ساخت یک پروژه جدید است.
+این عمل با کلیک بر روی علامت «+» بر روی نوار ابزار امکان پذیر است.
+از شما نام پروژه، فضانامی که باید برای آن تعیین کنید و سطح وضوحی که باید داشته باشد پرسیده خواهد شد.
+بیشتر چیزهایی که اینجا مشخص میکنید دائمی نیستند و در آینده میتوان آنها را از طریق رابط تنظیمات بازتنظیم کرد.
+بر روی «Create Project» بزنید و تمام.
+
+
+
بعد از اینکه پروژه به وجود میآید، احتمالاً میخواهید با یک مخزن محلی گیت به آن متصل شوید.
+هر پروژهای میتواند از طریق پروتکلهای SSH یا HTTPS قابل دسترسی باشد، هر کدام میتواند برای تنظیم یک ریموت گیت استفاده شود.
+URLهای پروژه در قسمت بالای خانهٔ پروژه قابل مشاهده هستند.
+برای یک مخزن محلی از پیش موجود، این دستور یک ریموت با نام gitlab به آدرس میزبانی شده میسازد:
+
+
+
+
$ git remote add gitlab https://server/namespace/project.git
+
+
+
+
اگر کپی محلی از مخزن ندارید میتوانید این دستور را اجرا کنید:
+
+
+
+
$ git clone https://server/namespace/project.git
+
+
+
+
رابطه کاربری وب برای شما چندین ویوی مفید به خود مخزن ارائه میکند.
+صفحهٔ اصلی هر پروژه فعالیتهای اخیر را نشان میدهد و لینکها بالا شما را به صفحات فایلها و کامیت لاگ هدایت میکند.
+
+
+
کارکردن با یکدیگر
+
+
سادهترین راه برای کارکردن با یکدیگر بر یک پروژه گیتلب، به کاربری دیگر دسترسی پوش مستقیم به مخزن گیت دادن است.
+با رفتن به قسمت «Members» در بخش تنظیمات پروژه مرتبط بروید میتوانید یک کاربر را به پروژه اضافه، و به کاربر جدید سطح جدید از دسترسی ارائه کنید
+(کمی درباره سطوح دسترسی در قسمت گروهها بحث کردهایم).
+با اعطا کردن سطح دسترسی «Devloper» یا بالاتر به کاربر، آن کاربر میتواند به صورت مستقیم برنچ و کامیت به مخزن پوش کند.
+
+
+
راه دیگر گسستهتر مشارکت در پروژه، استفاده از درخواست ادغام یا Merge Request است.
+این امکان هر کاربری که بتواند پروژه را ببیند قادر میسازد تا به نحوی قابل کنترل در پروژه مشارکت کند.
+کاربران با دسترسی مستقیم میتوانند یک برنچ بساند، کامیت به آن پوش کنند و یک درخواست ادغام از برنچ خودشان به master یا هر برنچ دیگری باز کنند.
+کاربرانی که مجوز پوش مستقیم به مخزنی را ندارند میتوانند آنرا «فورک» کنند (کپی خودشان را بسازند)، به آن کپی کامیت پوش کنند و یک درخواست مرج از فورکشان به پروژه اصلی باز کنند.
+این مدل به صاحب این امکان را میدهد که در کنترل کامل اتفاقات و زمان اتفاق افتادن آنها باشد، همه در مادامی که مشارکتها را از کاربران غیرقابل قبول میکند.
+
+
+
درخواستهای ادغام و ایشوها واحدهای اصلی بحثهای طولانی در گیتلب هستند.
+هر درخواست ادغام اجازه بحث روی خط به خط تغییرات ارائه شده (که از نوعی سبک از بازبینی کد هم پشتیبانی میکند) و همچنین بحث کلی درباره کلیت کار را میدهد.
+که میتوانند به کاربران یا نقاط طرقی سازماندهی شده واگذار شوند.
+
+
+
این بخش به طور کل به روی ویژگیهای مرتبط با گیت گیتلب تمرکز دارد،اما در پروژههای بالغ، ویژگیهای بیشمار دیگری نیز برای کمک به کار تمیمی ارائه هم ارائه میکند، مثلاً ویکیهای پروژه و ابزارهای نگهداری سیستم.
+
+
گیتوب
+
+
+حالا که دسترسیهای ابتدایی خواندن/نوشتن و فقط-خواندنی را به پروژه خود را دارید، شاید بخواهید محیط بصریساز سادهٔ وب-پایهای هم نصب کنید.
+گیت با اسکریپت CGI با نام گیتوب همراه است که گاهی برای این مقصود استفاده میشود.
+
+
+
}}" alt="The GitWeb web-based user interface.">
+
+
نمودار 49. رابط کاربری وب-پایه گیتوب
+
+
اگر میخواهید ببینید که گیتوب برای پروژه شما به چه صورت خواهد بود، گیت با دستوری برای اجرای یک نمونه موقت همراه است، در صورتی که وب سروری سبک مانند lighttpd یا webrick روی سیستم خود دارید.
+بر روی سیستمهای لینوکسی، وب سرور lighttpd معمولاً نصب است، بنابراین احتمالاً باید بتوانید با تایپ دستور git instaweb در پوشه پروژه خود آنرا اجرا کنید.
+اگر سیستمعامل مک دارید، Leopard با Ruby از پیش نصب شده همراه است، در نتیجه بهترین انتخاب شما میتواند webrick باشد.
+برای اجرای instaweb با هندلری غیر از lighttpd، میتوانید از آپشن --httpd استفاده کنید.
+
+
+
$ git instaweb --httpd=webrick
+[2009-02-21 10:02:21] INFO WEBrick 1.3.1
+[2009-02-21 10:02:21] INFO ruby 1.8.6 (2008-03-03) [universal-darwin9.0]
+
+
+
این دستور یک سرور HTTPD را بر روی پورت ۱۲۳۴ را اجرا میکند و سپس به صورت خودکار مرورگری را اجرا میکند که آن صحفه را باز میکند.
+بسیار ساده است.
+وقتی کارتان پایان یافت و خواستید سرور را خاموش کنید، میتوانید همان دستور را با آپشن --stop وارد کنید.
+
+
+
$ git instaweb --httpd=webrick --stop
+
+
+
اگر میخواهید رابط وب دائماً روی سرور برای هم تیمیهایتان یا برای پروژه متن-بازی که میزبانی میکنید اجرا کنید، لازم است که اسکریپت CGI را تنظیم کنید تا توسط وب سرور عادی شما ارائه شود.
+بعضی از توزیعهای لینوکس پکیج gitweb دارند که احتمالاً بتوانید آنرا با apt یا dnf نصب کنید، بنابراین ابتدا ممکن است بخواهید آنرا امتحان کنید.
+قدم به قدم نصب دستی گیتوب را با هم مروری سریع میکنیم.
+ابتدا، لازم است که سورس کد گیت را داشته باشید، که گیتوب با آن ارائه میشود، و اسکریپت شخصیسازی شده CGI را بسازید:
+
+
+
$ git clone git://git.kernel.org/pub/scm/git/git.git
+$ cd git/
+$ make GITWEB_PROJECTROOT="/srv/git" prefix=/usr gitweb
+ SUBDIR gitweb
+ SUBDIR ../
+make[2]: `GIT-VERSION-FILE' is up to date.
+ GEN gitweb.cgi
+ GEN static/gitweb.js
+$ sudo cp -Rf gitweb /var/www/
+
+
+
دقت کنید که باید همراه دستور، با متغییر GITWEB_PROJCETROOT، مشخص کنید که کجا مخازن گیت را پیدا کند.
+حالا، لازم است که آپاچی را وادار به استفاده از CGI برای آن اسکریپت کنید، که برای آن میتوانید یک VirtualHost اضافه کنید:
+
+
+
<VirtualHost *:80>
+ ServerName gitserver
+ DocumentRoot /var/www/gitweb
+ <Directory /var/www/gitweb>
+ Options +ExecCGI +FollowSymLinks +SymLinksIfOwnerMatch
+ AllowOverride All
+ order allow,deny
+ Allow from all
+ AddHandler cgi-script cgi
+ DirectoryIndex gitweb.cgi
+ </Directory>
+</VirtualHost>
+
+
+
مجدداً، گیتوب میتواند با هر وب سروری با قابلیت CGI یا پرل ارائه شود؛ اگر ترجیح میدهید از چیز دیگری استفاده کنید، نباید راهاندازی سختی داشته باشد.
+اکنون، باید بتوانید به آدرس http://gitserver/ مراجعه کنید تا مخزن خود را آنلاین مشاهده کنید.
+