Skip to content

Commit 2404731

Browse files
authored
Merge pull request #2249 from DennisHeimbigner/updatedocs.dmh
Update selected documentation
2 parents ee7039c + 821f69f commit 2404731

8 files changed

Lines changed: 1635 additions & 325 deletions

File tree

RELEASE_NOTES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This file contains a high-level description of this package's evolution. Release
77

88
## 4.8.2 - TBD
99

10+
* [Enhancement] Update the documentation to match the current filter capabilities See [Github #2249](https://github.com/Unidata/netcdf-c/pull/2249).
1011
* [Enhancement] Support installation of pre-built standard filters into user-specified location. See [Github #2318](https://github.com/Unidata/netcdf-c/pull/2318).
1112
* [Enhancement] Improve filter support. More specifically (1) add nc_inq_filter_avail to check if a filter is available, (2) add the notion of standard filters, (3) cleanup szip support to fix interaction with NCZarr. See [Github #2245](https://github.com/Unidata/netcdf-c/pull/2245).
1213
* [Enhancement] Switch to tinyxml2 as the default xml parser implementation. See [Github #2170](https://github.com/Unidata/netcdf-c/pull/2170).

docs/Doxyfile.in

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -754,7 +754,8 @@ INPUT = \
754754
@abs_top_srcdir@/docs/COPYRIGHT.md \
755755
@abs_top_srcdir@/docs/credits.md \
756756
@abs_top_srcdir@/docs/tutorial.dox \
757-
@abs_top_srcdir@/docs/internal.dox \
757+
@abs_top_srcdir@/docs/internal.md \
758+
@abs_top_srcdir@/docs/dispatch.md \
758759
@abs_top_srcdir@/docs/inmeminternal.dox \
759760
@abs_top_srcdir@/docs/indexing.dox \
760761
@abs_top_srcdir@/docs/testserver.dox \

docs/FAQ.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1079,9 +1079,22 @@ and writable by programs that used older versions of the libraries.
10791079
However, programs linked to older library versions will not be able to
10801080
create new data objects with the new less-restrictive names.
10811081

1082-
How difficult is it to convert my application to handle arbitrary netCDF-4 files? {#How-difficult-is-it-to-convert-my-application-to-handle-arbitrary-netCDF-4-files}
1082+
Can I use UTF-8 File Names with Windows? {#Can-I-use-UTF-8-File-Names-with-Windows}
10831083
-----------------
10841084

1085+
Starting with Windows 10 build 17134, Windows can support use of
1086+
the UTF-8 character set. We strongly encourage Windows users to
1087+
enable this feature. This requires the following steps.
1088+
1089+
1. In the "run" toolbar, execute the command "intl.cpl".
1090+
2. Move to the Administrative tab.
1091+
3. Move to "Change system locale"
1092+
4. Check the box at the bottom labeled something like
1093+
"Beta: Use Unicode UTF-8 for worldwide language support"
1094+
1095+
1096+
How difficult is it to convert my application to handle arbitrary netCDF-4 files? {#How-difficult-is-it-to-convert-my-application-to-handle-arbitrary-netCDF-4-files}
1097+
-----------------
10851098

10861099
Modifying an application to fully support the new enhanced data model
10871100
may be relatively easy or arbitrarily difficult :-), depending on what

docs/Makefile.am

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
# These files will be included with the dist.
1010
EXTRA_DIST = netcdf.m4 DoxygenLayout.xml Doxyfile.in footer.html \
1111
mainpage.dox tutorial.dox \
12-
architecture.dox internal.dox windows-binaries.md \
12+
architecture.dox internal.md windows-binaries.md dispatch.md \
1313
building-with-cmake.md CMakeLists.txt groups.dox notes.md \
1414
install-fortran.md all-error-codes.md credits.md auth.md filters.md \
1515
obsolete/fan_utils.html indexing.dox \

0 commit comments

Comments
 (0)