mirror/netcdf-c
2
0
Fork 0
mirror of https://github.com/Unidata/netcdf-c.git synced 2025-03-25 17:40:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fixed documentation as suggested in e-support ticket KJK-861023 (H/T Charlie Zender)

Browse Source
This commit is contained in:
Dennis Heimbigner 2012-04-04 04:44:51 +00:00
parent 5f9cec5f65
commit 60e48cf51d
2 changed files with 28 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
RELEASE_NOTES
View File

@ -3,7 +3,7 @@ Entries are in reverse chronological order (most recent first).
VERSION COMMENTS
------- --------
4.3 Released ????-??-?? (Note: Jira entries include reference to '[NCF-XX]')
4.2.1 Released ????-??-?? (Note: Jira entries include reference to '[NCF-XX]')
Fixed bug in 64-bit offset files with large records
due to last record variable requiring more than 2**32

43
libdispatch/dfile.c
View File

@ -215,6 +215,8 @@ an appropriately large value of the initialsz parameter. This is
because the in-memory file is kept as a single piece of heap memory,
and specifying the initial size will reduce the number of heap reallocations.
Note that nc_create(path,cmode,ncidp) is equivalent to the invocation of
nc__create(path,cmode,NC_SIZEHINT_DEFAULT,NULL,ncidp).
\returns ::NC_NOERR No error.
@ -340,21 +342,26 @@ Like nc_create(), this function creates a netCDF file.
be advantageous to set the size of the output file at creation
time. This parameter sets the initial size of the file at creation
time. This only applies to classic and 64-bit offset files.
The special value NC_SIZEHINT_DEFAULT (which is the value 0),
lets the netcdf library choose a suitable initial size.
\param chunksizehintp A pointer to the chunk size hint, which controls
a space versus time tradeoff, memory allocated in the netcdf library
versus number of system calls. Because of internal requirements, the
value may not be set to exactly the value requested. The actual value
chosen is returned by reference. Using the value NC_SIZEHINT_DEFAULT
causes the library to choose a default. How the system chooses the
default depends on the system. On many systems, the "preferred I/O
block size" is available from the stat() system call, struct stat
member st_blksize. If this is available it is used. Lacking that,
twice the system pagesize is used. Lacking a call to discover the
system pagesize, we just set default bufrsize to 8192. The bufrsize is
a property of a given open netcdf descriptor ncid, it is not a
persistent property of the netcdf dataset. This only applies to
classic and 64-bit offset files.
\param chunksizehintp A pointer to the chunk size hint,
which controls a space versus time tradeoff, memory
allocated in the netcdf library versus number of system
calls. Because of internal requirements, the value may not
be set to exactly the value requested. The actual value
chosen is returned by reference. Using a NULL pointer or
having the pointer point to the value NC_SIZEHINT_DEFAULT
causes the library to choose a default. How the system
chooses the default depends on the system. On many systems,
the "preferred I/O block size" is available from the stat()
system call, struct stat member st_blksize. If this is
available it is used. Lacking that, twice the system
pagesize is used. Lacking a call to discover the system
pagesize, we just set default bufrsize to 8192. The bufrsize
is a property of a given open netcdf descriptor ncid, it is
not a persistent property of the netcdf dataset. This only
applies to classic and 64-bit offset files.
\param ncidp Pointer to location where returned netCDF ID is to be
stored.
@ -458,6 +465,9 @@ nc_open()returns the value NC_NOERR if no errors occurred. Otherwise,
the returned status indicates an error. Possible causes of errors
include:
Note that nc_open(path,cmode,ncidp) is equivalent to the invocation of
nc__open(path,cmode,NC_SIZEHINT_DEFAULT,NULL,ncidp).
\returns ::NC_NOERR No error.
\returns ::NC_ENOMEM Out of memory.
@ -514,8 +524,9 @@ system calls.
Because of internal requirements, the value may not be set to exactly
the value requested. The actual value chosen is returned by reference.
Using the value NC_SIZEHINT_DEFAULT causes the library to choose a
default. How the system chooses the default depends on the system. On
Using a NULL pointer or having the pointer point to the value
NC_SIZEHINT_DEFAULT causes the library to choose a default.
How the system chooses the default depends on the system. On
many systems, the "preferred I/O block size" is available from the
stat() system call, struct stat member st_blksize. If this is
available it is used. Lacking that, twice the system pagesize is used.