From 0d7c29984e7924ad53b63262b7d883f28fe71533 Mon Sep 17 00:00:00 2001 From: Shane da Silva Date: Thu, 11 Feb 2016 10:50:43 -0500 Subject: [PATCH] Add note about lack of support for git-worktree --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 11de7820..fb4c406a 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ writing any Ruby code. * [Requirements](#requirements) * [Dependencies](#dependencies) +* [Limitations](#limitations) * [Installation](#installation) * [Automatically Install Overcommit Hooks](#automatically-install-overcommit-hooks) * [Usage](#usage) @@ -58,6 +59,13 @@ This project aims to support the following Ruby runtimes: Windows is currently supported only for MRI Ruby 2.x +## Limitations + +Overcommit does not currently support +[`git-worktree`](https://git-scm.com/docs/git-worktree) (introduced in Git 2.5), +but there is an [open issue](https://github.com/brigade/overcommit/issues/336) +tracking progress on adding support. + ### Dependencies Some of the hooks have third-party dependencies. For example, to lint your