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

Docs for archive.tar should not use leading dash for tar options #44336

Closed
corywright opened this issue Oct 30, 2017 · 2 comments
Closed

Docs for archive.tar should not use leading dash for tar options #44336

corywright opened this issue Oct 30, 2017 · 2 comments
Labels
Documentation Relates to Salt documentation
Milestone

Comments

@corywright
Copy link
Contributor

Description of Issue/Question

The documentation for archive.tar uses a leading dash before the options that are to be passed through to the tar command. However, this leading dash is instead interpreted as the -c option that specifies a config_dir the salt command:

$ salt '*' archive.tar -cjvf /tmp/tarfile.tar.bz2 /tmp/file_1,/tmp/file_2
WARNING: CONFIG 'jvf' directory does not exist.
myminion:
    - tar: Old option 'b' requires an argument.
    - Try 'tar --help' or 'tar --usage' for more information.
ERROR: Minions returned with non-zero exit code

Removing the leading dash allows the options to tar to be properly passed through:

$ salt '*' archive.tar cjvf /tmp/tarfile.tar.bz2 /tmp/file_1,/tmp/file_2
myminion:
    - tar: Removing leading `/' from member names
    - /tmp/file_1
    - /tmp/file_2

This documentation bug is present in 2015.8, 2016.3, 2016.11, and 2017.7.

@gtmanfred
Copy link
Contributor

Thanks for submitting the PR to fix these docs!
Daniel

@rallytime
Copy link
Contributor

Closed via #44338

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Relates to Salt documentation
Projects
None yet
Development

No branches or pull requests

3 participants