Release 1.7

Change-Id: I8ba7b1ff5d793cc4f8af4227000302a5530e7b61

Author: thiell

ChangeLog

@@ -1,3 +1,7 @@
+2015-11-10 S. Thiell <[email protected]>
+
+	* Version 1.7 released.
+
 2015-11-01 S. Thiell <[email protected]>
 
 	* Clush.py: added -P/--progress to force display of the live progress

README renamed to README.md

@@ -1,6 +1,5 @@
- -----------------------------------------
- ClusterShell 1.6 Python Library and Tools
- -----------------------------------------
+ClusterShell 1.7 Python Library and Tools
+=========================================
 
 ClusterShell is an event-driven open source Python library, designed to run
 local or distant commands in parallel on server farms or on large Linux
@@ -16,43 +15,44 @@ developers. It also provides clush, clubak and nodeset, three convenient
 command-line tools that allow traditional shell scripts to benefit from some
 of the library features.
 
- -------------------
- Requirements (v1.6)
- -------------------
-
- * GNU/Linux, *BSD, Mac OS X, etc.
-
- * OpenSSH (ssh/scp)
+Requirements (v1.7)
+-------------------
 
+ * GNU/Linux, *BSD, Mac OS X
+ * OpenSSH (ssh/scp) or rsh
  * Python 2.x (x >= 4)
+ * PyYAML (optional)
 
- -------
- License
- -------
+License
+-------
 
 ClusterShell is distributed under the CeCILL-C license, a French transposition
 of the GNU LGPL, and is fully LGPL-compatible (see Licence_CeCILL-C_V1-en.txt).
 
- ------------
- Installation
- ------------
+Documentation
+-------------
+
+Online documentation is available here:
 
-When possible, please use the RPM/deb package distribution:
+    http://clustershell.readthedocs.org/
 
-    https://github.com/cea-hpc/clustershell/wiki/GetClusterShell
+The Sphinx documentation source is available under the doc/sphinx directory.
+Type 'make' to see all available formats (you need Sphinx installed and
+sphinx_rtd_theme to build the documentation). For example, to generate html
+docs, just type:
 
-Otherwise in the source directory, use:
+    make html BUILDDIR=/dest/path
 
-    # python setup.py install
-    # cp -r conf /etc/clustershell
+For local library API documentation, just type:
+
+    $ pydoc ClusterShell
 
-For installation on Mac OS X, please see:
+The following man pages are also provided:
 
-    https://github.com/cea-hpc/clustershell/wiki/ClusterShellOnMacOSX
+    clush(1), clubak(1), nodeset(1), clush.conl(5), groups.conf(5)
 
- ----------
- Test Suite
- ----------
+Test Suite
+----------
 
 Regression testing scripts are available in the 'tests' directory:
 
@@ -64,25 +64,10 @@ You have to allow 'ssh localhost' and 'ssh $HOSTNAME' without any warnings for
 "remote" tests to run as expected. $HOSTNAME should not be 127.0.0.1 nor ::1.
 Also some tests use the 'bc' command.
 
- --------------
- Documentation
- -------------
-
-Local API documentation is available, just type:
-
-    $ pydoc ClusterShell
-
-Online API documentation (epydoc) is available here:
+ClusterShell interactively
+--------------------------
 
-    http://packages.python.org/ClusterShell/
-
- --------------------------
- ClusterShell interactively
- --------------------------
-
-Python 2.7.1 (r271:86832, Apr 12 2011, 16:15:16)
-[GCC 4.6.0 20110331 (Red Hat 4.6.0-2)] on linux2
-Type "help", "copyright", "credits" or "license" for more information.
+```python
 >>> from ClusterShell.Task import task_self
 >>> from ClusterShell.NodeSet import NodeSet
 >>> task = task_self()
@@ -94,32 +79,20 @@ Type "help", "copyright", "credits" or "license" for more information.
 linux[32-39] 2.6.40.6-0.fc15.x86_64
 
 linux[4-6] 2.6.32-71.el6.x86_64
+```
 
- ------------------
- ClusterShell Tools
- ------------------
-
-Powerful tools are provided: clush, nodeset and clubak.
-
-* clush is a friendly and full-featured parallel shell (see: man clush).
-  If in doubt, just check if your other parallel tools can do things like:
-  # tar -czf - dir | clush -w node[10-44] tar -C /tmp -xzvf -
-
-* nodeset is used to deal with your cluster nodeset, it can be bound to
-  external groups (see: man nodeset and man groups.conf).
+Links
+-----
 
-* clubak is a tool used to format output from clush/pdsh-like output
-  (already included in clush with -b), see man clubak.
-
- -----
- Links
- -----
-
-Main web site:
+Web site:
 
     http://clustershell.sourceforge.net
     or http://cea-hpc.github.com/clustershell/
 
+Online documentation:
+
+    http://clustershell.readthedocs.org/
+
 Github source respository:
 
     https://github.com/cea-hpc/clustershell
@@ -144,12 +117,12 @@ ClusterShell was born along with Shine, a scalable Lustre FS admin tool:
 
     http://lustre-shine.sourceforge.net
 
- -------
- Authors
- -------
+Core developers/reviewers
+-------------------------
 
-Stephane Thiell           <[email protected]>
-Aurelien Degremont     <[email protected]>
-Henri Doreau                 <[email protected]>
+* Stephane Thiell
+* Aurelien Degremont
+* Henri Doreau
+* Dominique Martinet
 
 CEA/DAM 2010, 2011, 2012, 2013, 2014, 2015 - http://www-hpc.cea.fr

clustershell.spec.in

@@ -68,7 +68,7 @@ rm -rf %{buildroot}
 
 %files
 %defattr(-,root,root,-)
-%doc README ChangeLog Licence_CeCILL-C_V1-en.txt Licence_CeCILL-C_V1-fr.txt
+%doc README.md ChangeLog Licence_CeCILL-C_V1-en.txt Licence_CeCILL-C_V1-fr.txt
 %doc doc/examples
 %doc doc/sphinx
 %{_mandir}/man1/clubak.1*
@@ -101,6 +101,9 @@ rm -rf %{buildroot}
 %{vimdatadir}/syntax/groupsconf.vim
 
 %changelog
+* Tue Nov 10 2015 Stephane Thiell <[email protected]> 1.7-1
+- update to 1.7
+
 * Fri Aug  7 2015 Stephane Thiell <[email protected]> 1.6.96-1
 - update to 1.6.96
 

doc/man/man1/clubak.1

@@ -1,6 +1,6 @@
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
 .
-.TH CLUBAK 1 "2012-03-28" "1.6" "ClusterShell User Manual"
+.TH CLUBAK 1 "2015-11-05" "1.7" "ClusterShell User Manual"
 .SH NAME
 clubak \- format output from clush/pdsh-like output and more
 .
@@ -32,87 +32,74 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 ..
 .SH SYNOPSIS
 .sp
-\fCclubak\fP [ OPTIONS ]
+\fBclubak\fP [ OPTIONS ]
 .SH DESCRIPTION
 .sp
-\fCclubak\fP formats text from standard input containing lines of the form
-"\fInode:output\fP".  It is fully backward compatible with \fCdshbak\fP(1) but
-provides additonal features. For instance, \fCclubak\fP always displays
+\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
+provides additonal features. For instance, \fBclubak\fP always displays
 its results sorted by node/nodeset.
 .sp
-You do not need to use \fCclubak\fP when using \fCclush\fP(1) as all output
+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".
 .sp
-Like \fCclush\fP(1), \fCclubak\fP uses the \fIClusterShell.MsgTree\fP module of the
-ClusterShell library (see \fCpydoc ClusterShell.MsgTree\fP).
+Like \fBclush\fP(1), \fBclubak\fP uses the \fIClusterShell.MsgTree\fP module of the
+ClusterShell library (see \fBpydoc ClusterShell.MsgTree\fP).
 .SH INVOCATION
 .sp
-\fCclubak\fP should be started with connected standard input.
+\fBclubak\fP should be started with connected standard input.
 .SH OPTIONS
 .INDENT 0.0
 .TP
 .B \-\-version
-.
-show \fCclubak\fP version number and exit
+show \fBclubak\fP version number and exit
 .TP
-.B \-b,  \-c
-.
-gather nodes with same output (\-c is provided for \fCdshbak\fP(1)
+.B \-b\fP,\fB  \-c
+gather nodes with same output (\-c is provided for \fBdshbak\fP(1)
 compatibility)
 .TP
-.B \-d,  \-\-debug
-.
+.B \-d\fP,\fB  \-\-debug
 output more messages for debugging purpose
 .TP
 .B \-L
-.
 disable header block and order output by nodes
 .TP
-.B \-r,  \-\-regroup
-.
+.B \-r\fP,\fB  \-\-regroup
 fold nodeset using node groups
 .TP
-.BI \-s \ GROUPSOURCE, \ \-\-groupsource\fB= GROUPSOURCE
-.
-optional \fCgroups.conf\fP(5) group source to use
+.BI \-s \ GROUPSOURCE\fP,\fB \ \-\-groupsource\fB= GROUPSOURCE
+optional \fBgroups.conf\fP(5) group source to use
 .TP
-.B \-G,  \-\-groupbase
-.
+.B \-G\fP,\fB  \-\-groupbase
 do not display group source prefix (always \fI@groupname\fP)
 .TP
-.BI \-S \ SEPARATOR, \ \-\-separator\fB= SEPARATOR
-.
+.BI \-S \ SEPARATOR\fP,\fB \ \-\-separator\fB= SEPARATOR
 node / line content separator string (default: \fI:\fP)
 .TP
-.B \-F,  \-\-fast
-.
+.B \-F\fP,\fB  \-\-fast
 faster but memory hungry mode (preload all messages per node)
 .TP
-.B \-T,  \-\-tree
-.
-message tree trace mode; switch to enable \fCClusterShell.MsgTree\fP trace mode, all keys/nodes being kept for each message element of the tree, thus allowing special output gathering
+.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
-.
-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 \fCnever\fP, \fCalways\fP or \fCauto\fP (which use color if standard output refers to a terminal). Color is set to [34m (blue foreground text) and cannot be modified.
+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
-.
 show diff between gathered outputs
 .UNINDENT
 .SH EXIT STATUS
 .sp
-An exit status of zero indicates success of the \fCclubak\fP command.
+An exit status of zero indicates success of the \fBclubak\fP command.
 .SH EXAMPLES
 .INDENT 0.0
 .IP 1. 3
-.
-\fCclubak\fP can be used to gather some recorded \fCclush\fP(1) results:
+\fBclubak\fP can be used to gather some recorded \fBclush\fP(1) results:
 .UNINDENT
 .INDENT 0.0
 .TP
-.B Record \fCclush\fP(1) results in a file:
+.B Record \fBclush\fP(1) results in a file:
 .nf
 # clush \-w node[1\-7] uname \-r >/tmp/clush_output
 # clush \-w node[32\-159] uname \-r >>/tmp/clush_output
@@ -127,7 +114,6 @@ An exit status of zero indicates success of the \fCclubak\fP command.
 .UNINDENT
 .INDENT 0.0
 .IP 2. 3
-.
 Another example, iterate over \fInode*\fP text files in current directory and gather characters count for all of them:
 .INDENT 3.0
 .INDENT 3.5
@@ -142,18 +128,16 @@ node2: 9
 .UNINDENT
 .SH SEE ALSO
 .sp
-\fCclush\fP(1), \fCnodeset\fP(1), \fCgroups.conf\fP(5).
+\fBclush\fP(1), \fBnodeset\fP(1), \fBgroups.conf\fP(5).
 .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
 .UNINDENT
 .SH AUTHOR
-Stephane Thiell, CEA DAM  <[email protected]>
+Stephane Thiell <[email protected]>
 .SH COPYRIGHT
 CeCILL-C V1
 .\" Generated by docutils manpage writer.
-.\" 
 .

doc/man/man1/nodeset.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH NODESET 1 "2015-08-29" "1.7" "ClusterShell User Manual"
+.TH NODESET 1 "2015-11-05" "1.7" "ClusterShell User Manual"
 .SH NAME
 nodeset \- compute advanced nodeset operations
 .
@@ -123,6 +123,9 @@ hide group source prefix (always \fI@groupname\fP)
 separator string to use when expanding nodesets
 (default: \(aq \(aq)
 .TP
+.BI \-O \ FORMAT\fP,\fB \ \-\-output\-format\fB= FORMAT
+output format (default: \(aq%s\(aq)
+.TP
 .BI \-I \ SLICE_RANGESET\fP,\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
 .TP

doc/sphinx/conf.py

@@ -50,7 +50,7 @@
 # The short X.Y version.
 version = '1.7'
 # The full version, including alpha/beta/rc tags.
-release = '1.7-devel'
+release = '1.7'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/txt/clubak.txt

@@ -6,10 +6,10 @@
 format output from clush/pdsh-like output and more
 --------------------------------------------------
 
-:Author: Stephane Thiell, CEA DAM  <[email protected]>
-:Date:   2012-03-28
+:Author: Stephane Thiell <[email protected]>
+:Date:   2015-11-05
 :Copyright: CeCILL-C V1
-:Version: 1.6
+:Version: 1.7
 :Manual section: 1
 :Manual group: ClusterShell User Manual