stackinator icon indicating copy to clipboard operation
stackinator copied to clipboard

doc issue about develop support

Open albestro opened this issue 2 months ago • 1 comments

https://github.com/eth-cscs/stackinator/blob/5f161107f51c8ff9c1cf8989e9f5ccb5e0d7ba65/docs/configuring.md?plain=1#L45-L51

In addition to the repeated "the following", IMHO the bullet points list is not straightforward to understand. Some doubts I have:

  • it probably refers to spack env activate --with-view <name> and not spack env --with-view
  • first point: I would specify that the second part of the sentence refers to the environment configuration
  • second point: are you referring to <name> with "positional argument"?
  • third point sounds like a bit unlinked. I think doc meant that --with-view <name> applies starting from 0.21 (and so also develop included). right?
  • fourth point: are you referring to --develop? in case, I might argue that it would be beneficial to keep it there for a while. Two arguments in support of this argument:
    • what if you remove it and then you have to re-add a develop option because another similar workaround is needed?
    • develop sounds general enough, so it applies to all possible workarounds needed. otherwise we might end up having different flags for different workarounds of this kind and drop just the ones not used anymore

I really hope that spack will allows us to completely forget about this option sooner rather than later.

albestro avatar Apr 19 '24 13:04 albestro