diff --relative: output paths as relative to the current subdirectory
[gitweb.git] / Documentation / git-clone.txt
index cca14d6b5df042fcf48889e5ff00285ffc4c3009..23418816146d0b65eeabdd7a3d67dcd7e8c760e1 100644 (file)
@@ -12,7 +12,7 @@ SYNOPSIS
 'git-clone' [--template=<template_directory>]
          [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare]
          [-o <name>] [-u <upload-pack>] [--reference <repository>]
-         [--depth <depth>] <repository> [<directory>]
+         [--depth <depth>] [--] <repository> [<directory>]
 
 DESCRIPTION
 -----------
@@ -62,6 +62,14 @@ OPTIONS
        .git/objects/info/alternates to share the objects
        with the source repository.  The resulting repository
        starts out without any object of its own.
+       *NOTE*: this is a possibly dangerous operation; do *not* use
+       it unless you understand what it does. If you clone your
+       repository using this option, then delete branches in the
+       source repository and then run linkgit:git-gc[1] using the
+       '--prune' option in the source repository, it may remove
+       objects which are referenced by the cloned repository.
+
+
 
 --reference <repository>::
        If the reference repository is on the local machine
@@ -130,6 +138,7 @@ OPTIONS
        for "host.xz:foo/.git").  Cloning into an existing directory
        is not allowed.
 
+:git-clone: 1
 include::urls.txt[]
 
 Examples
@@ -190,4 +199,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 
 GIT
 ---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[7] suite