Tim Landscheidt has uploaded a new change for review. https://gerrit.wikimedia.org/r/106648
Change subject: Fix Lintian errors in jobutils man pages ...................................................................... Fix Lintian errors in jobutils man pages Change-Id: I28c30499269b3f87a893fcbf5ea780720fd68a5f --- A debian/jobutils.links M debian/jobutils.manpages M jobutils/man/Makefile.am A jobutils/man/job.1 D jobutils/man/jstart.1 M jobutils/man/jstop.1 M jobutils/man/jsub.1 7 files changed, 115 insertions(+), 71 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/labs/toollabs refs/changes/48/106648/1 diff --git a/debian/jobutils.links b/debian/jobutils.links new file mode 100644 index 0000000..c3d92ca --- /dev/null +++ b/debian/jobutils.links @@ -0,0 +1,2 @@ +usr/share/man/man1/jsub.1 usr/share/man/man1/jstart.1 +usr/share/man/man1/jsub.1 usr/share/man/man1/qcronsub.1 diff --git a/debian/jobutils.manpages b/debian/jobutils.manpages index bde9a92..92a5a84 100644 --- a/debian/jobutils.manpages +++ b/debian/jobutils.manpages @@ -1,3 +1,3 @@ -debian/tmp/usr/share/man/man1/jstart.1 +debian/tmp/usr/share/man/man1/job.1 debian/tmp/usr/share/man/man1/jstop.1 debian/tmp/usr/share/man/man1/jsub.1 diff --git a/jobutils/man/Makefile.am b/jobutils/man/Makefile.am index c9b180d..77b9af7 100644 --- a/jobutils/man/Makefile.am +++ b/jobutils/man/Makefile.am @@ -1 +1 @@ -man_MANS = jstart.1 jstop.1 jsub.1 +man_MANS = job.1 jstop.1 jsub.1 diff --git a/jobutils/man/job.1 b/jobutils/man/job.1 new file mode 100644 index 0000000..a08c857 --- /dev/null +++ b/jobutils/man/job.1 @@ -0,0 +1,36 @@ +.\" Man page for job +.\" Licensed under CC-BY-SA +.\" Created by Marc-André Pelletier +.\" +.TH JOB 1 2014-01-10 1.0.5 "Wikimedia Labs Tools jobutils" +.SH NAME +job \- output the job number to a name +.SH SYNOPSIS +.B job +.I jobname + +.B job +\-v +.I jobname + +.B job +\-q +.I jobname +.SH DESCRIPTION +.B job +outputs the job number corresponding to +.I jobname +on standard output. +.SH OPTIONS +.TP +.B -v +Output verbose (human readable) information. +.TP +.B -q +Do not output anything, just set exit status. +.SH EXIT STATUS +.B job +returns 0 if no job with that name exists, 1 if such a job is +currently running and 2 if such a job is currently queued. +.SH AUTHORS +Marc-André Pelletier, Petr Bena diff --git a/jobutils/man/jstart.1 b/jobutils/man/jstart.1 deleted file mode 100644 index 8fb4d2a..0000000 --- a/jobutils/man/jstart.1 +++ /dev/null @@ -1,34 +0,0 @@ -.\" Man page for jstart -.\" Licensed under BSD-like License. -.\" Created by Marc-André Pelletier -.\" -.TH Jobutils "jstart" "User Manual" -.SH NAME -usage: jstart [options...] program [arg...] - -Options include many (but not all) qsub options, along with: - \-stderr Send errors to stderr rather than the error - output file. - \-mem <value> Request <value> amount of memory for the job. - (number prefixed by 'k', 'm' or 'g') - \-once Only start one job with that name, fail if - another is already started or queued (default if - invoked as 'jstart'). - \-continuous Start a self-restarting job on the continuous - queue (default if invoked as 'jstart') - \-umask <value> Set umask for output files if they don't exist - \-quiet Suppress output if job could be submitted. - -Unlike qsub, if you do not specify output and error files, output is appended -by default to files named <job>.err and <job>.out in your home directory -(without job numbers), including errors from starting the job itself. - -Additionally, you need to provide an executable on the command line, -jstart will not read a script from standard input. - -.SH DESCRIPTION -jobutils will insert extra commands to grid engine, these tools were created for wikimedia tools project -.PP -.SH "AUTHOR" -Marc-André Pelletier, Petr Bena -.br diff --git a/jobutils/man/jstop.1 b/jobutils/man/jstop.1 index 50bea5e..072601f 100644 --- a/jobutils/man/jstop.1 +++ b/jobutils/man/jstop.1 @@ -1,16 +1,17 @@ -.\" Man page for jstart +.\" Man page for jstop .\" Licensed under CC-BY-SA .\" Created by Marc-André Pelletier .\" -.TH Jobutils "jstop" "User Manual" +.TH JSTOP 1 2014-01-10 1.0.5 "Wikimedia Labs Tools jobutils" .SH NAME -usage: jstop [jobname] - -Delete a job - +jstop \- delete a job from the grid +.SH SYNOPSIS +.B jstop +.I jobname .SH DESCRIPTION -jobutils will insert extra commands to grid engine, these tools were created for wikimedia tools project -.PP -.SH "AUTHOR" +.B jstop +deletes the job with the name +.I jobname +from the grid. +.SH AUTHORS Marc-André Pelletier, Petr Bena -.br diff --git a/jobutils/man/jsub.1 b/jobutils/man/jsub.1 index 03e5215..ef5d2c2 100644 --- a/jobutils/man/jsub.1 +++ b/jobutils/man/jsub.1 @@ -1,34 +1,73 @@ -.\" Man page for jstart +.\" Man page for jsub .\" Licensed under CC-BY-SA .\" Created by Marc-André Pelletier .\" -.TH Jobutils "jsub" "User Manual" +.TH JSUB 1 2014-01-10 1.0.5 "Wikimedia Labs Tools jobutils" .SH NAME -usage: jsub [options...] program [arg...] +jsub, jstart, qcronsub \- submit jobs to the grid +.SH SYNOPSIS +.B jsub +[options] program [args] +.B jstart +[options] program [args] + +.B qcronsub +[options] program [args] +.SH DESCRIPTION +.B jsub +submits a job to the grid. +.B qcronsub +submits a job only if a job with the same name is not already queued or running. +.B jstart +submits a self-restarting job on the continuous queue. +.SH OPTIONS Options include many (but not all) qsub options, along with: - \-stderr Send errors to stderr rather than the error - output file. - \-mem <value> Request <value> amount of memory for the job. - (number prefixed by 'k', 'm' or 'g') - \-once Only start one job with that name, fail if - another is already started or queued (default if - invoked as 'jstart'). - \-continuous Start a self-restarting job on the continuous - queue (default if invoked as 'jstart') - \-umask <value> Set umask for output files if they don't exist - \-quiet Suppress output if job could be submitted. - -Unlike qsub, if you do not specify output and error files, output is appended -by default to files named <job>.err and <job>.out in your home directory -(without job numbers), including errors from starting the job itself. +.TP +.BI \-stderr +Send errors to stderr rather than the error output file. +.TP +.BI \-mem\ value +Request +.I value +amount of memory for the job (number suffixed by "k", "m" or "g"). +.TP +.BI \-once +Only start one job with that name, fail if another is already started +or queued (default if invoked as +.B jstart +or +.BR qcronsub ). +.TP +.BI \-continuous +Start a self-restarting job on the continuous queue (default if +invoked as +.BR jstart ). +.TP +.BI \-umask\ value +Set umask for output files if they don't exist. +.TP +.BI \-quiet +Suppress output if job was submitted successfully. +.SH EXIT STATUS +.BR jsub , +.B jstart +and +.B qcronsub +return 0 on successful submission, and a different exit code +otherwise. +.SH NOTES +Unlike qsub, if you do not specify output and error files, output is +appended by default to files named +.I <job>.err +and +.I <job>.out +in your home directory (without job numbers), including errors from +starting the job itself. Additionally, you need to provide an executable on the command line, -jstart will not read a script from standard input. - -.SH DESCRIPTION -jobutils will insert extra commands to grid engine, these tools were created for wikimedia tools project -.PP -.SH "AUTHOR" +these utilities will not read a script from standard input. +.SH AUTHORS Marc-André Pelletier, Petr Bena -.br +.SH SEE ALSO +.BR qsub (1) -- To view, visit https://gerrit.wikimedia.org/r/106648 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I28c30499269b3f87a893fcbf5ea780720fd68a5f Gerrit-PatchSet: 1 Gerrit-Project: labs/toollabs Gerrit-Branch: master Gerrit-Owner: Tim Landscheidt <t...@tim-landscheidt.de> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
