From 128d24ce8a571ec1a0a923bc7c5f4a783f9c8ac2 Mon Sep 17 00:00:00 2001
From: Brian Christiansen <brian@schedmd.com>
Date: Fri, 28 Aug 2015 10:43:16 -0700
Subject: [PATCH] Add --noconvert docs to squeue,sstat,sinfo,sacct
---
doc/man/man1/sacct.1 | 12 ++++++------
doc/man/man1/sinfo.1 | 5 +++++
doc/man/man1/squeue.1 | 5 +++++
doc/man/man1/sstat.1 | 5 +++++
src/sacct/options.c | 6 +++---
src/sinfo/opts.c | 4 ++--
src/squeue/opts.c | 2 ++
src/sstat/options.c | 2 ++
8 files changed, 30 insertions(+), 11 deletions(-)
diff --git a/doc/man/man1/sacct.1 b/doc/man/man1/sacct.1
index aadcf24e8b8..5dfa2502f40 100644
--- a/doc/man/man1/sacct.1
+++ b/doc/man/man1/sacct.1
@@ -242,18 +242,18 @@ comma\-separated list of clusters. Space characters are not allowed
in the \f2cluster_list\fP. Use \-1 for all clusters. The default is
current cluster you are executing the \f3sacct\fP command on\&.
-.TP
-\f3\-\-noconvert\fP
-Fields such as MaxRSS, ReqMem and others will not be converted from their orignal
-unit types.
-.IP
-
.TP
\f3\-n\fP\f3,\fP \f3\-\-noheader\fP
No heading will be added to the output. The default action is to
display a header.
.IP
+.TP
+\f3\-\-noconvert\fP
+Don't convert units from their original type (e.g. 2048M won't be converted to
+2G).
+.IP
+
.TP
\f3\-N \fP\f2node_list\fP\f3, \-\-nodelist=\fP\f2node_list\fP
Display jobs that ran on any of these node(s). \f2node_list\fP can be
diff --git a/doc/man/man1/sinfo.1 b/doc/man/man1/sinfo.1
index c47c8d054fa..59cc2adb4ad 100644
--- a/doc/man/man1/sinfo.1
+++ b/doc/man/man1/sinfo.1
@@ -72,6 +72,11 @@ indicate eight nodes, "linux00" through "linux07."
Performance of the command can be measurably improved for systems with large
numbers of nodes when a single node name is specified.
+.TP
+\fB\-\-noconvert\fR
+Don't convert units from their original type (e.g. 2048M won't be converted to
+2G).
+
.TP
\fB\-N\fR, \fB\-\-Node\fR
Print information in a node\-oriented format.
diff --git a/doc/man/man1/squeue.1 b/doc/man/man1/squeue.1
index 5beefe72d8d..265921fe005 100644
--- a/doc/man/man1/squeue.1
+++ b/doc/man/man1/squeue.1
@@ -87,6 +87,11 @@ A value of of '\fIall\fR' will query to run on all clusters.
Request jobs or job steps having one of the specified names. The
list consists of a comma separated list of job names.
+.TP
+\fB\-\-noconvert\fR
+Don't convert units from their original type (e.g. 2048M won't be converted to
+2G).
+
.TP
\fB\-o <output_format>\fR, \fB\-\-format=<output_format>\fR
Specify the information to be displayed, its size and position
diff --git a/doc/man/man1/sstat.1 b/doc/man/man1/sstat.1
index 9d69ade14f9..bfd1445247a 100644
--- a/doc/man/man1/sstat.1
+++ b/doc/man/man1/sstat.1
@@ -72,6 +72,11 @@ NOTE: A step id of 'batch' will display the information about the batch step.
No heading will be added to the output. The default action is to
display a header.
+.TP
+\f3\-\-noconvert\fP
+Don't convert units from their original type (e.g. 2048M won't be converted to
+2G).
+
.TP
\f3\-o\fP\f3,\fP \f3\-\-format\fP,\fP \f3\-\-fields\fP
Comma separated list of fields.
diff --git a/src/sacct/options.c b/src/sacct/options.c
index d4c88da07b4..a70f21a6708 100644
--- a/src/sacct/options.c
+++ b/src/sacct/options.c
@@ -349,12 +349,12 @@ sacct [<OPTION>] \n \
displayed. \n\
-M, --clusters: \n\
Only send data about these clusters. -1 for all clusters.\n\
- --noconvert: \n\
- Fields such as MaxRSS, ReqMem and others will not be \n\
- converted from their orignal unit types. \n\
-n, --noheader: \n\
No header will be added to the beginning of output. \n\
The default is to print a header. \n\
+ --noconvert: \n\
+ Don't convert units from their original type \n\
+ (e.g. 2048M won't be converted to 2G). \n\
-N, --nodelist: \n\
Display jobs that ran on any of these nodes, \n\
can be one or more using a ranged string. \n\
diff --git a/src/sinfo/opts.c b/src/sinfo/opts.c
index 1af0adc14e2..63758c1c248 100644
--- a/src/sinfo/opts.c
+++ b/src/sinfo/opts.c
@@ -1285,13 +1285,13 @@ Usage: sinfo [OPTIONS]\n\
-b, --bg show bgblocks (on Blue Gene systems)\n\
-d, --dead show only non-responding nodes\n\
-e, --exact group nodes only on exact match of configuration\n\
- --noconvert Fields such as MaxRSS, ReqMem and others will\n\
- not be converted from their orignal unit types.\n\
-h, --noheader no headers on output\n\
--hide do not show hidden or non-accessible partitions\n\
-i, --iterate=seconds specify an iteration period\n\
-l, --long long output - displays more information\n\
-n, --nodes=NODES report on specific node(s)\n\
+ --noconvert don't convert units from their original type\n\
+ (e.g. 2048M won't be converted to 2G).\n\
-N, --Node Node-centric format\n\
-o, --format=format format specification\n\
-O, --Format=format long format specification\n\
diff --git a/src/squeue/opts.c b/src/squeue/opts.c
index 577911c4717..f9e6d2622d6 100644
--- a/src/squeue/opts.c
+++ b/src/squeue/opts.c
@@ -1925,6 +1925,8 @@ Usage: squeue [OPTIONS]\n\
current cluster. cluster with no name will\n\
reset to default.\n\
-n, --name=job_name(s) comma separated list of job names to view\n\
+ --noconvert don't convert units from their original type\n\
+ (e.g. 2048M won't be converted to 2G).\n\
-o, --format=format format specification\n\
-p, --partition=partition(s) comma separated list of partitions\n\
to view, default is all partitions\n\
diff --git a/src/sstat/options.c b/src/sstat/options.c
index d4c1868233a..5985bc4823f 100644
--- a/src/sstat/options.c
+++ b/src/sstat/options.c
@@ -92,6 +92,8 @@ sstat [<OPTION>] -j <job(.stepid)> \n\
-n, --noheader: \n\
No header will be added to the beginning of output. \n\
The default is to print a header. \n\
+ --noconvert: Don't convert units from their original type \n\
+ (e.g. 2048M won't be converted to 2G). \n\
-o, --format: \n\
Comma separated list of fields. (use \"--helpformat\" \n\
for a list of available fields). \n\
--
GitLab