README.md - Suggest -vcs option with 'gohack get' as having vcs is th…

[chmorgan]

…e likely desired behavior

[davidovich]

In fact, -vcs is an additional mode to the base use case which does not initialize a repo (if you want to make a fast one-off non tracked modification). We would need to state that in addition to the non -vcs case.

[chmorgan]

I ran without -vcs and ended up without a .git, ran with -vcs and it had a .git as expected. Maybe the logic was unintentionally reversed? Imo the default should be to have a git repo to work with so it didn’t make sense to me initially.

[chmorgan]

I can expand upon the two cases and why you might use one over the other. Imo it was counterintuitive that I didn’t get a vcs by default. Maybe we should reverse the logic on the option, make it -novcs? Disk space and bandwidth would be increased but these days it’s not a big deal for most people.

[davidovich]

I think changing the default should be proposed in a new issue so that maintainers can get a shot at discussing it. There must be a reason for the current (non-vcs) default.

[chmorgan]

Agreed. Let me fix this pr up tonight and open a separate one to swap the defaults.

[chmorgan]

Hi @davidovich alright, ready for re-review. I took the liberty of using some markdown to break things into easier to follow sections as well.

[davidovich]

@chmorgan I do not have merge privileges, but I think your changes are a great documentation addition. We just merged one of my changes that enhances setting GOHACK to a relative directory to control where the module lands. Want to document that also ? :-) (GOHACK en var was not documented before).

[chmorgan]

HI @davidovich. I could take a swag at updating that once this one is merged in. I'd rather not stack anything up behind it in case people prefer the flat unformatted look and the edits are rejected :-) But I can take a quick look once this is in. Should only take a few minutes to document that but as the original author you may be the person that knows it best ;-)

[davidovich]

You're right, I won't be lazy :-). I'll wait till the maintainers see if this change is acceptable, and make the GOHACK doc update PR on top.

[chmorgan]

Any updates on this PR?

[myitcv]

cc @rogpeppe

[chmorgan]

and on this one?

[rogpeppe]

This is a great addition, thanks!
FWIW I do plan to change the behaviour somewhat - I think the non-VCS mode works best for temporary edits and probably this mode shouldn't be checking out to the shared gohack directory.