Commit 5febb04e authored by Dom Sekotill's avatar Dom Sekotill
Browse files

Add notes about branch and path name limitations

parent 2bd244c7

bin/git-supertree

+6 −0
Original line number Diff line number Diff line
@@ -40,6 +40,8 @@ USAGE="Usage: $SCRIPT [-h] {init|clone|convert|add|mv|rm} [OPTION [OPTION ...]] 
$SCRIPT init [WORKTREE-BASE] [-b BRANCH[:PATH]]

  Create a new super working tree at WORKTREE-BASE (default: current directory)



  Note: neither BRANCH nor PATH may have a colon (:) within them.



  -b --branch  Create an initial branch named BRANCH (default: $DEFAULT_BRANCH)

               checked out at PATH (default: BRANCH) relative to WORKTREE-BASE.
@@ -47,6 +49,8 @@ $SCRIPT clone URL [WORKTREE-BASE] [-b BRANCH[:PATH]] 
  Clone a remote repository at URL in a super working tree at

  WORKTREE-BASE (default: base name of URL)



  Note: neither BRANCH nor PATH may have a colon (:) within them.



  -b --branch  Create or check-out an initial branch named

               BRANCH (default: origin/HEAD) at PATH (default: BRANCH) relative

               to WORKTREE-BASE.
@@ -66,6 +70,8 @@ $SCRIPT add [--from SOURCE|--orphan] BRANCH[:PATH] 
  --from       Provide an origin reference

  --orphan     Create an orphaned branch (no commits)



  Note: neither BRANCH nor PATH may have a colon (:) within them.



$SCRIPT mv [--branch] NAME NEW-NAME

  Move a worktree to a new path.