Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TRIVIAL] Lower the message level for missing optional doc components #4180

Closed
wants to merge 1 commit into from

Conversation

ximinez
Copy link
Collaborator

@ximinez ximinez commented May 25, 2022

High Level Overview of Change

If certain doc-related components are not available at build time, cmake will output warnings, which are noisy and annoying and completely unnecessary if one doesn't intend to build docs. I've observed this mostly on Windows where the components are less likely to already be available by default. This change lowers the message from a WARNING to a NOTICE, which is much less disruptive, but still informative.

Type of Change

  • [ X] Documentation Updates

Before / After

Before

[...]
1> [CMake] -- Pausing to download NuDB...
1> [CMake] -- Could NOT find Protobuf (missing: Protobuf_LIBRARIES Protobuf_INCLUDE_DIR) (Required is at least version "3.8")
1> [CMake] -- using local protobuf build.
1> [CMake] -- Couldn't find protobuf_protoc_lib
1> [CMake] CMake Warning at Builds/CMake/RippledDocs.cmake:34 (message):
1> [CMake]   could not find plantuml.jar
1> [CMake] Call Stack (most recent call first):
1> [CMake]   Builds/CMake/RippledDocs.cmake:40 (verbose_find_path)
1> [CMake]   CMakeLists.txt:77 (include)
1> [CMake] 
1> [CMake] 
1> [CMake] CMake Warning at Builds/CMake/RippledDocs.cmake:34 (message):
1> [CMake]   could not find dot
1> [CMake] Call Stack (most recent call first):
1> [CMake]   Builds/CMake/RippledDocs.cmake:41 (verbose_find_path)
1> [CMake]   CMakeLists.txt:77 (include)
1> [CMake] 
1> [CMake] 
1> [CMake] -- Configuring done
[...]

After

[...]
1> [CMake] -- Pausing to download NuDB...
1> [CMake] -- Could NOT find Protobuf (missing: Protobuf_LIBRARIES Protobuf_INCLUDE_DIR) (Required is at least version "3.8")
1> [CMake] -- using local protobuf build.
1> [CMake] -- Couldn't find protobuf_protoc_lib
1> [CMake] could not find plantuml.jar
1> [CMake] could not find dot
1> [CMake] -- Configuring done
[...]

@ximinez ximinez added Build System Dependencies Issues associated with 3rd party dependencies (RocksDB, SQLite, etc) labels May 25, 2022
@ximinez ximinez requested a review from greg7mdp May 25, 2022 23:10
Copy link
Contributor

@greg7mdp greg7mdp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much nicer output, thanks Ed, lgtm!

@greg7mdp
Copy link
Contributor

Unfortunately my review does not seem to count!

@ximinez ximinez added the Passed Passed code review & PR owner thinks it's ready to merge. Perf sign-off may still be required. label May 26, 2022
@nbougalis nbougalis mentioned this pull request Jul 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Build System Dependencies Issues associated with 3rd party dependencies (RocksDB, SQLite, etc) Passed Passed code review & PR owner thinks it's ready to merge. Perf sign-off may still be required.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants