revise comments about the deprecated flags in netcdf.h to avoid confusion

This commit is contained in:
Wei-keng Liao 2019-02-26 11:16:54 -06:00
parent 142cd5b5ca
commit 8ebe73059c

View File

@ -150,18 +150,16 @@ Use this in mode flags for both nc_create() and nc_open(). */
#define NC_NETCDF4 0x1000 /**< Use netCDF-4/HDF5 format. Mode flag for nc_create(). */
/** Turn on MPI I/O.
Use this in mode flags for both nc_create() and nc_open(). */
/** The following 3 flags are deprecated as of 4.6.2. Parallel I/O is now
* initiated by calling nc_create_par and nc_open_par, no longer by flags.
*/
#define NC_MPIIO 0x2000 /**< \deprecated */
/** Turn on MPI POSIX I/O.
Use this in mode flags for both nc_create() and nc_open(). */
#define NC_MPIPOSIX NC_MPIIO /**< \deprecated As of libhdf5 1.8.13. Now an alias */
#define NC_MPIPOSIX NC_MPIIO /**< \deprecated */
#define NC_PNETCDF (NC_MPIIO) /**< \deprecated */
#define NC_PERSIST 0x4000 /**< Save diskless contents to disk. Mode flag for nc_open() or nc_create() */
#define NC_INMEMORY 0x8000 /**< Read from memory. Mode flag for nc_open() or nc_create() */
#define NC_PNETCDF (NC_MPIIO) /**< \deprecated Use PnetCDF library; alias for NC_MPIIO. */
#define NC_MAX_MAGIC_NUMBER_LEN 8 /**< Max len of user-defined format magic number. */
/** Format specifier for nc_set_default_format() and returned