From 393ea0073c8adb81f7132f5b2096efb3481eb5c1 2011-07-13 21:25:26 From: Brian E. Granger Date: 2011-07-13 21:25:26 Subject: [PATCH] Finishing up help string work. --- diff --git a/IPython/core/profileapp.py b/IPython/core/profileapp.py index 3efe80b..1c96629 100644 --- a/IPython/core/profileapp.py +++ b/IPython/core/profileapp.py @@ -77,8 +77,9 @@ where you can edit ipython_config.py to start configuring IPython. _list_examples = "ipython profile list # list all profiles" _create_examples = """ -ipython profile create foo # create profile foo -ipython profile create foo --init # create with default config files +ipython profile create foo # create profile foo w/ default config files +ipython profile create foo --reset # restage default config files over current +ipython profile create foo --parallel # also stage parallel config files """ _main_examples = """ diff --git a/IPython/frontend/terminal/ipapp.py b/IPython/frontend/terminal/ipapp.py index e9c7852..c4c7c48 100755 --- a/IPython/frontend/terminal/ipapp.py +++ b/IPython/frontend/terminal/ipapp.py @@ -63,9 +63,12 @@ ipython --pylab # start in pylab mode ipython --pylab=qt # start in pylab mode with the qt4 backend ipython --log_level=DEBUG # set logging to DEBUG ipython --profile=foo # start with profile foo + ipython qtconsole # start the qtconsole GUI application -ipython profile -h # show the help string for the profile subcmd ipython qtconsole -h # show the help string for the qtconsole subcmd + +ipython profile create foo # create profile foo w/ default config files +ipython profile -h # show the help string for the profile subcmd """ #----------------------------------------------------------------------------- diff --git a/IPython/parallel/apps/ipclusterapp.py b/IPython/parallel/apps/ipclusterapp.py index 0a9e7c9..28b9b44 100755 --- a/IPython/parallel/apps/ipclusterapp.py +++ b/IPython/parallel/apps/ipclusterapp.py @@ -67,7 +67,9 @@ configuration files, followed by 'ipcluster start --profile=mycluster --n=4'. """ _main_examples = """ +ipcluster start --n=4 # start a 4 node cluster on localhost ipcluster start -h # show the help string for the start subcmd + ipcluster stop -h # show the help string for the stop subcmd ipcluster engines -h # show the help string for the engines subcmd """ @@ -113,8 +115,8 @@ security related files and are named using the convention 'profile_' and should be creating using the 'start' subcommand of 'ipcluster'. If your cluster directory is in the cwd or the ipython directory, you can simply refer to it -using its profile name, 'ipcluster start n=4 profile=`, -otherwise use the 'profile_dir' option. +using its profile name, 'ipcluster start --n=4 --profile=`, +otherwise use the 'profile-dir' option. """ stop_help = """Stop a running IPython cluster @@ -122,8 +124,8 @@ Stop a running ipython cluster by its profile name or cluster directory. Cluster directories are named using the convention 'profile_'. If your cluster directory is in the cwd or the ipython directory, you can simply refer to it -using its profile name, 'ipcluster stop profile=`, otherwise -use the 'profile_dir' option. +using its profile name, 'ipcluster stop --profile=`, otherwise +use the '--profile-dir' option. """ engines_help = """Start engines connected to an existing IPython cluster @@ -134,8 +136,8 @@ security related files and are named using the convention 'profile_' and should be creating using the 'start' subcommand of 'ipcluster'. If your cluster directory is in the cwd or the ipython directory, you can simply refer to it -using its profile name, 'ipcluster engines n=4 profile=`, -otherwise use the 'profile_dir' option. +using its profile name, 'ipcluster engines --n=4 --profile=`, +otherwise use the 'profile-dir' option. """ stop_aliases = dict( signal='IPClusterStop.signal', diff --git a/IPython/parallel/apps/ipcontrollerapp.py b/IPython/parallel/apps/ipcontrollerapp.py index 858ac16..a7f0161 100755 --- a/IPython/parallel/apps/ipcontrollerapp.py +++ b/IPython/parallel/apps/ipcontrollerapp.py @@ -82,7 +82,7 @@ clients. The controller needs to be started before the engines and can be configured using command line options or using a cluster directory. Cluster directories contain config, log and security files and are usually located in your ipython directory and named as "profile_name". See the `profile` -and `profile_dir` options for details. +and `profile-dir` options for details. """ _examples = """ diff --git a/IPython/parallel/apps/ipengineapp.py b/IPython/parallel/apps/ipengineapp.py index ceea949..1263d91 100755 --- a/IPython/parallel/apps/ipengineapp.py +++ b/IPython/parallel/apps/ipengineapp.py @@ -61,12 +61,12 @@ and controller. A controller needs to be started before the engines. The engine can be configured using command line options or using a cluster directory. Cluster directories contain config, log and security files and are usually located in your ipython directory and named as "profile_name". -See the `profile` and `profile_dir` options for details. +See the `profile` and `profile-dir` options for details. """ _examples = """ ipengine --ip=192.168.0.1 --port=1000 # connect to hub at ip and port -ipengine --log-to-file --log_level=DEBUG # log to a file with DEBUG verbosity +ipengine --log-to-file --log-level=DEBUG # log to a file with DEBUG verbosity """ #----------------------------------------------------------------------------- diff --git a/IPython/parallel/apps/iploggerapp.py b/IPython/parallel/apps/iploggerapp.py index 8c98f2d..430dfcf 100755 --- a/IPython/parallel/apps/iploggerapp.py +++ b/IPython/parallel/apps/iploggerapp.py @@ -48,7 +48,7 @@ by registering a `zmq.log.handlers.PUBHandler` with the `logging` module. The logger can be configured using command line options or using a cluster directory. Cluster directories contain config, log and security files and are usually located in your ipython directory and named as "profile_name". -See the `profile` and `profile_dir` options for details. +See the `profile` and `profile-dir` options for details. """ diff --git a/IPython/parallel/apps/winhpcjob.py b/IPython/parallel/apps/winhpcjob.py index 8cfe89f..782d533 100644 --- a/IPython/parallel/apps/winhpcjob.py +++ b/IPython/parallel/apps/winhpcjob.py @@ -252,7 +252,7 @@ class IPControllerTask(WinHPCTask): task_name = Unicode('IPController', config=True) controller_cmd = List(['ipcontroller.exe'], config=True) - controller_args = List(['--log-to-file', 'log-level=40'], config=True) + controller_args = List(['--log-to-file', '--log-level=40'], config=True) # I don't want these to be configurable std_out_file_path = Unicode('', config=False) std_err_file_path = Unicode('', config=False) @@ -280,7 +280,7 @@ class IPEngineTask(WinHPCTask): task_name = Unicode('IPEngine', config=True) engine_cmd = List(['ipengine.exe'], config=True) - engine_args = List(['--log-to-file', 'log_level=40'], config=True) + engine_args = List(['--log-to-file', '--log-level=40'], config=True) # I don't want these to be configurable std_out_file_path = Unicode('', config=False) std_err_file_path = Unicode('', config=False)