Browse Source

ExternalProject: Restore documentation indentation level

This module parses its own documentation to extract supported options.
Fix the indentation level to match that expected by the parser.
Brad King 12 years ago
parent
commit
c717e2aa8b
1 changed files with 70 additions and 70 deletions
  1. 70 70
      Modules/ExternalProject.cmake

+ 70 - 70
Modules/ExternalProject.cmake

@@ -10,66 +10,66 @@
 #
 # ::
 #
-#   ExternalProject_Add(<name>    # Name for custom target
-#     [DEPENDS projects...]       # Targets on which the project depends
-#     [PREFIX dir]                # Root dir for entire project
-#     [LIST_SEPARATOR sep]        # Sep to be replaced by ; in cmd lines
-#     [TMP_DIR dir]               # Directory to store temporary files
-#     [STAMP_DIR dir]             # Directory to store step timestamps
-#    #--Download step--------------
-#     [DOWNLOAD_NAME fname]       # File name to store (if not end of URL)
-#     [DOWNLOAD_DIR dir]          # Directory to store downloaded files
-#     [DOWNLOAD_COMMAND cmd...]   # Command to download source tree
-#     [CVS_REPOSITORY cvsroot]    # CVSROOT of CVS repository
-#     [CVS_MODULE mod]            # Module to checkout from CVS repo
-#     [CVS_TAG tag]               # Tag to checkout from CVS repo
-#     [SVN_REPOSITORY url]        # URL of Subversion repo
-#     [SVN_REVISION rev]          # Revision to checkout from Subversion repo
-#     [SVN_USERNAME john ]        # Username for Subversion checkout and update
-#     [SVN_PASSWORD doe ]         # Password for Subversion checkout and update
-#     [SVN_TRUST_CERT 1 ]         # Trust the Subversion server site certificate
-#     [GIT_REPOSITORY url]        # URL of git repo
-#     [GIT_TAG tag]               # Git branch name, commit id or tag
-#     [HG_REPOSITORY url]         # URL of mercurial repo
-#     [HG_TAG tag]                # Mercurial branch name, commit id or tag
-#     [URL /.../src.tgz]          # Full path or URL of source
-#     [URL_HASH ALGO=value]       # Hash of file at URL
-#     [URL_MD5 md5]               # Equivalent to URL_HASH MD5=md5
-#     [TLS_VERIFY bool]           # Should certificate for https be checked
-#     [TLS_CAINFO file]           # Path to a certificate authority file
-#     [TIMEOUT seconds]           # Time allowed for file download operations
-#    #--Update/Patch step----------
-#     [UPDATE_COMMAND cmd...]     # Source work-tree update command
-#     [PATCH_COMMAND cmd...]      # Command to patch downloaded source
-#    #--Configure step-------------
-#     [SOURCE_DIR dir]            # Source dir to be used for build
-#     [CONFIGURE_COMMAND cmd...]  # Build tree configuration command
-#     [CMAKE_COMMAND /.../cmake]  # Specify alternative cmake executable
-#     [CMAKE_GENERATOR gen]       # Specify generator for native build
-#     [CMAKE_GENERATOR_TOOLSET t] # Generator-specific toolset name
-#     [CMAKE_ARGS args...]        # Arguments to CMake command line
-#     [CMAKE_CACHE_ARGS args...]  # Initial cache arguments, of the form -Dvar:string=on
-#    #--Build step-----------------
-#     [BINARY_DIR dir]            # Specify build dir location
-#     [BUILD_COMMAND cmd...]      # Command to drive the native build
-#     [BUILD_IN_SOURCE 1]         # Use source dir for build dir
-#    #--Install step---------------
-#     [INSTALL_DIR dir]           # Installation prefix
-#     [INSTALL_COMMAND cmd...]    # Command to drive install after build
-#    #--Test step------------------
-#     [TEST_BEFORE_INSTALL 1]     # Add test step executed before install step
-#     [TEST_AFTER_INSTALL 1]      # Add test step executed after install step
-#     [TEST_COMMAND cmd...]       # Command to drive test
-#    #--Output logging-------------
-#     [LOG_DOWNLOAD 1]            # Wrap download in script to log output
-#     [LOG_UPDATE 1]              # Wrap update in script to log output
-#     [LOG_CONFIGURE 1]           # Wrap configure in script to log output
-#     [LOG_BUILD 1]               # Wrap build in script to log output
-#     [LOG_TEST 1]                # Wrap test in script to log output
-#     [LOG_INSTALL 1]             # Wrap install in script to log output
-#    #--Custom targets-------------
-#     [STEP_TARGETS st1 st2 ...]  # Generate custom targets for these steps
-#     )
+#  ExternalProject_Add(<name>    # Name for custom target
+#    [DEPENDS projects...]       # Targets on which the project depends
+#    [PREFIX dir]                # Root dir for entire project
+#    [LIST_SEPARATOR sep]        # Sep to be replaced by ; in cmd lines
+#    [TMP_DIR dir]               # Directory to store temporary files
+#    [STAMP_DIR dir]             # Directory to store step timestamps
+#   #--Download step--------------
+#    [DOWNLOAD_NAME fname]       # File name to store (if not end of URL)
+#    [DOWNLOAD_DIR dir]          # Directory to store downloaded files
+#    [DOWNLOAD_COMMAND cmd...]   # Command to download source tree
+#    [CVS_REPOSITORY cvsroot]    # CVSROOT of CVS repository
+#    [CVS_MODULE mod]            # Module to checkout from CVS repo
+#    [CVS_TAG tag]               # Tag to checkout from CVS repo
+#    [SVN_REPOSITORY url]        # URL of Subversion repo
+#    [SVN_REVISION rev]          # Revision to checkout from Subversion repo
+#    [SVN_USERNAME john ]        # Username for Subversion checkout and update
+#    [SVN_PASSWORD doe ]         # Password for Subversion checkout and update
+#    [SVN_TRUST_CERT 1 ]         # Trust the Subversion server site certificate
+#    [GIT_REPOSITORY url]        # URL of git repo
+#    [GIT_TAG tag]               # Git branch name, commit id or tag
+#    [HG_REPOSITORY url]         # URL of mercurial repo
+#    [HG_TAG tag]                # Mercurial branch name, commit id or tag
+#    [URL /.../src.tgz]          # Full path or URL of source
+#    [URL_HASH ALGO=value]       # Hash of file at URL
+#    [URL_MD5 md5]               # Equivalent to URL_HASH MD5=md5
+#    [TLS_VERIFY bool]           # Should certificate for https be checked
+#    [TLS_CAINFO file]           # Path to a certificate authority file
+#    [TIMEOUT seconds]           # Time allowed for file download operations
+#   #--Update/Patch step----------
+#    [UPDATE_COMMAND cmd...]     # Source work-tree update command
+#    [PATCH_COMMAND cmd...]      # Command to patch downloaded source
+#   #--Configure step-------------
+#    [SOURCE_DIR dir]            # Source dir to be used for build
+#    [CONFIGURE_COMMAND cmd...]  # Build tree configuration command
+#    [CMAKE_COMMAND /.../cmake]  # Specify alternative cmake executable
+#    [CMAKE_GENERATOR gen]       # Specify generator for native build
+#    [CMAKE_GENERATOR_TOOLSET t] # Generator-specific toolset name
+#    [CMAKE_ARGS args...]        # Arguments to CMake command line
+#    [CMAKE_CACHE_ARGS args...]  # Initial cache arguments, of the form -Dvar:string=on
+#   #--Build step-----------------
+#    [BINARY_DIR dir]            # Specify build dir location
+#    [BUILD_COMMAND cmd...]      # Command to drive the native build
+#    [BUILD_IN_SOURCE 1]         # Use source dir for build dir
+#   #--Install step---------------
+#    [INSTALL_DIR dir]           # Installation prefix
+#    [INSTALL_COMMAND cmd...]    # Command to drive install after build
+#   #--Test step------------------
+#    [TEST_BEFORE_INSTALL 1]     # Add test step executed before install step
+#    [TEST_AFTER_INSTALL 1]      # Add test step executed after install step
+#    [TEST_COMMAND cmd...]       # Command to drive test
+#   #--Output logging-------------
+#    [LOG_DOWNLOAD 1]            # Wrap download in script to log output
+#    [LOG_UPDATE 1]              # Wrap update in script to log output
+#    [LOG_CONFIGURE 1]           # Wrap configure in script to log output
+#    [LOG_BUILD 1]               # Wrap build in script to log output
+#    [LOG_TEST 1]                # Wrap test in script to log output
+#    [LOG_INSTALL 1]             # Wrap install in script to log output
+#   #--Custom targets-------------
+#    [STEP_TARGETS st1 st2 ...]  # Generate custom targets for these steps
+#    )
 #
 # The *_DIR options specify directories for the project, with default
 # directories computed as follows.  If the PREFIX option is given to
@@ -113,16 +113,16 @@
 #
 # ::
 #
-#   ExternalProject_Add_Step(<name> <step> # Names of project and custom step
-#     [COMMAND cmd...]        # Command line invoked by this step
-#     [COMMENT "text..."]     # Text printed when step executes
-#     [DEPENDEES steps...]    # Steps on which this step depends
-#     [DEPENDERS steps...]    # Steps that depend on this step
-#     [DEPENDS files...]      # Files on which this step depends
-#     [ALWAYS 1]              # No stamp file, step always runs
-#     [WORKING_DIRECTORY dir] # Working directory for command
-#     [LOG 1]                 # Wrap step in script to log output
-#     )
+#  ExternalProject_Add_Step(<name> <step> # Names of project and custom step
+#    [COMMAND cmd...]        # Command line invoked by this step
+#    [COMMENT "text..."]     # Text printed when step executes
+#    [DEPENDEES steps...]    # Steps on which this step depends
+#    [DEPENDERS steps...]    # Steps that depend on this step
+#    [DEPENDS files...]      # Files on which this step depends
+#    [ALWAYS 1]              # No stamp file, step always runs
+#    [WORKING_DIRECTORY dir] # Working directory for command
+#    [LOG 1]                 # Wrap step in script to log output
+#    )
 #
 # The command line, comment, and working directory of every standard and
 # custom step is processed to replace tokens <SOURCE_DIR>, <BINARY_DIR>,