Skip to content

Commit

Permalink
change NB_SUPPRESS_WARNINGS documentation as suggested
Browse files Browse the repository at this point in the history
  • Loading branch information
mijoku committed Jan 27, 2025
1 parent d4e462b commit a1e65d2
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/api_cmake.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,12 @@ The high-level interface consists of just one CMake command:
as a shared library for use in projects that consist of multiple
extensions.
* - ``NB_SUPPRESS_WARNINGS``
- Mark nanobind's include directories as system includes, suppressing
warnings generated from nanobind's and Python's header files.
- Mark the include directories of nanobind and Python as
[SYSTEM](https://cmake.org/cmake/help/latest/command/include_directories.html)
include directories, which suppresses any potential warning messages
originating there. This is mainly of relevance if your project artificially
raises the warning level via flags like `-pedantic`, ``-Wcast-qual``,
``-Wsign-conversion``.
* - ``PROTECT_STACK``
- Don't remove stack smashing-related protections.
* - ``LTO``
Expand Down

0 comments on commit a1e65d2

Please sign in to comment.