Commit d30bd704 authored by Matthieu Muffato's avatar Matthieu Muffato
Browse files

Test to beautify perldoc and RST output

parent 95fa73e0
......@@ -5,21 +5,20 @@ beekeeper.pl
NAME
----
::
beekeeper.pl [options]
beekeeper.pl [options]
DESCRIPTION
-----------
::
The Beekeeper is in charge of interfacing between the Queen and a
compute resource or 'compute farm'. Its job is to initialize/sync the
eHive database (via the Queen), query the Queen if it needs any workers
and to send the requested number of workers to open machines via the
runWorker.pl script.
The Beekeeper is in charge of interfacing between the Queen and a compute resource or 'compute farm'.
Its job is to initialize/sync the eHive database (via the Queen), query the Queen if it needs any workers
and to send the requested number of workers to open machines via the runWorker.pl script.
It is also responsible for interfacing with the Queen to identify workers which died
unexpectedly so that she can free the dead workers and reclaim unfinished jobs.
It is also responsible for interfacing with the Queen to identify
workers which died unexpectedly so that she can free the dead workers
and reclaim unfinished jobs.
USAGE EXAMPLES
--------------
......@@ -53,20 +52,28 @@ OPTIONS
Connection parameters
~~~~~~~~~~~~~~~~~~~~~
::
-reg\_conf <path>
Path to a Registry configuration file
-reg_conf <path> : path to a Registry configuration file
-reg_type <string> : type of the registry entry ('hive', 'core', 'compara', etc. - defaults to 'hive')
-reg_alias <string> : species/alias name for the Hive DBAdaptor
-url <url string> : url defining where hive database is located
-nosqlvc <0|1> : skip sql version check if 1
-reg\_type <string>
Type of the registry entry ('hive', 'core', 'compara', etc. -
defaults to 'hive')
-reg\_alias <string>
Species / alias name for the Hive DBAdaptor
-url <url string>
URL defining where hive database is located
-nosqlvc <0\|1>
Skip sql version check if 1
Configs overriding
~~~~~~~~~~~~~~~~~~
::
-config_file <string> : json file (with absolute path) to override the default configurations (could be multiple)
-config\_file <string>
JSON file (with absolute path) to override the default
configurations (could be multiple)
Looping control
~~~~~~~~~~~~~~~
......
......@@ -698,16 +698,16 @@ __DATA__
=head1 NAME
beekeeper.pl [options]
beekeeper.pl [options]
=head1 DESCRIPTION
The Beekeeper is in charge of interfacing between the Queen and a compute resource or 'compute farm'.
Its job is to initialize/sync the eHive database (via the Queen), query the Queen if it needs any workers
and to send the requested number of workers to open machines via the runWorker.pl script.
The Beekeeper is in charge of interfacing between the Queen and a compute resource or 'compute farm'.
Its job is to initialize/sync the eHive database (via the Queen), query the Queen if it needs any workers
and to send the requested number of workers to open machines via the runWorker.pl script.
It is also responsible for interfacing with the Queen to identify workers which died
unexpectedly so that she can free the dead workers and reclaim unfinished jobs.
It is also responsible for interfacing with the Queen to identify workers which died
unexpectedly so that she can free the dead workers and reclaim unfinished jobs.
=head1 USAGE EXAMPLES
......@@ -736,15 +736,39 @@ __DATA__
=head2 Connection parameters
-reg_conf <path> : path to a Registry configuration file
-reg_type <string> : type of the registry entry ('hive', 'core', 'compara', etc. - defaults to 'hive')
-reg_alias <string> : species/alias name for the Hive DBAdaptor
-url <url string> : url defining where hive database is located
-nosqlvc <0|1> : skip sql version check if 1
=over
=item -reg_conf <path>
Path to a Registry configuration file
=item -reg_type <string>
Type of the registry entry ('hive', 'core', 'compara', etc. - defaults to 'hive')
=item -reg_alias <string>
Species / alias name for the Hive DBAdaptor
=item -url <url string>
URL defining where hive database is located
=item -nosqlvc <0|1>
Skip sql version check if 1
=back
=head2 Configs overriding
-config_file <string> : json file (with absolute path) to override the default configurations (could be multiple)
=over
=item -config_file <string>
JSON file (with absolute path) to override the default configurations (could be multiple)
=back
=head2 Looping control
......
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