Add a remark in CAInfo doc comment mentioning it is Linux only. (#5248)

Azure · Jan 11, 2024 · dece333 · dece333
1 parent e69559f
commit dece333
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/sdk/core/azure-core/inc/azure/core/http/curl_transport.hpp b/sdk/core/azure-core/inc/azure/core/http/curl_transport.hpp
@@ -120,6 +120,8 @@ namespace Azure { namespace Core { namespace Http {
      * @remark The default is the built-in system specific path. More about this option:
      * https://curl.se/libcurl/c/CURLOPT_CAINFO.html
      *
+     * @remark This option is known to only work on Linux and might throw if set on other platforms.
+     *
      */
     std::string CAInfo;