diff options
| author | Nikita Nemkin <nikita@nemkin.ru> | 2020-11-12 13:40:33 +0500 |
|---|---|---|
| committer | Nikita Nemkin <nikita@nemkin.ru> | 2020-12-02 21:00:30 +0500 |
| commit | 8fea95319bcaac741faf93bd66b3a1838b56a418 (patch) | |
| tree | 2bc107ce0cc4844e79f0baf93a394d93c27edaa8 /Modules/FindProtobuf.cmake | |
| parent | 8634561dcae9f5ff5128eaf7c83aa71170992ec2 (diff) | |
| download | cmake-8fea95319bcaac741faf93bd66b3a1838b56a418.tar.gz | |
Help: Add `.. versionadded` directives to module docs
Issue: #19715
Diffstat (limited to 'Modules/FindProtobuf.cmake')
| -rw-r--r-- | Modules/FindProtobuf.cmake | 24 |
1 files changed, 21 insertions, 3 deletions
diff --git a/Modules/FindProtobuf.cmake b/Modules/FindProtobuf.cmake index 0c9d695bd6..4b1e336893 100644 --- a/Modules/FindProtobuf.cmake +++ b/Modules/FindProtobuf.cmake @@ -7,6 +7,13 @@ FindProtobuf Locate and configure the Google Protocol Buffers library. +.. versionadded:: 3.6 + Support for :command:`find_package` version checks. + +.. versionchanged:: 3.6 + All input and output variables use the ``Protobuf_`` prefix. + Variables with ``PROTOBUF_`` prefix are still supported for compatibility. + The following variables can be set and are optional: ``Protobuf_SRC_ROOT_FOLDER`` @@ -19,8 +26,12 @@ The following variables can be set and are optional: List of additional directories to be searched for imported .proto files. ``Protobuf_DEBUG`` + .. versionadded:: 3.6 + Show debug messages. ``Protobuf_USE_STATIC_LIBS`` + .. versionadded:: 3.9 + Set to ON to force the use of the static libraries. Default is OFF. @@ -30,6 +41,8 @@ Defines the following variables: Found the Google Protocol Buffers library (libprotobuf & header files) ``Protobuf_VERSION`` + .. versionadded:: 3.6 + Version of package found. ``Protobuf_INCLUDE_DIRS`` Include directories for Google Protocol Buffers @@ -40,7 +53,8 @@ Defines the following variables: ``Protobuf_LITE_LIBRARIES`` The protobuf-lite libraries -The following :prop_tgt:`IMPORTED` targets are also defined: +.. versionadded:: 3.9 + The following :prop_tgt:`IMPORTED` targets are also defined: ``protobuf::libprotobuf`` The protobuf library. @@ -49,7 +63,8 @@ The following :prop_tgt:`IMPORTED` targets are also defined: ``protobuf::libprotoc`` The protoc library. ``protobuf::protoc`` - The protoc compiler. + .. versionadded:: 3.10 + The protoc compiler. The following cache variables are also available to set or use: @@ -101,7 +116,8 @@ Example: ``HDRS`` Variable to define with autogenerated header files ``DESCRIPTORS`` - Variable to define with autogenerated descriptor files, if requested. + .. versionadded:: 3.10 + Variable to define with autogenerated descriptor files, if requested. ``EXPORT_MACRO`` is a macro which should expand to ``__declspec(dllexport)`` or ``__declspec(dllimport)`` depending on what is being compiled. @@ -110,6 +126,8 @@ Example: .. command:: protobuf_generate_python + .. versionadded:: 3.4 + Add custom commands to process ``.proto`` files to Python:: protobuf_generate_python (<PY> [<ARGN>...]) |