Renamed man4 directory to docs.

CMakeLists.txt

@@ -1137,7 +1137,7 @@ ENDIF()
 #####
 # Build doxygen documentation, if need be.
 #####
-ADD_SUBDIRECTORY(man4)
+ADD_SUBDIRECTORY(docs)
 #####
 # Moving on to CPack, install packages.
 #####
@@ -1159,7 +1159,7 @@ ENDIF()
 
 
 IF(ENABLE_DOXYGEN)
-  INSTALL(DIRECTORY man4 DESTINATION "." COMPONENT documentation)
+  INSTALL(DIRECTORY docs DESTINATION "." COMPONENT documentation)
 ENDIF()
 
 # Subdirectory CMakeLists.txt files should specify their own

Doxyfile

@@ -45,7 +45,7 @@ PROJECT_BRIEF          = "The netCDF C libraries"
 # exceed 55 pixels and the maximum width should not exceed 200 pixels. 
 # Doxygen will copy the logo to the output directory.
 
-PROJECT_LOGO           = ./man4/unidata_logo_cmyk.png
+PROJECT_LOGO           = ./docs/unidata_logo_cmyk.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
 # base path where the generated documentation will be put. 

Makefile.am

@@ -25,9 +25,9 @@ pkgconfigdir=$(libdir)/pkgconfig
 pkgconfig_DATA = netcdf.pc
 
 # We need a way to automatically generate INSTALL from
-# man4/install.doc, now that we've switched from texinfo to doxygen.
+# docs/install.doc, now that we've switched from texinfo to doxygen.
 # INSTALL:
-#	non-existent-doxygen-to-text-utility <  man4/install.doc > INSTALL
+#	non-existent-doxygen-to-text-utility <  docs/install.doc > INSTALL
 
 # Does the user want to build the V2 API?
 if BUILD_V2
@@ -89,7 +89,7 @@ SUBDIRS = include $(OCLIB) $(H5_TEST_DIR) libdispatch libsrc		\
 $(LIBSRC4_DIR) $(DAP2) $(LIBCDMR) $(LIBSRC5) liblib  \
 $(NCGEN3) $(NCGEN) $(NCDUMP) \
 $(TESTDIRS) \
-man4 $(EXAMPLES) \
+docs $(EXAMPLES) \
 $(UDUNITS) $(LIBCF)
 
 # Remove these generated files, for a distclean.

RELEASE_NOTES.md

@@ -9,7 +9,9 @@ This file contains a high-level description of this package's evolution. Release
 
 ### 4.3.3-rc1 Released TBD
 
-* Removed redundant variable `BUILD_DOCS` from the CMake configuration file.  See the issue at github: [BUILD\_DOCS, ENABLE\_DOXYGEN](https://github.com/Unidata/netcdf-c/issues/59).
+* Renamed `man4/` directory to `docs/` to make the purpose and contents clearer. See [man4 vs. docs #60](https://github.com/Unidata/netcdf-c/issues/60).
+
+* Removed redundant variable `BUILD_DOCS` from the CMake configuration file.  See the issue at github: [BUILD\_DOCS, ENABLE\_DOXYGEN #59](https://github.com/Unidata/netcdf-c/issues/59).
 
 * Added missing documentation templates to `man4/Makefile.am`, to correct an issue when trying to build the local `Doxygen`-generated documentation. This issue was reported by Nico Schlömer and may be viewed on github.  [Releases miss Doxygen files #56](https://github.com/Unidata/netcdf-c/issues/56)
 

configure.ac

@@ -627,13 +627,13 @@ fi
 if test "x$enable_doxygen" != xno; then
    if test -n "$DOXYGEN"; then
         AC_SUBST(HAVE_DOT)   
-        AC_CONFIG_FILES([man4/Doxyfile])
+        AC_CONFIG_FILES([docs/Doxyfile])
    fi
 # Note: the list of files to input to doxygen
-# has been moved to man4/Doxyfile.in so
+# has been moved to docs/Doxyfile.in so
 # that make distcheck works correctly.
 # Any new inputs should be inserted into
-# man4/Doxyfile.in and possibley man4/Makefile.am
+# docs/Doxyfile.in and possibley docs/Makefile.am
 fi
 
 # Find the install program.
@@ -1001,8 +1001,8 @@ AC_CONFIG_FILES([Makefile
                  netcdf.pc
                  include/Makefile
                  h5_test/Makefile
-                 man4/Makefile
-                 man4/images/Makefile
+                 docs/Makefile
+                 docs/images/Makefile
                  libsrc/Makefile
                  libsrc4/Makefile
                  libsrc5/Makefile

man4/CMakeLists.txt → docs/CMakeLists.txt

@@ -68,4 +68,4 @@ ENDIF()
 
 SET(CUR_EXTRA_DIST ${CUR_EXTRA_DIST} CMakeLists.txt Makefile.am netcdf.m4 DoxygenLayout.xml Doxyfile.in Doxyfile.guide.in footer.html mainpage.dox tutorial.dox install.dox dispatch.dox guide.dox types.dox notes.dox cdl.dox architecture.dox internal.dox install-fortran.dox Doxyfile.in.cmake windows-binaries.md building-with-cmake.md)
 
-ADD_EXTRA_DIST("${CUR_EXTRA_DIST}")
+ADD_EXTRA_DIST("${CUR_EXTRA_DIST}")

man4/Doxyfile.guide.in → docs/Doxyfile.guide.in

@@ -51,7 +51,7 @@ PROJECT_BRIEF          =
 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
 # to the output directory.
 
-PROJECT_LOGO           = ../../man4/netcdf-50x50.png
+PROJECT_LOGO           = ../../docs/netcdf-50x50.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -661,7 +661,7 @@ FILE_VERSION_FILTER    =
 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
 # tag is left empty.
 
-LAYOUT_FILE            = @abs_top_srcdir@/man4/DoxygenLayout.xml
+LAYOUT_FILE            = @abs_top_srcdir@/docs/DoxygenLayout.xml
 
 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
 # the reference definitions. This must be a list of .bib files. The .bib
@@ -743,7 +743,7 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT = @abs_top_srcdir@/man4/guide.dox
+INPUT = @abs_top_srcdir@/docs/guide.dox
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -831,19 +831,19 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH = @abs_top_srcdir@/man4/images/chunking2.png \
-    @abs_top_srcdir@/man4/images/compatibility3.png \
-    @abs_top_srcdir@/man4/images/compression.png \
-    @abs_top_srcdir@/man4/images/groups.png \
-    @abs_top_srcdir@/man4/images/nc4-model.png \
-    @abs_top_srcdir@/man4/images/ncatts.png \
-    @abs_top_srcdir@/man4/images/nc-classic-uml.png \
-    @abs_top_srcdir@/man4/images/nccoords.png \
-    @abs_top_srcdir@/man4/images/ncfile.png \
-    @abs_top_srcdir@/man4/images/netcdf_architecture.png \
-    @abs_top_srcdir@/man4/images/pnetcdf.png \
-    @abs_top_srcdir@/man4/images/deptree.jpg \
-    @abs_top_srcdir@/man4/images/InstallTreeWindows.jpg
+IMAGE_PATH = @abs_top_srcdir@/docs/images/chunking2.png \
+    @abs_top_srcdir@/docs/images/compatibility3.png \
+    @abs_top_srcdir@/docs/images/compression.png \
+    @abs_top_srcdir@/docs/images/groups.png \
+    @abs_top_srcdir@/docs/images/nc4-model.png \
+    @abs_top_srcdir@/docs/images/ncatts.png \
+    @abs_top_srcdir@/docs/images/nc-classic-uml.png \
+    @abs_top_srcdir@/docs/images/nccoords.png \
+    @abs_top_srcdir@/docs/images/ncfile.png \
+    @abs_top_srcdir@/docs/images/netcdf_architecture.png \
+    @abs_top_srcdir@/docs/images/pnetcdf.png \
+    @abs_top_srcdir@/docs/images/deptree.jpg \
+    @abs_top_srcdir@/docs/images/InstallTreeWindows.jpg
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
@@ -1076,7 +1076,7 @@ HTML_HEADER            =
 # that doxygen normally uses.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_FOOTER            = @abs_top_srcdir@/man4/footer.html
+HTML_FOOTER            = @abs_top_srcdir@/docs/footer.html
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
 # sheet that is used by each HTML page. It can be used to fine-tune the look of

man4/Doxyfile.in → docs/Doxyfile.in

@@ -51,7 +51,7 @@ PROJECT_BRIEF          =
 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
 # to the output directory.
 
-PROJECT_LOGO           = ../../man4/netcdf-50x50.png
+PROJECT_LOGO           = ../../docs/netcdf-50x50.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -661,7 +661,7 @@ FILE_VERSION_FILTER    =
 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
 # tag is left empty.
 
-LAYOUT_FILE            = @abs_top_srcdir@/man4/DoxygenLayout.xml
+LAYOUT_FILE            = @abs_top_srcdir@/docs/DoxygenLayout.xml
 
 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
 # the reference definitions. This must be a list of .bib files. The .bib
@@ -746,19 +746,19 @@ WARN_LOGFILE           =
 INPUT = \
     @abs_top_srcdir@/RELEASE_NOTES.md \
     @abs_top_srcdir@/COPYRIGHT \
-    @abs_top_srcdir@/man4/groups.dox \
-    @abs_top_srcdir@/man4/mainpage.dox \
-    @abs_top_srcdir@/man4/install.md \
-    @abs_top_srcdir@/man4/install-fortran.md \
-    @abs_top_srcdir@/man4/dispatch.dox \
-    @abs_top_srcdir@/man4/types.dox \
-    @abs_top_srcdir@/man4/notes.dox \
-    @abs_top_srcdir@/man4/cdl.dox \
-    @abs_top_srcdir@/man4/architecture.dox \
-    @abs_top_srcdir@/man4/internal.dox \
-    @abs_top_srcdir@/man4/windows-binaries.md \
-    @abs_top_srcdir@/man4/all-error-codes.md \
-    @abs_top_srcdir@/man4/cmake_faq.md \
+    @abs_top_srcdir@/docs/groups.dox \
+    @abs_top_srcdir@/docs/mainpage.dox \
+    @abs_top_srcdir@/docs/install.md \
+    @abs_top_srcdir@/docs/install-fortran.md \
+    @abs_top_srcdir@/docs/dispatch.dox \
+    @abs_top_srcdir@/docs/types.dox \
+    @abs_top_srcdir@/docs/notes.dox \
+    @abs_top_srcdir@/docs/cdl.dox \
+    @abs_top_srcdir@/docs/architecture.dox \
+    @abs_top_srcdir@/docs/internal.dox \
+    @abs_top_srcdir@/docs/windows-binaries.md \
+    @abs_top_srcdir@/docs/all-error-codes.md \
+    @abs_top_srcdir@/docs/cmake_faq.md \
     @abs_top_srcdir@/include/netcdf.h \
     @abs_top_srcdir@/libdispatch/dfile.c \
     @abs_top_srcdir@/libdispatch/ddim.c \
@@ -869,19 +869,19 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH = @abs_top_srcdir@/man4/images/chunking2.png \
-    @abs_top_srcdir@/man4/images/compatibility3.png \
-    @abs_top_srcdir@/man4/images/compression.png \
-    @abs_top_srcdir@/man4/images/groups.png \
-    @abs_top_srcdir@/man4/images/nc4-model.png \
-    @abs_top_srcdir@/man4/images/ncatts.png \
-    @abs_top_srcdir@/man4/images/nc-classic-uml.png \
-    @abs_top_srcdir@/man4/images/nccoords.png \
-    @abs_top_srcdir@/man4/images/ncfile.png \
-    @abs_top_srcdir@/man4/images/netcdf_architecture.png \
-    @abs_top_srcdir@/man4/images/pnetcdf.png \
-    @abs_top_srcdir@/man4/images/deptree.jpg \
-    @abs_top_srcdir@/man4/images/InstallTreeWindows.jpg
+IMAGE_PATH = @abs_top_srcdir@/docs/images/chunking2.png \
+    @abs_top_srcdir@/docs/images/compatibility3.png \
+    @abs_top_srcdir@/docs/images/compression.png \
+    @abs_top_srcdir@/docs/images/groups.png \
+    @abs_top_srcdir@/docs/images/nc4-model.png \
+    @abs_top_srcdir@/docs/images/ncatts.png \
+    @abs_top_srcdir@/docs/images/nc-classic-uml.png \
+    @abs_top_srcdir@/docs/images/nccoords.png \
+    @abs_top_srcdir@/docs/images/ncfile.png \
+    @abs_top_srcdir@/docs/images/netcdf_architecture.png \
+    @abs_top_srcdir@/docs/images/pnetcdf.png \
+    @abs_top_srcdir@/docs/images/deptree.jpg \
+    @abs_top_srcdir@/docs/images/InstallTreeWindows.jpg
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
@@ -1114,7 +1114,7 @@ HTML_HEADER            =
 # that doxygen normally uses.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_FOOTER            = @abs_top_srcdir@/man4/footer.html
+HTML_FOOTER            = @abs_top_srcdir@/docs/footer.html
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
 # sheet that is used by each HTML page. It can be used to fine-tune the look of

man4/Doxyfile.tutorial.in → docs/Doxyfile.tutorial.in

@@ -51,7 +51,7 @@ PROJECT_BRIEF          =
 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
 # to the output directory.
 
-PROJECT_LOGO           = ../../man4/netcdf-50x50.png
+PROJECT_LOGO           = ../../docs/netcdf-50x50.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -661,7 +661,7 @@ FILE_VERSION_FILTER    =
 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
 # tag is left empty.
 
-LAYOUT_FILE            = @abs_top_srcdir@/man4/DoxygenLayout.xml
+LAYOUT_FILE            = @abs_top_srcdir@/docs/DoxygenLayout.xml
 
 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
 # the reference definitions. This must be a list of .bib files. The .bib
@@ -743,7 +743,7 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT = @abs_top_srcdir@/man4/tutorial.dox \
+INPUT = @abs_top_srcdir@/docs/tutorial.dox \
     @abs_top_srcdir@/examples/C/simple_xy_wr.c \
     @abs_top_srcdir@/examples/C/simple_xy_rd.c \
     @abs_top_srcdir@/examples/C/sfc_pres_temp_wr.c \
@@ -842,19 +842,19 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH = @abs_top_srcdir@/man4/images/chunking2.png \
-    @abs_top_srcdir@/man4/images/compatibility3.png \
-    @abs_top_srcdir@/man4/images/compression.png \
-    @abs_top_srcdir@/man4/images/groups.png \
-    @abs_top_srcdir@/man4/images/nc4-model.png \
-    @abs_top_srcdir@/man4/images/ncatts.png \
-    @abs_top_srcdir@/man4/images/nc-classic-uml.png \
-    @abs_top_srcdir@/man4/images/nccoords.png \
-    @abs_top_srcdir@/man4/images/ncfile.png \
-    @abs_top_srcdir@/man4/images/netcdf_architecture.png \
-    @abs_top_srcdir@/man4/images/pnetcdf.png \
-    @abs_top_srcdir@/man4/images/deptree.jpg \
-    @abs_top_srcdir@/man4/images/InstallTreeWindows.jpg
+IMAGE_PATH = @abs_top_srcdir@/docs/images/chunking2.png \
+    @abs_top_srcdir@/docs/images/compatibility3.png \
+    @abs_top_srcdir@/docs/images/compression.png \
+    @abs_top_srcdir@/docs/images/groups.png \
+    @abs_top_srcdir@/docs/images/nc4-model.png \
+    @abs_top_srcdir@/docs/images/ncatts.png \
+    @abs_top_srcdir@/docs/images/nc-classic-uml.png \
+    @abs_top_srcdir@/docs/images/nccoords.png \
+    @abs_top_srcdir@/docs/images/ncfile.png \
+    @abs_top_srcdir@/docs/images/netcdf_architecture.png \
+    @abs_top_srcdir@/docs/images/pnetcdf.png \
+    @abs_top_srcdir@/docs/images/deptree.jpg \
+    @abs_top_srcdir@/docs/images/InstallTreeWindows.jpg
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
@@ -1087,7 +1087,7 @@ HTML_HEADER            =
 # that doxygen normally uses.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_FOOTER            = @abs_top_srcdir@/man4/footer.html
+HTML_FOOTER            = @abs_top_srcdir@/docs/footer.html
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
 # sheet that is used by each HTML page. It can be used to fine-tune the look of

man4/Makefile.am → docs/Makefile.am

@@ -25,7 +25,7 @@ if BUILD_DOCS
 
 # Copy man pages.
 #directory = $(top_srcdir)/docs/man/man3/
-#dist_man_MANS = $(man4directory)/man_page_1.3 $(directory)/man_page_2.3
+#dist_man_MANS = $(docsdirectory)/man_page_1.3 $(directory)/man_page_2.3
 # $(directory)/man_page_1.3: doxyfile.stamp
 # $(directory)/man_page_2.3: doxyfile.stamp
 
@@ -39,9 +39,9 @@ if BUILD_DOCS
 
 all-local: doxyfile.stamp
 clean-local:
-	rm -rf $(top_builddir)/man4/man
-	rm -rf $(top_builddir)/man4/html
-	rm -rf $(top_builddir)/man4/latex
+	rm -rf $(top_builddir)/docs/man
+	rm -rf $(top_builddir)/docs/html
+	rm -rf $(top_builddir)/docs/latex
 endif 
 
 # Timestamp to prevent rebuilds.

man4/cdl.dox → docs/cdl.dox

@@ -268,4 +268,4 @@ acceptable double constants:
      1.d
 \endcode
 
-*/
+*/

man4/cmake_faq.md → docs/cmake_faq.md

@@ -69,4 +69,4 @@ Below are a list of commonly-asked questions regarding NetCDF and CMake.
             -DHDF5_INCLUDE_DIR=/usr/include/openmpi-x86_64 \
 		
 
-    You will, of course, need to use the location of the libraries specific to your development environment.
+    You will, of course, need to use the location of the libraries specific to your development environment.

man4/errors.dox.old → docs/errors.dox.old

@@ -48,4 +48,4 @@ if (nc_inq(ncid, &ndims, NULL, NULL, NULL))
    return SOME_ERROR;
 \endcode
 
-*/
+*/

man4/esg.html → docs/esg.html

@@ -1,5 +1,5 @@
 <html><!-- InstanceBegin template="/Templates/MyUnidata.dwt" codeOutsideHTMLIsLocked="true" -->
-<!-- This document is kept in netcdf-c/man4;
+<!-- This document is kept in netcdf-c/docs;
      it is not normally included in the distribution.
 -->
 <head>

libsrc/CMakeLists.txt

@@ -52,7 +52,7 @@ ENDIF(BUILD_PARALLEL)
 # Generate the man page.
 IF(NOT MSVC)
 
-  FILE(GLOB libsrc_MANPAGE ${CMAKE_SOURCE_DIR}/man4/netcdf.m4)
+  FILE(GLOB libsrc_MANPAGE ${CMAKE_SOURCE_DIR}/docs/netcdf.m4)
   FILE(COPY ${libsrc_MANPAGE} DESTINATION ${CMAKE_CURRENT_BINARY_DIR})
 
   ADD_CUSTOM_TARGET(manpage ALL

libsrc/Makefile.am

@@ -61,7 +61,7 @@ ARGS_MANPAGE += -DPARALLEL_IO=TRUE
 endif
 
 # This rule generates the C manpage.
-netcdf.3: $(top_srcdir)/man4/netcdf.m4 
+netcdf.3: $(top_srcdir)/docs/netcdf.m4 
 	m4 $(M4FLAGS) $(ARGS_MANPAGE) $? >$@  || rm $@