Update yum.py #47749

biohazd · 2018-10-29T14:49:05Z

adding explanation why you must use "shell: yum clean all" and why it won't be included in the yum module as per #31450 (comment)

+label: docsite_pr

SUMMARY

adding explanation why you must use "shell: yum clean all" and why it won't be included in the yum module as per #31450 (comment)

ISSUE TYPE

Docs Pull Request

COMPONENT NAME

yum

ANSIBLE VERSION

All

ADDITIONAL INFORMATION

adding explanation why you must use "shell: yum clean all" and why it won't be included in the yum module as per ansible#31450 (comment) +label: docsite_pr

ansibot · 2018-10-29T14:54:31Z

Hi @biohazd, thank you for submitting this pull-request!

click here for bot help

ansibot · 2018-10-29T14:54:33Z

cc @Akasurde @berenddeschouwer @kustodian @maxamillion @verm666
click here for bot help

ansibot · 2018-10-29T15:03:01Z

The test ansible-test sanity --test ansible-doc --python 2.6 [explain] failed with 1 error:

lib/ansible/modules/packaging/os/yum.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 2.7 [explain] failed with 1 error:

lib/ansible/modules/packaging/os/yum.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.5 [explain] failed with 1 error:

lib/ansible/modules/packaging/os/yum.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.6 [explain] failed with 1 error:

lib/ansible/modules/packaging/os/yum.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.7 [explain] failed with 1 error:

lib/ansible/modules/packaging/os/yum.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test docs-build [explain] failed with the error:

Command "/usr/bin/python test/sanity/code-smell/docs-build.py" returned exit status 1.
>>> Standard Error
Command 'make singlehtmldocs' failed with status code: 2
--> Standard Output
cat _themes/srtd/static/css/theme.css | sed -e 's/^[ 	]*//g; s/[ 	]*$//g; s/\([:{;,]\) /\1/g; s/ {/{/g; s/\/\*.*\*\///g; /^$/d' | sed -e :a -e '$!N; s/\n\(.\)/\1/; ta' > _themes/srtd/static/css/theme.min.css
PYTHONPATH=../../lib ../bin/dump_config.py --template-file=../templates/config.rst.j2 --output-dir=rst/reference_appendices/ -d ../../lib/ansible/config/base.yml
mkdir -p rst/cli
PYTHONPATH=../../lib ../bin/generate_man.py --template-file=../templates/cli_rst.j2 --output-dir=rst/cli/ --output-format rst ../../lib/ansible/cli/*.py
PYTHONPATH=../../lib ../bin/dump_keywords.py --template-dir=../templates --output-dir=rst/reference_appendices/ -d ./keyword_desc.yml
PYTHONPATH=../../lib ../bin/plugin_formatter.py -t rst --template-dir=../templates --module-dir=../../lib/ansible/modules -o rst/modules/ 
Makefile:93: recipe for target 'modules' failed
--> Standard Error
Traceback (most recent call last):
  File "../bin/plugin_formatter.py", line 720, in <module>
    main()
  File "../bin/plugin_formatter.py", line 678, in main
    plugin_info, categories = get_plugin_info(options.module_dir, limit_to=options.limit_to, verbose=(options.verbosity > 0))
  File "../bin/plugin_formatter.py", line 269, in get_plugin_info
    doc, examples, returndocs, metadata = plugin_docs.get_docstring(module_path, fragment_loader, verbose=verbose)
  File "/root/ansible/lib/ansible/utils/plugin_docs.py", line 99, in get_docstring
    data = read_docstring(filename, verbose=verbose, ignore_errors=ignore_errors)
  File "/root/ansible/lib/ansible/parsing/plugin_docs.py", line 62, in read_docstring
    data[varkey] = AnsibleLoader(child.value.s, file_name=filename).get_single_data()
  File "/usr/local/lib/python3.6/dist-packages/yaml/constructor.py", line 35, in get_single_data
    node = self.get_single_node()
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 36, in get_single_node
    document = self.compose_document()
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 55, in compose_document
    node = self.compose_node(None, None)
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 84, in compose_node
    node = self.compose_mapping_node(anchor)
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 133, in compose_mapping_node
    item_value = self.compose_node(node, item_key)
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 82, in compose_node
    node = self.compose_sequence_node(anchor)
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 111, in compose_sequence_node
    node.value.append(self.compose_node(node, index))
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 84, in compose_node
    node = self.compose_mapping_node(anchor)
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 127, in compose_mapping_node
    while not self.check_event(MappingEndEvent):
  File "/usr/local/lib/python3.6/dist-packages/yaml/parser.py", line 98, in check_event
    self.current_event = self.state()
  File "/usr/local/lib/python3.6/dist-packages/yaml/parser.py", line 428, in parse_block_mapping_key
    if self.check_token(KeyToken):
  File "/usr/local/lib/python3.6/dist-packages/yaml/scanner.py", line 115, in check_token
    while self.need_more_tokens():
  File "/usr/local/lib/python3.6/dist-packages/yaml/scanner.py", line 149, in need_more_tokens
    self.stale_possible_simple_keys()
  File "/usr/local/lib/python3.6/dist-packages/yaml/scanner.py", line 289, in stale_possible_simple_keys
    "could not find expected ':'", self.get_mark())
yaml.scanner.ScannerError: while scanning a simple key
  in "<unicode string>", line 197, column 5:
        been decided to not implement it ... 
        ^
could not find expected ':'
  in "<unicode string>", line 198, column 5:
        https://github.com/ansible/ansib ... 
        ^
make: *** [modules] Error 1

The test ansible-test sanity --test pep8 [explain] failed with 2 errors:

lib/ansible/modules/packaging/os/yum.py:212:82: W291 trailing whitespace
lib/ansible/modules/packaging/os/yum.py:213:60: W291 trailing whitespace

The test ansible-test sanity --test validate-modules [explain] failed with 4 errors:

lib/ansible/modules/packaging/os/yum.py:0:0: E326 Value for "choices" from the argument_spec (['absent', 'installed', 'latest', 'present', 'removed']) for "state" does not match the documentation ([])
lib/ansible/modules/packaging/os/yum.py:0:0: E326 Value for "choices" from the argument_spec (['auto', 'yum', 'yum4', 'dnf']) for "use_backend" does not match the documentation ([])
lib/ansible/modules/packaging/os/yum.py:214:5: E302 DOCUMENTATION is not valid YAML
test/sanity/validate-modules/ignore.txt:993:1: A102 Remove since "lib/ansible/modules/packaging/os/yum.py" passes "E322" test

The test ansible-test sanity --test yamllint [explain] failed with 1 error:

lib/ansible/modules/packaging/os/yum.py:214:5: error DOCUMENTATION: syntax error: could not find expected ':'

click here for bot help

remove spaces on end of line

ansibot · 2018-10-29T15:30:29Z

The test ansible-test sanity --test ansible-doc --python 2.6 [explain] failed with 1 error:

lib/ansible/modules/packaging/os/yum.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 2.7 [explain] failed with 1 error:

lib/ansible/modules/packaging/os/yum.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.5 [explain] failed with 1 error:

lib/ansible/modules/packaging/os/yum.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.6 [explain] failed with 1 error:

lib/ansible/modules/packaging/os/yum.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.7 [explain] failed with 1 error:

lib/ansible/modules/packaging/os/yum.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test docs-build [explain] failed with the error:

Command "/usr/bin/python test/sanity/code-smell/docs-build.py" returned exit status 1.
>>> Standard Error
Command 'make singlehtmldocs' failed with status code: 2
--> Standard Output
cat _themes/srtd/static/css/theme.css | sed -e 's/^[ 	]*//g; s/[ 	]*$//g; s/\([:{;,]\) /\1/g; s/ {/{/g; s/\/\*.*\*\///g; /^$/d' | sed -e :a -e '$!N; s/\n\(.\)/\1/; ta' > _themes/srtd/static/css/theme.min.css
PYTHONPATH=../../lib ../bin/dump_config.py --template-file=../templates/config.rst.j2 --output-dir=rst/reference_appendices/ -d ../../lib/ansible/config/base.yml
mkdir -p rst/cli
PYTHONPATH=../../lib ../bin/generate_man.py --template-file=../templates/cli_rst.j2 --output-dir=rst/cli/ --output-format rst ../../lib/ansible/cli/*.py
PYTHONPATH=../../lib ../bin/dump_keywords.py --template-dir=../templates --output-dir=rst/reference_appendices/ -d ./keyword_desc.yml
PYTHONPATH=../../lib ../bin/plugin_formatter.py -t rst --template-dir=../templates --module-dir=../../lib/ansible/modules -o rst/modules/ 
Makefile:93: recipe for target 'modules' failed
--> Standard Error
Traceback (most recent call last):
  File "../bin/plugin_formatter.py", line 720, in <module>
    main()
  File "../bin/plugin_formatter.py", line 678, in main
    plugin_info, categories = get_plugin_info(options.module_dir, limit_to=options.limit_to, verbose=(options.verbosity > 0))
  File "../bin/plugin_formatter.py", line 269, in get_plugin_info
    doc, examples, returndocs, metadata = plugin_docs.get_docstring(module_path, fragment_loader, verbose=verbose)
  File "/root/ansible/lib/ansible/utils/plugin_docs.py", line 99, in get_docstring
    data = read_docstring(filename, verbose=verbose, ignore_errors=ignore_errors)
  File "/root/ansible/lib/ansible/parsing/plugin_docs.py", line 62, in read_docstring
    data[varkey] = AnsibleLoader(child.value.s, file_name=filename).get_single_data()
  File "/usr/local/lib/python3.6/dist-packages/yaml/constructor.py", line 35, in get_single_data
    node = self.get_single_node()
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 36, in get_single_node
    document = self.compose_document()
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 55, in compose_document
    node = self.compose_node(None, None)
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 84, in compose_node
    node = self.compose_mapping_node(anchor)
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 133, in compose_mapping_node
    item_value = self.compose_node(node, item_key)
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 82, in compose_node
    node = self.compose_sequence_node(anchor)
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 111, in compose_sequence_node
    node.value.append(self.compose_node(node, index))
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 84, in compose_node
    node = self.compose_mapping_node(anchor)
  File "/usr/local/lib/python3.6/dist-packages/yaml/composer.py", line 127, in compose_mapping_node
    while not self.check_event(MappingEndEvent):
  File "/usr/local/lib/python3.6/dist-packages/yaml/parser.py", line 98, in check_event
    self.current_event = self.state()
  File "/usr/local/lib/python3.6/dist-packages/yaml/parser.py", line 428, in parse_block_mapping_key
    if self.check_token(KeyToken):
  File "/usr/local/lib/python3.6/dist-packages/yaml/scanner.py", line 115, in check_token
    while self.need_more_tokens():
  File "/usr/local/lib/python3.6/dist-packages/yaml/scanner.py", line 149, in need_more_tokens
    self.stale_possible_simple_keys()
  File "/usr/local/lib/python3.6/dist-packages/yaml/scanner.py", line 289, in stale_possible_simple_keys
    "could not find expected ':'", self.get_mark())
yaml.scanner.ScannerError: while scanning a simple key
  in "<unicode string>", line 197, column 5:
        been decided to not implement it ... 
        ^
could not find expected ':'
  in "<unicode string>", line 198, column 5:
        https://github.com/ansible/ansib ... 
        ^
make: *** [modules] Error 1

The test ansible-test sanity --test validate-modules [explain] failed with 4 errors:

lib/ansible/modules/packaging/os/yum.py:0:0: E326 Value for "choices" from the argument_spec (['absent', 'installed', 'latest', 'present', 'removed']) for "state" does not match the documentation ([])
lib/ansible/modules/packaging/os/yum.py:0:0: E326 Value for "choices" from the argument_spec (['auto', 'yum', 'yum4', 'dnf']) for "use_backend" does not match the documentation ([])
lib/ansible/modules/packaging/os/yum.py:214:5: E302 DOCUMENTATION is not valid YAML
test/sanity/validate-modules/ignore.txt:993:1: A102 Remove since "lib/ansible/modules/packaging/os/yum.py" passes "E322" test

The test ansible-test sanity --test yamllint [explain] failed with 1 error:

lib/ansible/modules/packaging/os/yum.py:214:5: error DOCUMENTATION: syntax error: could not find expected ':'

click here for bot help

add quotes

maxamillion · 2018-11-01T15:56:07Z

@biohazd I'm +1 to the change, but would you mind adding some context just in case people don't know what that means at face value? ... maybe something like If you need to clear yum cache and metadata use ....

mkrizek · 2018-11-06T13:33:41Z

cc @acozine

biohazd · 2018-11-06T15:09:51Z

thanks, let me update the wording.

adding a more fuller explanation for using shell

maxamillion · 2018-11-06T19:50:34Z

rebuild_merge

acozine · 2018-11-07T15:26:59Z

Don't know why the bot didn't merge this one. But since it didn't, I will!

add explanation why you must use "shell: yum clean all" and why it won't be included in the yum module as per ansible#31450 (comment)

Update yum.py

d27247c

adding explanation why you must use "shell: yum clean all" and why it won't be included in the yum module as per ansible#31450 (comment) +label: docsite_pr

ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Oct 29, 2018

Update yum.py

e685698

remove spaces on end of line

Update yum.py

d093cff

add quotes

ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed small_patch needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Oct 29, 2018

jborean93 removed the needs_triage Needs a first human triage before being processed. label Nov 1, 2018

jborean93 requested a review from maxamillion November 1, 2018 04:47

Update yum.py

0908c8f

adding a more fuller explanation for using shell

acozine added this to To do in OLD Ansible Documentation via automation Nov 7, 2018

acozine merged commit 20e1a33 into ansible:devel Nov 7, 2018

biohazd deleted the patch-2 branch November 8, 2018 12:27

acozine moved this from To do to In progress in OLD Ansible Documentation Nov 9, 2018

acozine moved this from In progress to Done in OLD Ansible Documentation Nov 9, 2018

dagwieers added the docsite_pr This PR is created from documentation using the "Edit on GitHub" link. label Nov 17, 2018

mjmayer pushed a commit to mjmayer/ansible that referenced this pull request Nov 30, 2018

Update yum.py (ansible#47749)

a3e6a66

add explanation why you must use "shell: yum clean all" and why it won't be included in the yum module as per ansible#31450 (comment)

Tomorrow9 pushed a commit to Tomorrow9/ansible that referenced this pull request Dec 4, 2018

Update yum.py (ansible#47749)

423d639

add explanation why you must use "shell: yum clean all" and why it won't be included in the yum module as per ansible#31450 (comment)

dagwieers added the packaging Packaging category label Mar 3, 2019

ansible locked and limited conversation to collaborators Jul 22, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update yum.py #47749

Update yum.py #47749

biohazd commented Oct 29, 2018

ansibot commented Oct 29, 2018

ansibot commented Oct 29, 2018

ansibot commented Oct 29, 2018

ansibot commented Oct 29, 2018

maxamillion commented Nov 1, 2018

mkrizek commented Nov 6, 2018

biohazd commented Nov 6, 2018

maxamillion commented Nov 6, 2018

acozine commented Nov 7, 2018

Update yum.py #47749

Update yum.py #47749

Conversation

biohazd commented Oct 29, 2018

SUMMARY

ISSUE TYPE

COMPONENT NAME

ANSIBLE VERSION

ADDITIONAL INFORMATION

ansibot commented Oct 29, 2018

ansibot commented Oct 29, 2018

ansibot commented Oct 29, 2018

ansibot commented Oct 29, 2018

maxamillion commented Nov 1, 2018

mkrizek commented Nov 6, 2018

biohazd commented Nov 6, 2018

maxamillion commented Nov 6, 2018

acozine commented Nov 7, 2018