When would you use git clone over git clone –mirror?

Technology CommunityCategory: GitWhen would you use git clone over git clone –mirror?
VietMX Staff asked 3 years ago

Suppose origin has a few branches (master (HEAD)nextpu, and maint), some tags (v1v2v3), some remote branches (devA/masterdevB/master), and some other refs (refs/foo/barrefs/foo/baz, which might be notes, stashes, other devs’ namespaces, who knows).

  • git clone (non-bare): You will get all of the tags copied, a local branch master (HEAD) tracking a remote branch origin/master, and remote branches origin/nextorigin/pu, and origin/maint. The tracking branches are set up so that if you do something like git fetch origin, they’ll be fetched as you expect. Any remote branches (in the cloned remote) and other refs are completely ignored.
  • git clone --mirror: Every last one of those refs will be copied as-is. You’ll get all the tags, local branches master (HEAD)nextpu, and maint, remote branches devA/master and devB/master, other refs refs/foo/bar and refs/foo/baz. Everything is exactly as it was in the cloned remote. Remote tracking is set up so that if you run git remote update all refs will be overwritten from origin, as if you’d just deleted the mirror and recloned it. As the docs originally said, it’s a mirror. It’s supposed to be a functionally identical copy, interchangeable with the original.

To summarize,

  • git clone is used when we need to point to an existing repo and make a clone or copy of that repo at in a new directory.
  • git clone --mirror is used to clone all the extended refs of the remote repository, and maintain remote branch tracking configuration.