Deprecate 'stack path --global-stack-root', add '--stack-root' options – #1148

[sjakobi]

No description provided.

[sjakobi]

I have added a deprecation warning that shows up when someone uses the stack path --global-stack-root flag explicitely:

$ stack path --global-stack-root
'--global-stack-root' will be removed in a future release.
Please use '--stack-root' instead.

/home/simon/.stack

Should there also be a warning for stack path without any flags? I'm not sure whether it would be obnoxious or maybe even break things. On the other hand people might be confused that stack path lists both global-stack-root and stack-root with the same content:

$ stack path
global-stack-root: /home/simon/.stack
stack-root: /home/simon/.stack
...

[sjakobi]

One aspect of #1148 was that the documentation on $STACK_ROOT was somewhat sparse.

I think the situation has already become a bit better with the new entry in stack --help:

  --stack-root STACK-ROOT  Absolute path to the global stack root directory
                           (Overrides any STACK_ROOT environment variable)

Yet should I possibly add an entry to the FAQ, e.g. How can I change the location of the global stack root directory?. Or is there a more appropriate place?

[mgsloan]

This should be --stack-root, right?

[sjakobi]

Of course. Fixed.

[mgsloan]

LGTM, thanks! Just one comment that needs to be addressed.

[sjakobi]

I have added a commit that fixes an exception for permission-checking code that was still $STACK_ROOT-specific.

@mgsloan: Have you seen my two comments at the top or do you think these are non-issues?

[mgsloan]

Should there also be a warning for stack path without any flags? I'm not sure whether it would be obnoxious or maybe even break things. On the other hand people might be confused that stack path lists both global-stack-root and stack-root with the same content:

I think removing it from the list is fine. True, someone could be parsing it. However, I don't know of any tools that do this. The breakage should be minimal at this time.

As long as we're doing such a deprecation / change for --global-stack-root, it'd be good to also address #1546

Yet should I possibly add an entry to the FAQ, e.g. How can I change the location of the global stack root directory?. Or is there a more appropriate place?

Thanks for considering docs! I think the current level of docs is fine. AFAIK there is little need for STACK_ROOT other than having shorter paths on windows, and this is well covered in the windows installation instructions

[sjakobi]

I think removing it from the list is fine.

Fixed with edaae29.

As long as we're doing such a deprecation / change for --global-stack-root, it'd be good to also address #1546

I'll take a look!

[sjakobi]

Rebased.

[mgsloan]

Thanks!

That appveyor failure seems superfluous, so merging.