Document supported and unsupported git clone URL syntax

[hedgehog]

Current behavior/acceptable syntax is obscure and not consistent with POLS:
:git => 'file:///local/repo'
is not supported by bundler but is valid git clone URL.
The supported state of other git URL's should be documented.
A listing of valid git clone URL syntax is here

[indirect]

I just tested it, and Bundler supports that sort of git url with the :git option already.

[hedgehog]

indirect, I think you mean it doesn't raise an error?
The reason this ticket should be open is the reason indirect closed it - it /seems/ to work. However, according to Yehuda Katz or Andre Arko it is not (currently v0.9.25) supported:

http://groups.google.com/group/ruby-bundler/tree/browse_frm/thread/5ea89ce30b0f4997/1c1f2bff78501b21?hl=en&rnum=1&_done=%2Fgroup%2Fruby-bundler%2Fbrowse_frm%2Fthread%2F5ea89ce30b0f4997%3Fhl%3Den%26#doc_b9fa135d66be70f6

Nor according to my experiences.....

[indirect]

Sorry, I should be more clear. First, I am Andre Arko. Second, the suggested way to use gems that are checked out onto your local machine is the :path option, which will just use the directory directly, and not check anything out. Last, the :git option works perfectly fine if you absolutely must use it on a git repo that is on your local machine. I have tested it, and :git and :branch work just fine with file:// urls. That's not a usage that we on the bundler team are going to provide support for, though.

[hedgehog]

OK now I'm getting totally confused by this mail list:

For the record, this workflow is supported by Bundler -- the :path option is for
local directories, including checkouts, and the :git option is for remote repository
URLs.

Yet above you now say :path is not for checkouts?

You also say:

That's not a usage that we on the bundler team are going to provide support for,
though.

That is well and good. But why close an issue noting documentation needs to clarify an issue not even people familiar with bundler can keep straight, e.g one min :path is for checkouts the next minute it is not?