Adding a docstring to the sysctl plugin for the purpose of autogenerating an asciidoc

[courtneypacheco]

Added a docstring to the sysctl plugin that describes what the plugin does, what its parameters are, and how it should be used.

[yarda]

@courtneypacheco thanks for the PR.

Please be consistent with tab and spaces, so please update this PR (you can use e.g. vim or emacs or mc / mcedit to see the spacing). Update the PR by e.g. git commit --amend in the branch for this PR and then force push by e.g. git push -f.

Also I think it would be good to have some simple example here, so please add it. You can take inspiration from existing Tuned profiles. Please tag the examples consistently (e.g. by using chapter named Example in the asciidoc). We will later create tools for parsing it.

Please note that this is proof of concept work without tight specification for the formatting/tooling etc. I will start merging these PRs in January so if you come up with some different formatting during your work on different plugins, feel free to update your older PRs to be consistent.

[lgtm-com[bot]]

This pull request fixes 1 alert when merging 00ff3592616097e01ba10d24fa0e32e716bfc5c9 into 5397166de564e124996e5b7e4e4371838b14d9b0 - view on LGTM.com

fixed alerts:

• 1 for Unused import

[jmencak]

Obsoleted by: https://github.com/redhat-performance/tuned/pull/337