Release 1.9.3 (#574)

https://clustershell.readthedocs.io/en/v1.9.3/release.html

Closes #574.

Author: thiell

.readthedocs.yaml

@@ -1,8 +1,8 @@
 version: 2
 build:
-  os: "ubuntu-22.04"
+  os: "ubuntu-24.04"
   tools:
-    python: "3.11"
+    python: "3.12"
 
 sphinx:
   configuration: doc/sphinx/conf.py

ChangeLog

@@ -1,3 +1,19 @@
+2025-01-23 S. Thiell <sthiell@stanford.edu>
+
+	* Version 1.9.3 released. The main changes are listed below.
+
+	* Added bash completions (#563)
+
+	* Communication: sax parser: add flush() after feed() (#556)
+
+	* Additional Slurm binding options (#558 and #561)
+
+	* clush: use set instead of NodeSet for runtime progress info (#562)
+
+	* Tree: Tree: use set instead of NodeSet for gwtargets tracking (#562)
+
+	* CLI/Nodeset: omit @source: prefix for cluset -s source -L (#563) (#570)
+
 2023-09-29 S. Thiell <sthiell@stanford.edu>
 
 	* Version 1.9.2 released. The main changes are listed below.

clustershell.spec.in

@@ -242,6 +242,9 @@ rm -rf %{buildroot}
 %{bash_completions_dir}/nodeset
 
 %changelog
+* Thu Jan 23 2025 Stephane Thiell <sthiell@stanford.edu> 1.9.3-1
+- update to 1.9.3
+
 * Fri Sep 29 2023 Stephane Thiell <sthiell@stanford.edu> 1.9.2-1
 - update to 1.9.2
 

doc/man/man1/clubak.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH CLUBAK 1 "2023-09-29" "1.9.2" "ClusterShell User Manual"
-.SH NAME
-clubak \- format output from clush/pdsh-like output and more
 .
 .nr rst2man-indent-level 0
 .
@@ -30,19 +27,22 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
+.TH "CLUBAK" "1" "2025-01-23" "1.9.3" "ClusterShell User Manual"
+.SH NAME
+clubak \- format output from clush/pdsh-like output and more
 .SH SYNOPSIS
 .sp
 \fBclubak\fP [ OPTIONS ]
 .SH DESCRIPTION
 .sp
 \fBclubak\fP formats text from standard input containing lines of the form
-"\fInode:output\fP".  It is fully backward compatible with \fBdshbak\fP(1) but
+\(dq\fInode:output\fP\(dq.  It is fully backward compatible with \fBdshbak\fP(1) but
 provides additional features. For instance, \fBclubak\fP always displays
 its results sorted by node/nodeset.
 .sp
 You do not need to use \fBclubak\fP when using \fBclush\fP(1) as all output
 formatting features are already included in. It is provided for other usages,
-like post\-processing results of the form "\fInode:output\fP".
+like post\-processing results of the form \(dq\fInode:output\fP\(dq.
 .sp
 Like \fBclush\fP(1), \fBclubak\fP uses the \fIClusterShell.MsgTree\fP module of the
 ClusterShell library (see \fBpydoc ClusterShell.MsgTree\fP).
@@ -52,20 +52,20 @@ ClusterShell library (see \fBpydoc ClusterShell.MsgTree\fP).
 .SH OPTIONS
 .INDENT 0.0
 .TP
-.B \-\-version
+.B  \-\-version
 show \fBclubak\fP version number and exit
 .TP
-.B \-b\fP,\fB  \-c
+.B  \-b\fP,\fB  \-c
 gather nodes with same output (\-c is provided for \fBdshbak\fP(1)
 compatibility)
 .TP
-.B \-d\fP,\fB  \-\-debug
+.B  \-d\fP,\fB  \-\-debug
 output more messages for debugging purpose
 .TP
-.B \-L
+.B  \-L
 disable header block and order output by nodes
 .TP
-.B \-r\fP,\fB  \-\-regroup
+.B  \-r\fP,\fB  \-\-regroup
 fold nodeset using node groups
 .TP
 .BI \-s \ GROUPSOURCE\fR,\fB \ \-\-groupsource\fB= GROUPSOURCE
@@ -74,22 +74,22 @@ optional \fBgroups.conf\fP(5) group source to use
 .BI \-\-groupsconf\fB= FILE
 use alternate config file for groups.conf(5)
 .TP
-.B \-G\fP,\fB  \-\-groupbase
+.B  \-G\fP,\fB  \-\-groupbase
 do not display group source prefix (always \fI@groupname\fP)
 .TP
 .BI \-S \ SEPARATOR\fR,\fB \ \-\-separator\fB= SEPARATOR
 node / line content separator string (default: \fI:\fP)
 .TP
-.B \-F\fP,\fB  \-\-fast
+.B  \-F\fP,\fB  \-\-fast
 faster but memory hungry mode (preload all messages per node)
 .TP
-.B \-T\fP,\fB  \-\-tree
+.B  \-T\fP,\fB  \-\-tree
 message tree trace mode; switch to enable \fBClusterShell.MsgTree\fP trace mode, all keys/nodes being kept for each message element of the tree, thus allowing special output gathering
 .TP
 .BI \-\-color\fB= WHENCOLOR
 \fBclush\fP can use NO_COLOR, CLICOLOR and CLICOLOR_FORCE environment variables. \fB\-\-color\fP command line option always takes precedence over environment variables. NO_COLOR takes precedence over CLICOLOR_FORCE which takes precedence over CLICOLOR. \fB\-\-color\fP tells whether to use ANSI colors to surround node or nodeset prefix/header with escape sequences to display them in color on the terminal. \fIWHENCOLOR\fP is \fBnever\fP, \fBalways\fP or \fBauto\fP (which use color if standard output refers to a terminal). Color is set to [34m (blue foreground text) and cannot be modified.
 .TP
-.B \-\-diff
+.B  \-\-diff
 show diff between gathered outputs
 .UNINDENT
 .SH EXIT STATUS
@@ -121,7 +121,7 @@ Another example, iterate over \fInode*\fP text files in current directory and ga
 .INDENT 3.0
 .INDENT 3.5
 .nf
-# find \-name "node*" \-exec wc \-c {} ; | awk \(aq{ gsub("./","",$2); print $2": "$1 }\(aq | clubak \-bL
+# find \-name \(dqnode*\(dq \-exec wc \-c {} ; | awk \(aq{ gsub(\(dq./\(dq,\(dq\(dq,$2); print $2\(dq: \(dq$1 }\(aq | clubak \-bL
 node[1,3]: 7
 node2: 9
 .fi
@@ -133,12 +133,12 @@ node2: 9
 .sp
 \fBcluset\fP(1), \fBclush\fP(1), \fBnodeset\fP(1), \fBgroups.conf\fP(5).
 .sp
-\fI\%http://clustershell.readthedocs.org/\fP
+ <http://clustershell.readthedocs.org/> 
 .SH BUG REPORTS
 .INDENT 0.0
 .TP
 .B Use the following URL to submit a bug report or feedback:
-\fI\%https://github.com/cea\-hpc/clustershell/issues\fP
+ <https://github.com/cea\-hpc/clustershell/issues> 
 .UNINDENT
 .SH AUTHOR
 Stephane Thiell <sthiell@stanford.edu>

doc/man/man1/cluset.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH CLUSET 1 "2023-09-29" "1.9.2" "ClusterShell User Manual"
-.SH NAME
-cluset \- compute advanced cluster node set operations
 .
 .nr rst2man-indent-level 0
 .
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
+.TH "CLUSET" "1" "2025-01-23" "1.9.3" "ClusterShell User Manual"
+.SH NAME
+cluset \- compute advanced cluster node set operations
 .SH SYNOPSIS
 .INDENT 0.0
 .INDENT 3.5
@@ -53,10 +53,10 @@ administration shell scripts.
 .INDENT 3.5
 .INDENT 0.0
 .TP
-.B \-\-version
+.B  \-\-version
 show program\(aqs version number and exit
 .TP
-.B \-h\fP,\fB  \-\-help
+.B  \-h\fP,\fB  \-\-help
 show this help message and exit
 .TP
 .BI \-s \ GROUPSOURCE\fR,\fB \ \-\-groupsource\fB= GROUPSOURCE
@@ -70,22 +70,25 @@ use alternate config file for groups.conf(5)
 .B Commands:
 .INDENT 7.0
 .TP
-.B \-c\fP,\fB  \-\-count
+.B  \-c\fP,\fB  \-\-count
 show number of nodes in nodeset(s)
 .TP
-.B \-e\fP,\fB  \-\-expand
+.B  \-e\fP,\fB  \-\-expand
 expand nodeset(s) to separate nodes (see also \-S \fISEPARATOR\fP)
 .TP
-.B \-f\fP,\fB  \-\-fold
+.B  \-f\fP,\fB  \-\-fold
 fold nodeset(s) (or separate nodes) into one nodeset
 .TP
-.B \-l\fP,\fB  \-\-list
+.B  \-l\fP,\fB  \-\-list
 list node groups, list node groups and nodes (\fB\-ll\fP) or list node groups, nodes and node count (\fB\-lll\fP). When no argument is specified at all, this command will list all node group names found in selected group source (see also \-s \fIGROUPSOURCE\fP). If any nodesets are specified as argument, this command will find node groups these nodes belongs to (individually). Optionally for each group, the fraction of these nodes being member of the group may be displayed (with \fB\-ll\fP), and also member count/total group node count (with \fB\-lll\fP). If a single hyphen\-minus (\-) is given as a nodeset, it will be read from standard input.
 .TP
-.B \-r\fP,\fB  \-\-regroup
+.B  \-L\fP,\fB  \-\-list\-all
+list node groups from all group sources (\fB\-LL\fP shows nodes and \fB\-LLL\fP adds node count). Like \fB\-l\fP, if any nodesets are specified as argument, this command will find node groups these nodes belongs to (individually).
+.TP
+.B  \-r\fP,\fB  \-\-regroup
 fold nodes using node groups (see \-s \fIGROUPSOURCE\fP)
 .TP
-.B \-\-groupsources
+.B  \-\-groupsources
 list all active group sources (see \fBgroups.conf\fP(5))
 .UNINDENT
 .TP
@@ -105,23 +108,23 @@ calculate symmetric difference between sets
 .B Options:
 .INDENT 7.0
 .TP
-.B \-a\fP,\fB  \-\-all
+.B  \-a\fP,\fB  \-\-all
 call external node groups support to display all nodes
 .TP
 .BI \-\-autostep\fB= AUTOSTEP
-enable a\-b/step style syntax when folding nodesets, value is min node count threshold (integer \(aq4\(aq, percentage \(aq50%\(aq or \(aqauto\(aq). If not specified, auto step is disabled (best for compatibility with other cluster tools. Example: autostep=4, "node2 node4 node6" folds in node[2,4,6] but autostep=3, "node2 node4 node6" folds in node[2\-6/2].
+enable a\-b/step style syntax when folding nodesets, value is min node count threshold (integer \(aq4\(aq, percentage \(aq50%\(aq or \(aqauto\(aq). If not specified, auto step is disabled (best for compatibility with other cluster tools. Example: autostep=4, \(dqnode2 node4 node6\(dq folds in node[2,4,6] but autostep=3, \(dqnode2 node4 node6\(dq folds in node[2\-6/2].
 .TP
-.B \-d\fP,\fB  \-\-debug
+.B  \-d\fP,\fB  \-\-debug
 output more messages for debugging purpose
 .TP
-.B \-q\fP,\fB  \-\-quiet
+.B  \-q\fP,\fB  \-\-quiet
 be quiet, print essential output only
 .TP
-.B \-R\fP,\fB  \-\-rangeset
+.B  \-R\fP,\fB  \-\-rangeset
 switch to RangeSet instead of NodeSet. Useful when
 working on numerical cluster ranges, eg. 1,5,18\-31
 .TP
-.B \-G\fP,\fB  \-\-groupbase
+.B  \-G\fP,\fB  \-\-groupbase
 hide group source prefix (always \fI@groupname\fP)
 .TP
 .BI \-S \ SEPARATOR\fR,\fB \ \-\-separator\fB= SEPARATOR
@@ -132,13 +135,13 @@ separator string to use when expanding nodesets
 output format (default: \(aq%s\(aq)
 .TP
 .BI \-I \ SLICE_RANGESET\fR,\fB \ \-\-slice\fB= SLICE_RANGESET
-return sliced off result; examples of SLICE_RANGESET are "0" for simple index selection, or "1\-9/2,16" for complex rangeset selection
+return sliced off result; examples of SLICE_RANGESET are \(dq0\(dq for simple index selection, or \(dq1\-9/2,16\(dq for complex rangeset selection
 .TP
 .BI \-\-split\fB= MAXSPLIT
 split result into a number of subsets
 .TP
-.B \-\-contiguous
-split result into contiguous subsets (ie. for nodeset, subsets will contain nodes with same pattern name and a contiguous range of indexes, like foobar[1\-100]; for rangeset, subsets with consists in contiguous index ranges)"""
+.B  \-\-contiguous
+split result into contiguous subsets (ie. for nodeset, subsets will contain nodes with same pattern name and a contiguous range of indexes, like foobar[1\-100]; for rangeset, subsets with consists in contiguous index ranges)\(dq\(dq\(dq
 .TP
 .BI \-\-axis\fB= RANGESET
 for nD nodesets, fold along provided axis only. Axis are indexed from 1 to n and can be specified here either using the rangeset syntax, eg. \(aq1\(aq, \(aq1\-2\(aq, \(aq1,3\(aq, or by a single negative number meaning that the indices is counted from the end. Because some nodesets may have several different dimensions, axis indices are silently truncated to fall in the allowed range.
@@ -225,7 +228,7 @@ node[0\-4,11\-13]
 .sp
 This computes a folded nodeset containing nodes found in group @gpu and @slurm:bigmem, but not in both, minus the nodes found in odd chassis groups from 1 to 9.
 .TP
-.B "All nodes" extension
+.B \(dqAll nodes\(dq extension
 The \fB@*\fP and \fB@SOURCE:*\fP special notations may be used in extended patterns to represent all nodes (in SOURCE) according to the \fIall\fP external shell command (see \fBgroups.conf\fP(5)) and are equivalent to:
 .INDENT 7.0
 .INDENT 3.5
@@ -469,17 +472,17 @@ dc3n[4\-5]
 .SH HISTORY
 .sp
 \fBcluset\fP was added in 1.7.3 to avoid a conflict with xCAT\(aqs \fBnodeset\fP
-command and also to conform with ClusterShell\(aqs "clu*" command nomenclature.
+command and also to conform with ClusterShell\(aqs \(dqclu*\(dq command nomenclature.
 .SH SEE ALSO
 .sp
 \fBclubak\fP(1), \fBclush\fP(1), \fBnodeset\fP(1), \fBgroups.conf\fP(5).
 .sp
-\fI\%http://clustershell.readthedocs.org/\fP
+ <http://clustershell.readthedocs.org/> 
 .SH BUG REPORTS
 .INDENT 0.0
 .TP
 .B Use the following URL to submit a bug report or feedback:
-\fI\%https://github.com/cea\-hpc/clustershell/issues\fP
+ <https://github.com/cea\-hpc/clustershell/issues> 
 .UNINDENT
 .SH AUTHOR
 Stephane Thiell <sthiell@stanford.edu>