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.

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

[Documentation] [zos_data_set] Update member doc to explain what type of member is created #631

Closed
ddimatos opened this issue Feb 9, 2023 · 1 comment
Assignees
Labels
Documentation Report documetation errors or needed changes

Comments

@ddimatos
Copy link
Collaborator

ddimatos commented Feb 9, 2023

Documentation issue description

The zos_data_set with MEMBER option creates a member, there is no indication of what type of member is created, looking over the source it is a data type member, recall that in a PDS/E you can have program object members or data members but not both in the same PDS/E.

The doc not stating what kind of member is being created can lead people in a place where if they try to write a LOADLIB or program object would yield an error.


    The data set type to be used when creating a data set. (e.g pdse)

    MEMBER expects to be used with an existing partitioned data set.

    Choices are case-insensitive.
    required: False
    type: str
    default: PDS
    choices: KSDS, ESDS, RRDS, LDS, SEQ, PDS, PDSE, LIBRARY, BASIC, LARGE, MEMBER, HFS, ZFS

Some verbiage about what type of Member is created and a reminder that the member created is a data member and not suitable for a library.

Ansible version

No response

IBM z/OS Ansible core Version

v1.4.0-beta.2

Ansible module

zos_data_set

@ddimatos ddimatos added the Documentation Report documetation errors or needed changes label Feb 9, 2023
@ddimatos ddimatos added the Needs Triage Issue need assessment by a team member(s) label Feb 9, 2023
@ddimatos ddimatos removed the Needs Triage Issue need assessment by a team member(s) label Mar 26, 2023
@ddimatos ddimatos added this to the [Q2] [2023] Documentation milestone Mar 26, 2023
@ddimatos ddimatos moved this from 📗In plan to 👀 Reviewing in IBM Ansible z/OS Core Collection May 11, 2023
@ddimatos ddimatos moved this from 👀 Reviewing to 📗In plan in IBM Ansible z/OS Core Collection May 11, 2023
@ddimatos
Copy link
Collaborator Author

ddimatos commented Jun 3, 2023

For added clarity, i added

            If I(state=present) and I(type=MEMBER) and the member does not exist in the data set,
            create a member formatted to store data, module completes successfully with I(changed=True).
            Note, a PDSE does not allow a mixture of formats such that there is
            executables (program objects) and data. The member created is formatted to store data,
            not an executable.

@ddimatos ddimatos moved this from 📗In plan to 🔍 Validation in IBM Ansible z/OS Core Collection Jun 3, 2023
@ddimatos ddimatos moved this from 🔍 Validation to 🏗 In progress in IBM Ansible z/OS Core Collection Jun 9, 2023
@ddimatos ddimatos moved this from 🏗 In progress to 🔍 Validation in IBM Ansible z/OS Core Collection Jun 12, 2023
@ddimatos ddimatos moved this from 🔍 Validation to ✅ Done in IBM Ansible z/OS Core Collection Jun 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Report documetation errors or needed changes
Projects
Development

No branches or pull requests

2 participants