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.

Sign up for GitHub

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

Jump to bottom

files: fix docs about type of the mode parameter #61232

Closed
wants to merge 2 commits into from
Closed

files: fix docs about type of the mode parameter #61232

wants to merge 2 commits into from

Commits on Aug 24, 2019

  1. files: fix docs about type of the mode parameter 

    `mode` is an octal or symbolic mode, for the unix file permission.  It is
not a path, as the docs for the copy module suggest.

Document the various mode parameters as being of type as "raw".

The `directory_mode` parameter of the copy module was already of type
"raw".  Perhaps this looks a bit weird, but the documentation text for
`mode` is very explicit about how it allows both integer and string values.

`ansible-test sanity --test validate-modules` missed some inconcistencies
between the docs and the code due to how the common file arguments work.
(I noticed it yelled at me if I introduce a discrepancy elsewhere).
I think this change removes inconsistencies.
    @sourcejedi
    sourcejedi committed Aug 24, 2019
    Configuration menu
    Copy the full SHA
    431046c View commit details
    Browse the repository at this point in the history

  2. module_utils: remove unused function get_file_args_spec() 

    GitHub code search suggests no-one refers to this.  Including us
(or our docs).

We know what happens to dead code.  Let's send it to the bitbucket in the
sky.
    @sourcejedi
    sourcejedi committed Aug 24, 2019
    Configuration menu
    Copy the full SHA
    56f32fa View commit details
    Browse the repository at this point in the history