Skip to content

Commit 9d17a11

Browse files
Update doc for region_jcl module to include new member behaviour
1 parent d51657a commit 9d17a11

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

docs/source/modules/region_jcl.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -855,6 +855,8 @@ region_data_sets
855855
dsn
856856
The data set name of the JCL data set to override the template.
857857

858+
The data set name can also be set to a member of an existing PDS/E
859+
858860

859861
| **required**: False
860862
| **type**: str
@@ -3444,6 +3446,8 @@ space_primary
34443446

34453447
If this option is not set, the primary space is dynamically calculated based on the size of the generated CICS startup JCL.
34463448

3449+
If the target data set is a member in a PDS/E, then this value will not have any effect.
3450+
34473451

34483452
| **required**: False
34493453
| **type**: int
@@ -3457,6 +3461,8 @@ space_secondary
34573461

34583462
If this option is not set, the secondary space is dynamically calculated as 10% of the total size of the generated CICS startup JCL.
34593463

3464+
If the target data set is a member in a PDS/E, then this value will not have any effect.
3465+
34603466

34613467
| **required**: False
34623468
| **type**: int
@@ -3472,6 +3478,8 @@ space_type
34723478

34733479
If neither \ :literal:`space\_secondary`\ nor \ :literal:`space\_primary`\ is set, then this value does not have any effect.
34743480

3481+
If the target data set is a member in a PDS/E, then this value will not have any effect.
3482+
34753483

34763484
| **required**: False
34773485
| **type**: str
@@ -3527,6 +3535,8 @@ steplib
35273535
volumes
35283536
The volume(s) where the data set is created. Use a string to define a singular volume or a list of strings for multiple volumes.
35293537

3538+
If the target data set is a member in a PDS/E, then this value will not have any effect
3539+
35303540

35313541
| **required**: False
35323542
| **type**: raw

plugins/doc_fragments/region_jcl.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ class ModuleDocFragment(object):
1919
If the CICS startup JCL data set already exists, the option has no effect.
2020
- If this option is not set, the primary space is dynamically calculated based on the
2121
size of the generated CICS startup JCL.
22+
- If the target data set is a member in a PDS/E, then this value will not have any
23+
effect.
2224
type: int
2325
required: false
2426
space_secondary:
@@ -29,6 +31,8 @@ class ModuleDocFragment(object):
2931
If the CICS startup JCL data set already exists, the option has no effect.
3032
- If this option is not set, the secondary space is dynamically calculated as 10% of
3133
the total size of the generated CICS startup JCL.
34+
- If the target data set is a member in a PDS/E, then this value will not have any
35+
effect.
3236
type: int
3337
required: false
3438
space_type:
@@ -42,6 +46,8 @@ class ModuleDocFragment(object):
4246
cylinders (V(CYL)), or tracks (V(TRK)).
4347
- If neither O(space_secondary) nor O(space_primary) is set, then this value does
4448
not have any effect.
49+
- If the target data set is a member in a PDS/E, then this value will not have any
50+
effect.
4551
required: false
4652
type: str
4753
choices:
@@ -53,6 +59,8 @@ class ModuleDocFragment(object):
5359
volumes:
5460
description:
5561
- The volume(s) where the data set is created. Use a string to define a singular volume or a list of strings for multiple volumes.
62+
- If the target data set is a member in a PDS/E, then this value will not have any
63+
effect
5664
type: raw
5765
required: false
5866
state:
@@ -463,6 +471,7 @@ class ModuleDocFragment(object):
463471
dsn:
464472
description:
465473
- The data set name of the JCL data set to override the template.
474+
- The data set name can also be set to a member of an existing PDS/E
466475
type: str
467476
required: false
468477
output_data_sets:

0 commit comments

Comments
 (0)