Revert "Update to 7.40.1"
[platform/upstream/curl.git] / docs / INSTALL.cmake
index 1e5a0de..f5d32d8 100644 (file)
@@ -11,13 +11,32 @@ Building with CMake
    This document describes how to compile, build and install curl and libcurl
    from source code using the CMake build tool. To build with CMake, you will
    of course have to first install CMake.  The minimum required version of
-   CMake is specifed in the file CMakeLists.txt found in the top of the curl
+   CMake is specified in the file CMakeLists.txt found in the top of the curl
    source tree. Once the correct version of CMake is installed you can follow
    the instructions below for the platform you are building on.
 
    CMake builds can be configured either from the command line, or from one
    of CMake's GUI's.
 
+Current flaws in the curl CMake build
+=====================================
+
+   Missing features in the cmake build:
+
+   - Builds libcurl without large file support
+   - It doesn't build src/tool_hugehelp.c which creates the --manual output
+   - Can't select which SSL library to build with, only OpenSSL
+   - Doesn't build with SCP and SFTP support (libssh2)
+   - Doesn't allow different resolver backends (no c-ares build support)
+   - No RTMP support built
+   - Doesn't allow build curl and libcurl debug enabled
+   - Doesn't allow a custom CA bundle path
+   - Doesn't allow you to disable specific protocols from the build
+   - Doesn't properly enable IPv6 support by default
+   - Doesn't find or use krb4 or GSS
+   - Rebuilds test files too eagerly, but still can't run the tests
+
+
 Important notice
 ==================
    If you got your curl sources from a distribution tarball, make sure to
@@ -31,27 +50,33 @@ Important notice
 
 Command Line CMake
 ==================
-   A command line build of Curl is similar to the autotools build of Curl. It
+   A CMake build of curl is similar to the autotools build of curl. It
    consists of the following steps after you have unpacked the source.
-       # 1st create an out of source build tree parallel to the curl source
-       # tree and change into that directory
-       mkdir curl-build
-       cd curl-build
-       # now run CMake from the build tree, giving it the path to the top of
-       # the Curl source tree.  CMake will pick a compiler for you. If you
-       # want to specifiy the compile, you can set the CC environment
-       # variable prior to running CMake.
-       cmake ../curl
-       make
-       # currently make test is not implemented
-       #make test
-       # Install to default location:
-       make install
+
+    1. Create an out of source build tree parallel to the curl source
+       tree and change into that directory
+
+    $ mkdir curl-build
+    $ cd curl-build
+
+    2. Run CMake from the build tree, giving it the path to the top of
+       the curl source tree.  CMake will pick a compiler for you. If you
+       want to specify the compile, you can set the CC environment
+       variable prior to running CMake.
+
+    $ cmake ../curl
+    $ make
+
+    3. Install to default location:
+
+    $ make install
+
+    (The test suite does not work with the cmake build)
 
 ccmake
 =========
      CMake comes with a curses based interface called ccmake.  To run ccmake on
-     a curl use the instructions for the command line cmake, but substitue
+     a curl use the instructions for the command line cmake, but substitute
      ccmake ../curl for cmake ../curl.  This will bring up a curses interface
      with instructions on the bottom of the screen. You can press the "c" key
      to configure the project, and the "g" key to generate the project. After
@@ -65,7 +90,7 @@ cmake-gui
         the curl source tree.
         2. Fill in the "Where to build the binaries" combo box with the path
         to the directory for your build tree, ideally this should not be the
-        same as the source tree, but a parallel diretory called curl-build or
+        same as the source tree, but a parallel directory called curl-build or
         something similar.
         3. Once the source and binary directories are specified, press the
         "Configure" button.
@@ -73,5 +98,5 @@ cmake-gui
         5. At this point you can change any of the options presented in the
         GUI.  Once you have selected all the options you want, click the
         "Generate" button.
-        6. Run the native build tool that you used CMake to genratate.
+        6. Run the native build tool that you used CMake to generate.