Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move documentation instances of recommanded usage of dangerous command line commands to less dangerous ones. #3314

Open
brancoliticus opened this issue Dec 6, 2024 · 3 comments
Labels
Accepted Issue has been reproduced by MathJax team Feature Request

Comments

@brancoliticus
Copy link

brancoliticus commented Dec 6, 2024

The unix-like shell commands mv, cp amd rm are dangerous in the sense that if you use them on data you don't intend to loose you might loose that very same data.

My idea: move all documentation uses of mv ... to mv -i ..., all uses of cp ... to cp -i ... and all uses of rm [-rf] ... to rm -i [-rf] ... or even better trash-put .... The commands with the -i option are interactive in the sense that the user is explicitally asked before overwriting or deleting anything. The last command trash-put is better in the sense that it moves the data to the temporary trash folder instead of instantly deleting it. trash-put is supplied as a python package in many Linux distributions.

The dangerous command are everywhere in the documentation. I believe they should be replaced with their non-dangerouse counterparts.

Just my 2 cents. Thank you for reading.

@dpvc
Copy link
Member

dpvc commented Dec 6, 2024

The dangerous command are everywhere in the documentation.

I'm unable to find a single instance of any of these commands in the documentation. Can you point out one or two of these for me? Or perhaps you mean documentation somewhere else? Perhaps I am misunderstanding your request.

@brancoliticus
Copy link
Author

In this repo main page at the default page in README.md below Hosting your own copy of the MathJax Components there are instances of mv ... instead of mv -i ... and rm -rf ... instead of rm -irf or trash-put.

@dpvc
Copy link
Member

dpvc commented Dec 6, 2024

OK, thanks. You're right, I didn't check the README file here (only the documentation I linked to above (and the demos repositories). Sure, they can be changed.

@dpvc dpvc added the Accepted Issue has been reproduced by MathJax team label Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Issue has been reproduced by MathJax team Feature Request
Projects
None yet
Development

No branches or pull requests

2 participants