Add manpages

[gliargovas]

No description provided.

[gliargovas]

@mgree @angelhof I have not added an example yet. Any recommendations?

[mgree]

looks good! just a few tiny tweaks

[mgree]

I'd add a few:

1. An interactive example of a command that has moderately dispersed effect. Since apt doesn't work yet, maybe it could be un-taring a tarball with absolute paths?
2. A non-interactive example that uses summary and commit. Maybe somehow doing the same work.
3. A non-interactive example using the -D flag.

[angelhof]

A make; make install could also be a potentially good candidate example (in the manpages and in general) or even a or pip install --user libdash.

[gliargovas]

By default we block network operations inside the overlay. Maybe installing a local package using the .whl format?

[angelhof]

I think that try by default should allow network operations (what do you think @mgree?) with a disclaimer that they will not be contained. Maybe we can add a flag.

[gliargovas]

I tried to run pip install and got a timeout. wget and curl didn't work too.

[angelhof]

Oh, I see. I think that this should not be the case. Could you open an issue with the examples that you run and what output you got to track the problem?

[gliargovas]

I have added some of the examples you proposed. Let me know if you would like me to add anything else :-)

[angelhof]

Looks good other than the tiny comment I left

[angelhof]

Should't this be try -D try_dir gunzip amendments.txt.gz based on the later try summary try_dir?

[gliargovas]

This is a typo, I will fix it

[mgree]

maybe you mean try -n gunzip amendments.txt.gz? that allocates a fresh directory but just gives the sandbox dir when it's done

[gliargovas]

Yes, makes sense. I didn't realize that -n gives you back the overlay dir

[angelhof]

BTW, let's also add the example to the README too (once it's finalized)

[mgree]

Good idea! We can mostly crib from the manpage, but it's good to have killer examples and installation instructions up front in a friendly way in the README.

…

On 2023-05-30 at 02:08:42 PM, Konstantinos Kallas wrote: BTW, let's also add the example to the README too (once it's finalized) -- Reply to this email directly or view it on GitHub: #8 (comment) You are receiving this because you were mentioned. Message ID: ***@***.***>

[gliargovas]

@angelhof @mgree I think this is ready to merge.

[angelhof]

Looks good to me, just remember to document the issue that you had with pip, wget, and curl.

I tried to run pip install and got a timeout. wget and curl didn't work too.

[angelhof]

Also, I think it is really important to add a test with whatever functionality we have in the manpage. The manpage example should always work and tested in CI. @gliargovas once you add the test, we can very easily make it part of CI (see https://github.com/binpash/sh-expand/blob/main/.github/workflows/test.yaml).

[gliargovas]

Looks good to me, just remember to document the issue that you had with pip, wget, and curl.

I tried to run pip install and got a timeout. wget and curl didn't work too.

I will open a separate issue documenting these.

[gliargovas]

Also, I think it is really important to add a test with whatever functionality we have in the manpage. The manpage example should always work and tested in CI. @gliargovas once you add the test, we can very easily make it part of CI (see https://github.com/binpash/sh-expand/blob/main/.github/workflows/test.yaml).

Makes sense, I will do so right now.