Browse Source

cmake: Improve '-E' help message formatting

Bartosz Kosiorek 10 years ago
parent
commit
0be5020bf8

+ 2 - 2
Help/manual/cmake.1.rst

@@ -193,10 +193,10 @@ Available commands are:
 ``make_directory <dir>``
 ``make_directory <dir>``
   Create a directory.
   Create a directory.
 
 
-``md5sum [<file>...]``
+``md5sum <file>...``
   Compute md5sum of files.
   Compute md5sum of files.
 
 
-``remove [-f] [<file>...]``
+``remove [-f] <file>...``
   Remove the file(s), use ``-f`` to force it.
   Remove the file(s), use ``-f`` to force it.
 
 
 ``remove_directory <dir>``
 ``remove_directory <dir>``

+ 6 - 6
Source/cmcmd.cxx

@@ -52,7 +52,7 @@ void CMakeCommandUsage(const char* program)
   // If you add new commands, change here,
   // If you add new commands, change here,
   // and in cmakemain.cxx in the options table
   // and in cmakemain.cxx in the options table
   errorStream
   errorStream
-    << "Usage: " << program << " -E [command] [arguments ...]\n"
+    << "Usage: " << program << " -E <command> [arguments...]\n"
     << "Available commands: \n"
     << "Available commands: \n"
     << "  chdir dir cmd [args]...   - run command in a given directory\n"
     << "  chdir dir cmd [args]...   - run command in a given directory\n"
     << "  compare_files file1 file2 - check if file1 is same as file2\n"
     << "  compare_files file1 file2 - check if file1 is same as file2\n"
@@ -62,15 +62,15 @@ void CMakeCommandUsage(const char* program)
        "content to directory 'destination'\n"
        "content to directory 'destination'\n"
     << "  copy_if_different in-file out-file  - copy file if input has "
     << "  copy_if_different in-file out-file  - copy file if input has "
        "changed\n"
        "changed\n"
-    << "  echo [string]...          - displays arguments as text\n"
-    << "  echo_append [string]...   - displays arguments as text but no new "
+    << "  echo [<string>...]        - displays arguments as text\n"
+    << "  echo_append [<string>...] - displays arguments as text but no new "
        "line\n"
        "line\n"
     << "  env [--unset=NAME]... [NAME=VALUE]... COMMAND [ARG]...\n"
     << "  env [--unset=NAME]... [NAME=VALUE]... COMMAND [ARG]...\n"
     << "                            - run command in a modified environment\n"
     << "                            - run command in a modified environment\n"
     << "  environment               - display the current environment\n"
     << "  environment               - display the current environment\n"
     << "  make_directory dir        - create a directory\n"
     << "  make_directory dir        - create a directory\n"
-    << "  md5sum file1 [...]        - compute md5sum of files\n"
-    << "  remove [-f] file1 file2 ... - remove the file(s), use -f to force "
+    << "  md5sum <file>...          - compute md5sum of files\n"
+    << "  remove [-f] <file>...     - remove the file(s), use -f to force "
        "it\n"
        "it\n"
     << "  remove_directory dir      - remove a directory and its contents\n"
     << "  remove_directory dir      - remove a directory and its contents\n"
     << "  rename oldname newname    - rename a file or directory "
     << "  rename oldname newname    - rename a file or directory "
@@ -78,7 +78,7 @@ void CMakeCommandUsage(const char* program)
     << "  tar [cxt][vf][zjJ] file.tar [file/dir1 file/dir2 ...]\n"
     << "  tar [cxt][vf][zjJ] file.tar [file/dir1 file/dir2 ...]\n"
     << "                            - create or extract a tar or zip archive\n"
     << "                            - create or extract a tar or zip archive\n"
     << "  sleep <number>...         - sleep for given number of seconds\n"
     << "  sleep <number>...         - sleep for given number of seconds\n"
-    << "  time command [args] ...   - run command and return elapsed time\n"
+    << "  time command [args...]    - run command and return elapsed time\n"
     << "  touch file                - touch a file.\n"
     << "  touch file                - touch a file.\n"
     << "  touch_nocreate file       - touch a file but do not create it.\n"
     << "  touch_nocreate file       - touch a file but do not create it.\n"
 #if defined(_WIN32) && !defined(__CYGWIN__)
 #if defined(_WIN32) && !defined(__CYGWIN__)

+ 1 - 1
Tests/RunCMake/CommandLine/E-no-arg-stderr.txt

@@ -1,3 +1,3 @@
 ^CMake Error: cmake version .*
 ^CMake Error: cmake version .*
-Usage: .* -E \[command\] \[arguments ...\]
+Usage: .* -E <command> \[arguments\.\.\.\]
 Available commands:
 Available commands:

+ 1 - 1
Tests/RunCMake/CommandLine/E_create_symlink-no-arg-stderr.txt

@@ -1,3 +1,3 @@
 ^CMake Error: cmake version .*
 ^CMake Error: cmake version .*
-Usage: .* -E \[command\] \[arguments ...\]
+Usage: .* -E <command> \[arguments\.\.\.\]
 Available commands:
 Available commands:

+ 1 - 1
Tests/RunCMake/CommandLine/E_rename-no-arg-stderr.txt

@@ -1,3 +1,3 @@
 ^CMake Error: cmake version .*
 ^CMake Error: cmake version .*
-Usage: .* -E \[command\] \[arguments ...\]
+Usage: .* -E <command> \[arguments\.\.\.\]
 Available commands:
 Available commands:

+ 1 - 1
Tests/RunCMake/CommandLine/E_touch_nocreate-no-arg-stderr.txt

@@ -1,3 +1,3 @@
 ^CMake Error: cmake version .*
 ^CMake Error: cmake version .*
-Usage: .* -E \[command\] \[arguments ...\]
+Usage: .* -E <command> \[arguments\.\.\.\]
 Available commands:
 Available commands: