Removing OUTPUT_CHAN_CONN option from documentation, making an easter…

[scrasmussen]

TYPE: text only

KEYWORDS: documentation, build options

SOURCE: Soren Rasmussen, NCAR

DESCRIPTION OF CHANGES: Removing OUTPUT_CHAN_CONN option from documentation, making an easter-egg since its use is very niche.

TESTS: Documentation builds

[rcabell]

The CMake configuration output still includes this sort of text:

=============================================================
-- Start of WRF-Hydro Env VARIABLES
WRF_HYDRO = 1
HYDRO_D = 0
WRF_HYDRO_RAPID = 0
SPATIAL_SOIL = 1
WRFIO_NCD_LARGE_FILE_SUPPORT = 1
NCEP_WCOSS = 0
NWM_META = 0
WRF_HYDRO_NUDGING = 1
OUTPUT_CHAN_CONN = 0
PRECIP_DOUBLE = 0
WRF_HYDRO_NUOPC = 0
=============================================================

We should probably remove OUTUPUT_CHAN_CONN here too, even if it's still processed internally.

[rcabell]

And if we're hiding things, might want to hide WRF_HYDRO_RAPID too, since this isn't tested (and likely may be broken)

[scrasmussen]

The CMake configuration output still includes this sort of text:

=============================================================
-- Start of WRF-Hydro Env VARIABLES
WRF_HYDRO = 1
HYDRO_D = 0
WRF_HYDRO_RAPID = 0
SPATIAL_SOIL = 1
WRFIO_NCD_LARGE_FILE_SUPPORT = 1
NCEP_WCOSS = 0
NWM_META = 0
WRF_HYDRO_NUDGING = 1
OUTPUT_CHAN_CONN = 0
PRECIP_DOUBLE = 0
WRF_HYDRO_NUOPC = 0
=============================================================

We should probably remove OUTUPUT_CHAN_CONN here too, even if it's still processed internally.

I see, I had misunderstood your recommendation in yesterday's meeting. It's fixed now, they only show up if they have been turned on, otherwise the option is not reported.

And if we're hiding things, might want to hide WRF_HYDRO_RAPID too, since this isn't tested (and likely may be broken)

Good idea, did this one too

[Copilot]

Pull Request Overview

This PR removes documentation for two niche build options (OUTPUT_CHAN_CONN and WRF_HYDRO_RAPID) while keeping their functionality intact as "easter eggs". The options remain available in the build system but are no longer publicly documented.

• Removed OUTPUT_CHAN_CONN and WRF_HYDRO_RAPID from user-facing documentation
• Modified debug message output in CMake to only display when these options are actively used
• Updated both the userguide and BUILD documentation files

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
docs/userguide/model-code-config.rest	Removed documentation entries for WRF_HYDRO_RAPID and OUTPUT_CHAN_CONN options
docs/BUILD.rst	Removed table entries documenting the OUTPUT_CHAN_CONN and WRF_HYDRO_RAPID CMake flags
CMakeLists.txt	Moved debug messages inside conditional blocks so they only appear when options are enabled

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.