Document source_hash for salt.states.archive

[jacobsvante]

salt.states.archive source_hash is not documented today, only listed in the example. What does it do? Is it only for checking that the downloaded file is what was requested?

[gtmanfred]

https://github.com/saltstack/salt/blob/develop/salt/states/archive.py#L108

It does a file.managed on the thing to grab the file,

https://github.com/saltstack/salt/blob/develop/salt/states/file.py#L621

Here is the documentation of where source_hash is used

http://docs.saltstack.com/ref/modules/all/salt.modules.file.html#salt.modules.file.extract_hash

It is just used for verifying the file that is downloading

[jacobsvante]

Thanks for looking that up. Should still be documented though!

[basepi]

Agreed, we should get it documented!

[gtmanfred]

I am against documenting it in archive, I would document it better in the file.managed module, and then reference it in the states/archive.py

[jacobsvante]

A reference would work as well as long as it's described how it's used in this particular case (i thought that it checked the hash of the previously downloaded directory to make sure that it was intact).

[SeanZicari]

Maybe we close this now that there's a comment? If someone doesn't like the comment, that could be a new issue with a more specific title.

[basepi]

Agreed! Thanks!