Skip to content

Commit ab2120d

Browse files
committed
add note about PR 173
1 parent a7104b5 commit ab2120d

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

sneak_peek.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,5 +91,22 @@ This is essentially a placeholder for the next release note ...
9191
+ none
9292

9393
* Clarifications
94-
+ none
94+
+ There are three ways in PnetCDF for user to set hints to adjust file header
95+
extent size, for example. Users may set the same hints multiple times
96+
during the run of their applications. When this happens, PnetCDF implements
97+
the following hint precedence.
98+
* 1st priority: hints set in the environment variable `PNETCDF_HINTS`, e.g.
99+
`PNETCDF_HINTS="nc_var_align_size=1024"`
100+
* 2nd priority: hints passed from arguments of `ncmpi__enddef()`, e.g.
101+
`ncmpi__enddef(..., v_align=1024,...)`
102+
* 3rd priority: hints set in the MPI info objects passed into calls to
103+
`ncmpi_create()` and `ncmpi_open()`, e.g.
104+
`MPI_Info_set("nc_var_align_size", "1024");`
105+
See [PR #173](https://github.com/Parallel-NetCDF/PnetCDF/pull/173).
106+
+ PnetCDF I/O hint `nc_header_align_size` is essentially the same as hint
107+
`nc_var_align_size`, but name of the former is closer to the intent, i.e.
108+
to adjust the header space to reserve space for possible expansion in the
109+
future when new data objects are added. However, when both hints were set
110+
by the users, only hint `nc_var_align_size` will take effect in PnetCDF and
111+
`nc_header_align_size` will be ignored.
95112

0 commit comments

Comments
 (0)