hex7c0/mongodb-backup

Does tar option replace the root dir?

Opened this issue · 2 comments

This is about a documentation inconvenience for a first-time user. The README and the examples lack to answer how tar and root options are related. The reader (me) can form at least three different explanations.

  • after backup, both root dir and tar file exists. Tar has the content of root dir.
  • after backup, only tar file exists, root option does not affect anything.
  • root dir is created and then tar file is created and root dir is removed.

Would this inconvenience be worth of an additional sentence into README or tar example? I understand the user can test the correct explanation with relatively small amount of work or will eventually find it out. However for a new-comer, I think it is a bit confusing.

I am happy to make a PR about this.

hi axelpale,
I would like to accept this PR

I'm having some trouble understanding this relation between the root and tar params.

Is it wanted that the root path is created inside the tar archive?