mirror of
https://github.com/Unidata/netcdf-c.git
synced 2025-04-24 18:30:51 +08:00
Doxygen is apparently buggy when trying to combine a markdown
file with @internal. The equivalent can be faked using the Doxygen ENABLED_SECTIONS mechanism. See docs/testserver.dox to see how this is done. So I make --enable-internal-docs also set ENABLED_SECTIONS = INTERNAL and then used it in docs/testserver.dox to decide if it needs to be included.
This commit is contained in:
Dennis Heimbigner
parent
c304b2075b
commit
bd96509735
10
configure.ac
10
configure.ac
@ -149,6 +149,16 @@ AC_ARG_ENABLE([internal-docs],
|
||||
test "x$enable_internal_docs" = xyes || enable_internal_docs=no
|
||||
AC_SUBST([BUILD_INTERNAL_DOCS], [$enable_internal_docs])
|
||||
|
||||
# Doxygen is apparently buggy when trying to combine a markdown
|
||||
# file with @internal. The equivalent can be faked using
|
||||
# the Doxygen ENABLED_SECTIONS mechanism. See docs/testserver.dox
|
||||
# to see how this is done.
|
||||
sections=
|
||||
if test "x$enable_internal_docs" = xyes ; then
|
||||
sections="$sections INTERNAL"
|
||||
fi
|
||||
AC_SUBST([ENABLED_DOC_SECTIONS], [$sections])
|
||||
|
||||
AC_MSG_CHECKING([if fsync support is enabled])
|
||||
AC_ARG_ENABLE([fsync],
|
||||
[AS_HELP_STRING([--enable-fsync],
|
||||
|
||||
@ -606,7 +606,7 @@ GENERATE_DEPRECATEDLIST= YES
|
||||
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
|
||||
# ... \endcond blocks.
|
||||
|
||||
ENABLED_SECTIONS =
|
||||
ENABLED_SECTIONS = @ENABLED_DOC_SECTIONS@
|
||||
|
||||
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
|
||||
# initial value of a variable or macro / define can have for it to appear in the
|
||||
|
||||
@ -1,12 +1,14 @@
|
||||
/** \file
|
||||
/**
|
||||
@if INTERNAL
|
||||
|
||||
\internal
|
||||
|
||||
\page remotesvc Remote Test Server Setup
|
||||
@page remotesvc Remote Test Server Setup
|
||||
|
||||
\tableofcontents
|
||||
|
||||
\section remotesvc_intro Introduction
|
||||
<!-- Note that this file has the .dox extension, but is mostly markdown -->
|
||||
<!-- Begin MarkDown -->
|
||||
|
||||
# Introduction {#remotesvc_intro}
|
||||
|
||||
The test suite for the DAP2 and DAP4 (aka DAP) protocols optionally
|
||||
uses a continuously running test server to verify that the
|
||||
@ -33,7 +35,7 @@ http://149.165.169.123:8080/d4ts/
|
||||
Setting up and Maintaining the test server involves a somewhat complex
|
||||
set of tasks. This document shows how to do those tasks.
|
||||
|
||||
\section remotesvc_tomcat Tomcat Setup
|
||||
# Tomcat Setup {#remotesvc_tomcat}
|
||||
|
||||
The initial task is to setup a Tomcat server on some machine.
|
||||
Currently the remote server is operating on Jetstream on an Ubuntu Linux
|
||||
@ -78,13 +80,13 @@ cd /usr/share/tomcat7/bin
|
||||
````
|
||||
to stop the Tomcat server.
|
||||
|
||||
\section remotesvc_cfg Configuring Tomcat
|
||||
# Configuring Tomcat {#remotesvc_cfg}
|
||||
|
||||
In the primary Tomcat directory -- probably /usr/share/tomcat7 --
|
||||
there should be a ''conf'' directory, and in that directory,
|
||||
you will need to edit the file ''tomcat-users.xml''.
|
||||
|
||||
\subsection remotesvc_tomcat_users Configuring tomcat-users.xml
|
||||
## Configuring tomcat-users.xml {#remotesvc_tomcat_users}
|
||||
|
||||
The goal here is primarily to setup a user that can login to the
|
||||
Tomcat admin page to upload the dts and d4ts servlets.
|
||||
@ -99,7 +101,7 @@ Insert the following near the end of the file.
|
||||
<user username="dapadmin" password="dap" roles="admin,manager-gui"/>
|
||||
````
|
||||
|
||||
\subsection remotesvc_config_server_xml Configuring server.xml
|
||||
## Configuring server.xml {#remotesvc_config_server_xml}
|
||||
|
||||
As a rule, the default settings in ''server.xml'' will work
|
||||
and provide insecure access to the Tomcat server via port 8080.
|
||||
@ -107,7 +109,7 @@ This is ok if the test server is running nothing but the d4ts and dts
|
||||
test servlets. Otherwise, you should investigate how to
|
||||
get the Tomcat server to use <em>https:</em>
|
||||
|
||||
\section remotesvc_load_war Loading dts.war and d4ts.war
|
||||
# Loading dts.war and d4ts.war {#remotesvc_load_war}
|
||||
|
||||
The next step is to actually upload the servlet files for the DAP
|
||||
test servlets. We assume that you have on your local disk two files:
|
||||
@ -131,7 +133,7 @@ That entry should be named ''/dts''.
|
||||
to the DAP2 test server main page.
|
||||
5. Repeat to load ''d4ts.war'' as ''/d4ts''.
|
||||
|
||||
\section remotesvc_testing Testing the Test Server
|
||||
# Testing the Test Server {#remotesvc_testing}
|
||||
|
||||
You can now test the test server by configuring and building
|
||||
the netcdf-c library. In order to force the use
|
||||
@ -151,7 +153,7 @@ and do a ''make check'' command. This should succeed.
|
||||
Similarly enter the directory ''dap4_test'' and do a make check
|
||||
to verify that the d4ts test server is working.
|
||||
|
||||
\section remotesvc_buildservlets Building d4ts.war and dts.war
|
||||
# Building d4ts.war and dts.war {#remotesvc_buildservlets}
|
||||
|
||||
In order to build the servlet (.war) files, you will need to
|
||||
clone the Thredds directory on github: https://github.com/Unidata/thredds.
|
||||
@ -173,11 +175,15 @@ to ''d4ts.war'' and ''dts.war'' respectively.
|
||||
Use those files to upload the servlets to your Tomcat server
|
||||
as described above.
|
||||
|
||||
\section remotesvc_poc Point of Contact
|
||||
# Point of Contact {#remotesvc_poc}
|
||||
|
||||
__Author__: Dennis Heimbigner<br>
|
||||
__Email__: dmh at ucar dot edu
|
||||
__Email__: dmh at ucar dot edu<br>
|
||||
__Initial Version__: 6/26/2018<br>
|
||||
__Last Revised__: 6/28/2018
|
||||
|
||||
<!-- End MarkDown -->
|
||||
|
||||
@endif
|
||||
|
||||
*/
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user