config option log.showroot to show the diff of root commits
[gitweb.git] / Documentation / git-clone.txt
index 7572e4b80d0f71cea1c93e9078e885d71594ff24..4cb42237b559723a0e59ac8e29c78a20304f38d0 100644 (file)
@@ -11,7 +11,8 @@ SYNOPSIS
 [verse]
 'git-clone' [--template=<template_directory>] [-l [-s]] [-q] [-n] [--bare]
          [-o <name>] [-u <upload-pack>] [--reference <repository>]
-         [--use-separate-remote] <repository> [<directory>]
+         [--use-separate-remote | --use-immingled-remote] <repository>
+         [<directory>]
 
 DESCRIPTION
 -----------
@@ -62,7 +63,7 @@ OPTIONS
 --quiet::
 -q::
        Operate quietly.  This flag is passed to "rsync" and
-       "git-clone-pack" commands when given.
+       "git-fetch-pack" commands when given.
 
 -n::
        No checkout of HEAD is performed after the clone is complete.
@@ -71,10 +72,15 @@ OPTIONS
        Make a 'bare' GIT repository.  That is, instead of
        creating `<directory>` and placing the administrative
        files in `<directory>/.git`, make the `<directory>`
-       itself the `$GIT_DIR`. This implies `-n` option.  When
-       this option is used, neither the `origin` branch nor the
-       default `remotes/origin` file is created.
-
+       itself the `$GIT_DIR`. This obviously implies the `-n`
+       because there is nowhere to check out the working tree.
+       Also the branch heads at the remote are copied directly
+       to corresponding local branch heads, without mapping
+       them to `refs/remotes/origin/`.  When this option is
+       used, neither the `origin` branch nor the default
+       `remotes/origin` file is created.
+
+--origin <name>::
 -o <name>::
        Instead of using the branch name 'origin' to keep track
        of the upstream repository, use <name> instead.  Note
@@ -85,7 +91,7 @@ OPTIONS
 --upload-pack <upload-pack>::
 -u <upload-pack>::
        When given, and the repository to clone from is handled
-       by 'git-clone-pack', '--exec=<upload-pack>' is passed to
+       by 'git-fetch-pack', '--exec=<upload-pack>' is passed to
        the command to specify non-default path for the command
        run on the other end.
 
@@ -95,9 +101,16 @@ OPTIONS
        defined default, typically `/usr/share/git-core/templates`.
 
 --use-separate-remote::
-       Save remotes heads under `$GIT_DIR/remotes/origin/' instead
-       of `$GIT_DIR/refs/heads/'.  Only the master branch is saved
-       in the latter.
+       Save remotes heads under `$GIT_DIR/remotes/origin/` instead
+       of `$GIT_DIR/refs/heads/`.  Only the local master branch is
+       saved in the latter. This is the default.
+
+--use-immingled-remote::
+       Save remotes heads in the same namespace as the local
+       heads, `$GIT_DIR/refs/heads/'.  In regular repositories,
+       this is a legacy setup git-clone created by default in
+       older Git versions, and will be removed before the next
+       major release.
 
 <repository>::
        The (possibly remote) repository to clone from.  It can