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

Add_at_the_documentation_about_known_issues #1284

Closed
wants to merge 12 commits into from
Closed

Add_at_the_documentation_about_known_issues #1284

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
403fad2
Add to the documentation about known issues
AndreMarcel99 Mar 6, 2024
7ed12fa
Add fragment
AndreMarcel99 Mar 6, 2024
d1c40c5
Merge branch 'dev' into documentation/notify_new_possible_errors
AndreMarcel99 Mar 7, 2024
8ed1d75
Merge branch 'dev' into documentation/notify_new_possible_errors
AndreMarcel99 Mar 8, 2024
97faf96
Merge branch 'dev' into documentation/notify_new_possible_errors
fernandofloresg Mar 19, 2024
bd28e8c
Update 1284_add-at-the-documenation-about-known-issues.yml
fernandofloresg Mar 19, 2024
c6fb754
Merge branch 'dev' into documentation/notify_new_possible_errors
AndreMarcel99 Apr 4, 2024
88551b7
Merge branch 'dev' into documentation/notify_new_possible_errors
AndreMarcel99 Apr 9, 2024
52a37d1
Update documentation
AndreMarcel99 Apr 11, 2024
5909fd2
Update zos_lineinfile.py
AndreMarcel99 Aug 14, 2024
5dda3ba
Update zos_blockinfile.py
AndreMarcel99 Aug 14, 2024
e6d86a3
Merge branch 'dev' into documentation/notify_new_possible_errors
AndreMarcel99 Aug 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions changelogs/fragments/1284_add-at-the-documenation-about-known-issues.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
trivial:
- zos_blockinfile - Add information about known issues in notes.
- zos_lineinfile - Add information about known issues in notes.
(https://github.com/ansible-collections/ibm_zos_core/pull/1284).
3 changes: 3 additions & 0 deletions plugins/modules/zos_blockinfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,9 @@
the block will be overwritten on each iteration.
- When more then one block should be handled in a file you must change
the I(marker) per task.
- If using ZOAU version 1.3.0 and double quotes (") in the block argument, the module
will throw a false negative response. Follow up on the
L(issue in the collection's repository,https://github.com/ansible-collections/ibm_zos_core/issues/1258).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps the note here can be expanded upon to include some additional details. Maybe something like:

With ZOAU version 1.3.0, if double quotes (") are used in the I(block) parameter, the module
fails with an error message containing: 'return content is NOT in json format'. This is currently a false negative response, where the I(src) is changed, but an error is reported anyhow. Follow up on the issue tracked L(here,#1258).

Feel free to re-reword what I've got, my point is just to add more info about the behavior for the user.

seealso:
- module: zos_data_set
'''
Expand Down
3 changes: 3 additions & 0 deletions plugins/modules/zos_lineinfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,9 @@
needs to be encoded, it should be cataloged first.
- For supported character sets used to encode data, refer to the
L(documentation,https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/resources/character_set.html).
- When working with an MVS file and ZOAU version 1.3.0, combining C(regexp)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if MVS file is an official z/OS term, if it's data sets, maybe use data sets? Valid data sets are already defined above, so we probably don't need to re-specify them

When working with data sets and ZOAU version 1.3.0, combining ...

Also, "throw an error" is more of a developer-y word to me, maybe we can say the "module fails or something like that?

Maybe:

When working with ZOAU version 1.3.0, the module fails when C(src) is a data set and either C(insertafter) or C(insertbefore) is set in addition to C(regexp).

^ I like having the ZOAU version right at the beginning so if anyone is on a different version, they dont have to bother reading the rest of the sentence

with either C(insertafter) or C(insertbefore), will throw an error.
Follow up on the L(issue in the collection's repository,https://github.com/ansible-collections/ibm_zos_core/issues/1244).
"""

EXAMPLES = r"""
Expand Down