Add developer docs about zkg's internal use of directories #175
Conversation
ckreibich
force-pushed
the
topic/christian/add-path-docs
branch
2 times, most recently
from
54e5e25 to
3b7399c
Compare
ckreibich
force-pushed
the
topic/christian/add-path-docs
branch
from
3b7399c to
a09560d
Compare
| - A "stage". A stage is any place in which ``zkg`` actually installs a package | ||
| for running in Zeek. This can be the local Zeek installation, or locally below | ||
| ``$STATEDIR/testing`` when testing a package. So "staging" here does not mean | ||
| "not yet live"; rather the opposite: it's closer to "any place where the |
There was a problem hiding this comment.
Oh. I think that might help with the mind-twistedness I experience whenever I try to understand anything of the staging / installation flow.
Having it in the docs is good, but I wonder if we should do something in the code. "stage" and "staging" in the deployment sense have such a well established meaning that this deviation seems very unfortunate and confusing.
There was a problem hiding this comment.
That's just my read of it btw, but I don't see any code where a stage would be transitioned to a deployment, so I think that interpretation is closest. And yeah, I'd be happy to change the code. Simply calling it an Installation might do it.
| involved upon next use. | ||
|
|
||
| When ``zkg`` isn't in the middle of executing any commands, you can always | ||
| delete the scratch space without negatively affecting ``zkg``. |
There was a problem hiding this comment.
I guess that's on your mind, inverting this behavior and introducing --keep-scratch / --keep-testing or some --keep-temporary wildcard would be less surprising.
There was a problem hiding this comment.
Yeah, especially for scratch. zkg could no doubt clean up properly in there. And for testing it could at least clean up when the tests pass. (And it should be much better about pointing you at the trouble if they don't, but that's another one.)
I'm putting together some developer docs since I'm hoping to find more time to get back to working on
zkg.