Commit f686dbec authored by Ken Martin's avatar Ken Martin
Browse files

some white space fixes for the book

parent 5624be36
...@@ -375,8 +375,9 @@ ...@@ -375,8 +375,9 @@
# UPLOAD_DIRECTORY is the local directory where CPack will create the # UPLOAD_DIRECTORY is the local directory where CPack will create the
# various archives for each of the components. The contents of this # various archives for each of the components. The contents of this
# directory should be uploaded to a location accessible by the URL given # directory should be uploaded to a location accessible by the URL given
# in the site argument. If omitted, CPack will use the directory CPackUploads # in the site argument. If omitted, CPack will use the directory
# inside the CMake binary directory to store the generated archives. # CPackUploads inside the CMake binary directory to store the generated
# archives.
# #
# The ALL flag indicates that all components be downloaded. Otherwise, only # The ALL flag indicates that all components be downloaded. Otherwise, only
# those components explicitly marked as DOWNLOADED or that have a specified # those components explicitly marked as DOWNLOADED or that have a specified
......
...@@ -2,19 +2,21 @@ ...@@ -2,19 +2,21 @@
# #
# PRINT_ENABLED_FEATURES() # PRINT_ENABLED_FEATURES()
# Print a summary of all enabled features. By default all successfull # Print a summary of all enabled features. By default all successfull
# FIND_PACKAGE() calls will appear here, except the ones which used the QUIET keyword. # FIND_PACKAGE() calls will appear here, except the ones which used the
# Additional features can be added by appending an entry to the global ENABLED_FEATURES # QUIET keyword. Additional features can be added by appending an entry
# property. If SET_FEATURE_INFO() is used for that feature, the output will be much # to the global ENABLED_FEATURES property. If SET_FEATURE_INFO() is
# more informative. # used for that feature, the output will be much more informative.
# #
# PRINT_DISABLED_FEATURES() # PRINT_DISABLED_FEATURES()
# Same as PRINT_ENABLED_FEATURES(), but for disabled features. It can be extended # Same as PRINT_ENABLED_FEATURES(), but for disabled features. It can
# the same way by adding to the global property DISABLED_FEATURES. # be extended the same way by adding to the global property
# DISABLED_FEATURES.
# #
# SET_FEATURE_INFO(NAME DESCRIPTION [URL [COMMENT] ] ) # SET_FEATURE_INFO(NAME DESCRIPTION [URL [COMMENT] ] )
# Use this macro to set up information about the named feature, which will # Use this macro to set up information about the named feature, which will
# then be displayed by PRINT_ENABLED/DISABLED_FEATURES(). # then be displayed by PRINT_ENABLED/DISABLED_FEATURES().
# Example: SET_FEATURE_INFO(LibXml2 "XML processing library." "http://xmlsoft.org/") # Example: SET_FEATURE_INFO(LibXml2 "XML processing library."
# "http://xmlsoft.org/")
# #
......
...@@ -63,7 +63,8 @@ public: ...@@ -63,7 +63,8 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
" add_executable(<name> [WIN32] [MACOSX_BUNDLE] [EXCLUDE_FROM_ALL]\n" " add_executable(<name> [WIN32] [MACOSX_BUNDLE]\n"
" [EXCLUDE_FROM_ALL]\n"
" source1 source2 ... sourceN)\n" " source1 source2 ... sourceN)\n"
"Adds an executable target called <name> to be built from the " "Adds an executable target called <name> to be built from the "
"source files listed in the command invocation. " "source files listed in the command invocation. "
......
...@@ -62,7 +62,8 @@ public: ...@@ -62,7 +62,8 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
" add_library(<name> [STATIC | SHARED | MODULE] [EXCLUDE_FROM_ALL]\n" " add_library(<name> [STATIC | SHARED | MODULE]\n"
" [EXCLUDE_FROM_ALL]\n"
" source1 source2 ... sourceN)\n" " source1 source2 ... sourceN)\n"
"Adds a library target called <name> to be built from the " "Adds a library target called <name> to be built from the "
"source files listed in the command invocation. " "source files listed in the command invocation. "
......
...@@ -68,7 +68,7 @@ public: ...@@ -68,7 +68,7 @@ public:
" DIRECTORY = associated with one directory\n" " DIRECTORY = associated with one directory\n"
" TARGET = associated with one target\n" " TARGET = associated with one target\n"
" SOURCE = associated with one source file\n" " SOURCE = associated with one source file\n"
" TEST = associated with a test named with add_test command\n" " TEST = associated with a test named with add_test\n"
" VARIABLE = documents a CMake language variable\n" " VARIABLE = documents a CMake language variable\n"
" CACHED_VARIABLE = documents a CMake cache variable\n" " CACHED_VARIABLE = documents a CMake cache variable\n"
"Note that unlike set_property and get_property no actual scope " "Note that unlike set_property and get_property no actual scope "
......
...@@ -632,7 +632,7 @@ void cmDocumentVariables::DefineVariables(cmake* cm) ...@@ -632,7 +632,7 @@ void cmDocumentVariables::DefineVariables(cmake* cm)
"the shared MFC library. This is used in visual " "the shared MFC library. This is used in visual "
"studio 6 and 7 project files. The CMakeSetup " "studio 6 and 7 project files. The CMakeSetup "
"dialog uses MFC and the CMakeLists.txt looks like this:\n" "dialog uses MFC and the CMakeLists.txt looks like this:\n"
"ADD_DEFINITIONS(-D_AFXDLL)\n" "add_definitions(-D_AFXDLL)\n"
"set(CMAKE_MFC_FLAG 2)\n" "set(CMAKE_MFC_FLAG 2)\n"
"add_executable(CMakeSetup WIN32 ${SRCS})\n",false, "add_executable(CMakeSetup WIN32 ${SRCS})\n",false,
"Variables That Change Behavior"); "Variables That Change Behavior");
......
...@@ -68,7 +68,7 @@ public: ...@@ -68,7 +68,7 @@ public:
"This command enables support for the named language in CMake. " "This command enables support for the named language in CMake. "
"This is the same as the project command but does not create " "This is the same as the project command but does not create "
"any of the extra variables that are created by the project command. " "any of the extra variables that are created by the project command. "
"Example languages are CXX, C, Fortran.\n" "Example languages are CXX, C, Fortran. "
"If OPTIONAL is used, use the CMAKE_<languageName>_COMPILER_WORKS " "If OPTIONAL is used, use the CMAKE_<languageName>_COMPILER_WORKS "
"variable to check whether the language has been enabled successfully."; "variable to check whether the language has been enabled successfully.";
} }
......
...@@ -49,7 +49,7 @@ cmFindCommon::cmFindCommon() ...@@ -49,7 +49,7 @@ cmFindCommon::cmFindCommon()
" \"LAST\" - Try to find frameworks after standard\n" " \"LAST\" - Try to find frameworks after standard\n"
" libraries or headers.\n" " libraries or headers.\n"
" \"ONLY\" - Only try to find frameworks.\n" " \"ONLY\" - Only try to find frameworks.\n"
" \"NEVER\". - Never try to find frameworks.\n" " \"NEVER\" - Never try to find frameworks.\n"
"On Darwin or systems supporting OS X Application Bundles, the cmake " "On Darwin or systems supporting OS X Application Bundles, the cmake "
"variable CMAKE_FIND_APPBUNDLE can be set to empty or one of the " "variable CMAKE_FIND_APPBUNDLE can be set to empty or one of the "
"following:\n" "following:\n"
...@@ -58,7 +58,7 @@ cmFindCommon::cmFindCommon() ...@@ -58,7 +58,7 @@ cmFindCommon::cmFindCommon()
" \"LAST\" - Try to find application bundles after standard\n" " \"LAST\" - Try to find application bundles after standard\n"
" programs.\n" " programs.\n"
" \"ONLY\" - Only try to find application bundles.\n" " \"ONLY\" - Only try to find application bundles.\n"
" \"NEVER\". - Never try to find application bundles.\n"; " \"NEVER\" - Never try to find application bundles.\n";
this->GenericDocumentationRootPath = this->GenericDocumentationRootPath =
"The CMake variable CMAKE_FIND_ROOT_PATH specifies one or more " "The CMake variable CMAKE_FIND_ROOT_PATH specifies one or more "
"directories to be prepended to all other search directories. " "directories to be prepended to all other search directories. "
......
...@@ -66,8 +66,8 @@ public: ...@@ -66,8 +66,8 @@ public:
{ {
return return
" list(LENGTH <list> <output variable>)\n" " list(LENGTH <list> <output variable>)\n"
" list(GET <list> <element index> [<element index> ...] " " list(GET <list> <element index> [<element index> ...]\n"
"<output variable>)\n" " <output variable>)\n"
" list(APPEND <list> <element> [<element> ...])\n" " list(APPEND <list> <element> [<element> ...])\n"
" list(FIND <list> <value> <output variable>)\n" " list(FIND <list> <value> <output variable>)\n"
" list(INSERT <list> <element_index> <element> [<element> ...])\n" " list(INSERT <list> <element_index> <element> [<element> ...])\n"
......
...@@ -66,8 +66,8 @@ public: ...@@ -66,8 +66,8 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
" set(<variable> <value> [[CACHE <type> <docstring> [FORCE]] | " " set(<variable> <value>\n"
"PARENT_SCOPE])\n" " [[CACHE <type> <docstring> [FORCE]] | PARENT_SCOPE])\n"
"Within CMake sets <variable> to the value <value>. <value> is expanded" "Within CMake sets <variable> to the value <value>. <value> is expanded"
" before <variable> is set to it. If CACHE is present, then the " " before <variable> is set to it. If CACHE is present, then the "
"<variable> is put in the cache. <type> and <docstring> are then " "<variable> is put in the cache. <type> and <docstring> are then "
......
...@@ -70,7 +70,7 @@ public: ...@@ -70,7 +70,7 @@ public:
"Set a property for the current directory and subdirectories. If the " "Set a property for the current directory and subdirectories. If the "
"property is not found, CMake will report an error. The properties " "property is not found, CMake will report an error. The properties "
"include: INCLUDE_DIRECTORIES, LINK_DIRECTORIES, " "include: INCLUDE_DIRECTORIES, LINK_DIRECTORIES, "
"INCLUDE_REGULAR_EXPRESSION, and ADDITIONAL_MAKE_CLEAN_FILES.\n" "INCLUDE_REGULAR_EXPRESSION, and ADDITIONAL_MAKE_CLEAN_FILES. "
"ADDITIONAL_MAKE_CLEAN_FILES is a list of files that will be cleaned " "ADDITIONAL_MAKE_CLEAN_FILES is a list of files that will be cleaned "
"as a part of \"make clean\" stage."; "as a part of \"make clean\" stage.";
} }
......
...@@ -65,7 +65,8 @@ public: ...@@ -65,7 +65,8 @@ public:
return return
"Add a list of subdirectories to the build.\n" "Add a list of subdirectories to the build.\n"
" subdirs(dir1 dir2 ..." " subdirs(dir1 dir2 ..."
"[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...] [PREORDER] )\n" "[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...]\n
" [PREORDER] )\n"
"Add a list of subdirectories to the build. The add_subdirectory " "Add a list of subdirectories to the build. The add_subdirectory "
"command should be used instead of subdirs although subdirs will " "command should be used instead of subdirs although subdirs will "
"still work. " "still work. "
......
...@@ -77,7 +77,7 @@ public: ...@@ -77,7 +77,7 @@ public:
"the compile step goes. RUN_OUTPUT_VARIABLE specifies the variable " "the compile step goes. RUN_OUTPUT_VARIABLE specifies the variable "
"where the output from the running executable goes.\n" "where the output from the running executable goes.\n"
"For compatibility reasons OUTPUT_VARIABLE is still supported, which " "For compatibility reasons OUTPUT_VARIABLE is still supported, which "
"gives you the output from the compile and run step combined.\n\n" "gives you the output from the compile and run step combined.\n"
"Cross compiling issues\n" "Cross compiling issues\n"
"When cross compiling, the executable compiled in the first step " "When cross compiling, the executable compiled in the first step "
"usually cannot be run on the build host. try_run() checks the " "usually cannot be run on the build host. try_run() checks the "
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment