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

Fix typos in property callback documentation #4532

Merged
merged 5 commits into from
May 30, 2024
Merged

Fix typos in property callback documentation #4532

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c13fd2f
Fix typo in MPI info prop callback
mattjala May 29, 2024
dbb674b
Fix typos in message index type callbacks
mattjala May 29, 2024
e07dd6d
Typos in fapl, gcpl, lapl
mattjala May 29, 2024
04f8bd2
Fix typos in H5Pocpypl.c
mattjala May 29, 2024
64992f5
commmitted -> committed
mattjala May 29, 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
12 changes: 8 additions & 4 deletions src/H5Pfapl.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4976,7 +4976,9 @@ H5Pget_file_locking(hid_t fapl_id, hbool_t *use_file_locking /*out*/, hbool_t *i
/*-------------------------------------------------------------------------
* Function: H5P__encode_coll_md_read_flag_t
*
* Purpose: Generic encoding callback routine for 'coll_md_read_flag' properties.
* Purpose: Callback routine which is called whenever the collective
* metadata read flag property in the file creation property list is
* encoded.
*
* Return: Success: Non-negative
* Failure: Negative
Expand Down Expand Up @@ -5010,7 +5012,9 @@ H5P__encode_coll_md_read_flag_t(const void *value, void **_pp, size_t *size)
/*-------------------------------------------------------------------------
* Function: H5P__decode_coll_md_read_flag_t
*
* Purpose: Generic decoding callback routine for 'coll_md_read_flag' properties.
* Purpose: Callback routine which is called whenever the collective
* metadata read flag property in the file creation property list is
* decoded.
*
* Return: Success: Non-negative
* Failure: Negative
Expand All @@ -5030,7 +5034,7 @@ H5P__decode_coll_md_read_flag_t(const void **_pp, void *_value)
assert(*pp);
assert(coll_md_read_flag);

/* Decode file close degree */
/* Decode metadata read flag */
*coll_md_read_flag = (H5P_coll_md_read_flag_t) * (*pp);
*pp += sizeof(H5P_coll_md_read_flag_t);

Expand Down Expand Up @@ -5468,7 +5472,7 @@ H5P__facc_mpi_info_set(hid_t H5_ATTR_UNUSED prop_id, const char H5_ATTR_UNUSED *
/*-------------------------------------------------------------------------
* Function: H5P__facc_mpi_info_get
*
* Purpose: Copies an MPI comminicator property when it's retrieved from a property list
* Purpose: Copies an MPI info object property when it's retrieved from a property list
*
* Return: Success: Non-negative
* Failure: Negative
Expand Down
16 changes: 8 additions & 8 deletions src/H5Pfcpl.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -645,7 +645,7 @@ H5Pget_istore_k(hid_t plist_id, unsigned *ik /*out*/)
* Function: H5P__fcrt_btree_rank_enc
*
* Purpose: Callback routine which is called whenever the index storage
* btree in file creation property list is encoded.
* btree in a file creation property list is encoded.
*
* Return: Success: Non-negative
* Failure: Negative
Expand Down Expand Up @@ -688,7 +688,7 @@ H5P__fcrt_btree_rank_enc(const void *value, void **_pp, size_t *size)
* Function: H5P__fcrt_btree_rank_dec
*
* Purpose: Callback routine which is called whenever the index storage
* btree in file creation property list is decoded.
* btree in a file creation property list is decoded.
*
* Return: Success: Non-negative
* Failure: Negative
Expand Down Expand Up @@ -909,8 +909,8 @@ H5Pget_shared_mesg_index(hid_t plist_id, unsigned index_num, unsigned *mesg_type
* Function: H5P__fcrt_shmsg_index_types_enc
*
* Purpose: Callback routine which is called whenever the shared
* message indec types in file creation property list
* is encoded.
* message index types in a file creation property list
* are encoded.
*
* Return: Success: Non-negative
* Failure: Negative
Expand Down Expand Up @@ -953,8 +953,8 @@ H5P__fcrt_shmsg_index_types_enc(const void *value, void **_pp, size_t *size)
* Function: H5P__fcrt_shmsg_index_types_dec
*
* Purpose: Callback routine which is called whenever the shared
* message indec types in file creation property list
* is decoded.
* message index types in a file creation property list
* are decoded.
*
* Return: Success: Non-negative
* Failure: Negative
Expand Down Expand Up @@ -994,7 +994,7 @@ H5P__fcrt_shmsg_index_types_dec(const void **_pp, void *_value)
* Function: H5P__fcrt_shmsg_index_minsize_enc
*
* Purpose: Callback routine which is called whenever the shared
* message index minsize in file creation property list
* message index minsize in a file creation property list
* is encoded.
*
* Return: Success: Non-negative
Expand Down Expand Up @@ -1038,7 +1038,7 @@ H5P__fcrt_shmsg_index_minsize_enc(const void *value, void **_pp, size_t *size)
* Function: H5P__fcrt_shmsg_index_minsize_dec
*
* Purpose: Callback routine which is called whenever the shared
* message indec minsize in file creation property list
* message index minsize in a file creation property list
* is decoded.
*
* Return: Success: Non-negative
Expand Down
4 changes: 2 additions & 2 deletions src/H5Pgcpl.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,7 @@ H5Pget_link_creation_order(hid_t plist_id, unsigned *crt_order_flags /*out*/)
* Function: H5P__gcrt_group_info_enc
*
* Purpose: Callback routine which is called whenever the group
* property in the dataset access property list is
* info property in the dataset access property list is
* encoded.
*
* Return: Success: Non-negative
Expand Down Expand Up @@ -564,7 +564,7 @@ H5P__gcrt_group_info_dec(const void **_pp, void *_value)
* Function: H5P__gcrt_link_info_enc
*
* Purpose: Callback routine which is called whenever the link
* property in the dataset access property list is
* info property in the dataset access property list is
* encoded.
*
* Return: Success: Non-negative
Expand Down
2 changes: 1 addition & 1 deletion src/H5Plapl.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -634,7 +634,7 @@ H5P__lacc_elink_pref_get(hid_t H5_ATTR_UNUSED prop_id, const char H5_ATTR_UNUSED
/*-------------------------------------------------------------------------
* Function: H5P__lacc_elink_pref_enc
*
* Purpose: Callback routine which is called whenever the elink flags
* Purpose: Callback routine which is called whenever the elink prefix
* property in the dataset access property list is
* encoded.
*
Expand Down
18 changes: 9 additions & 9 deletions src/H5Pocpypl.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ H5P__ocpy_reg_prop(H5P_genclass_t *pclass)
/*-------------------------------------------------------------------------
* Function: H5P__free_merge_comm_dtype_list
*
* Purpose: Frees the provided merge named dtype list
* Purpose: Frees the provided merge committed dtype list
*
* Return: NULL
*
Expand Down Expand Up @@ -329,9 +329,9 @@ H5P__ocpy_merge_comm_dt_list_get(hid_t H5_ATTR_UNUSED prop_id, const char H5_ATT
/*-------------------------------------------------------------------------
* Function: H5P__ocpy_merge_comm_dt_list_enc
*
* Purpose: Callback routine which is called whenever the common
* datatype property in the object copy property list is
* decoded.
* Purpose: Callback routine which is called whenever the merge
* committed datatype list property in the object copy
* property list is encoded.
*
* Return: Success: Non-negative
* Failure: Negative
Expand Down Expand Up @@ -383,9 +383,9 @@ H5P__ocpy_merge_comm_dt_list_enc(const void *value, void **_pp, size_t *size)
/*-------------------------------------------------------------------------
* Function: H5P__ocpy_merge_comm_dt_list_dec
*
* Purpose: Callback routine which is called whenever the common
* datatype property in the dataset access property list is
* decoded.
* Purpose: Callback routine which is called whenever the merge
* committed datatype list property in the object copy
* property list is decoded.
*
* Return: Success: Non-negative
* Failure: Negative
Expand Down Expand Up @@ -564,7 +564,7 @@ H5P__ocpy_merge_comm_dt_list_cmp(const void *_dt_list1, const void *_dt_list2, s
/*--------------------------------------------------------------------------
* Function: H5P__ocpy_merge_comm_dt_list_close
*
* Purpose: Close the merge common datatype list property
* Purpose: Close the merge committed datatype list property
*
* Return: Success: Non-negative
* Failure: Negative
Expand All @@ -578,7 +578,7 @@ H5P__ocpy_merge_comm_dt_list_close(const char H5_ATTR_UNUSED *name, size_t H5_AT

assert(value);

/* Free the merge named dtype list */
/* Free the merge committed dtype list */
H5P__free_merge_comm_dtype_list(*(H5O_copy_dtype_merge_list_t **)value);

FUNC_LEAVE_NOAPI(SUCCEED)
Expand Down
Loading