Merge branch 'release-0.1.2'

Author: pkovacs

CMakeLists.txt

@@ -26,7 +26,7 @@ cmake_policy(VERSION 3.4.0)
 cmake_minimum_required(VERSION 3.4.0 FATAL_ERROR)
 
 project(slurm-redis
-    VERSION 0.1.1
+    VERSION 0.1.2
     DESCRIPTION "Redis plugins for slurm"
     HOMEPAGE_URL "https://github.com/pkovacs/slurm-redis"
     LANGUAGES C)

NEWS

@@ -1,5 +1,10 @@
 This file provides a summary of changes in the releases of slurm-redis
 
+Changes in v0.1.2
+=================
+-- release for slurm-19.05.3
+-- patches for slurm-18 will no longer be released
+
 Changes in v0.1.1
 =================
 -- ensure only one redis ping occurs when already connected

README.md

@@ -30,7 +30,7 @@ Two methods are provided for building this package from source:
 1. A patch set that applies patches directly over the slurm source tree and
 2. The slurm-redis native build system which uses [cmake](https://cmake.org/)
 
-The patch set method is perhaps easier as it does not require that you have the cmake build system installed.  The plugins were developed using the cmake build system, however, and using that method allows you to configure and build these plugins independently from a working slurm installation.  All compile-time options are available in either case.
+The patch set method is perhaps easier to use as it does not require the cmake build system. The plugins were developed with cmake, however, and using cmake allows you to configure and build the slurm-redis plugins separately from slurm source tree.  All compile-time options are available in either case.
 
 These are the additional software requirements to run slurm-redis:
 
@@ -51,24 +51,24 @@ $ tar -xjf slurm-19.05.2.tar.bz2
 $ bunzip2 slurm-redis-0.1.0-slurm-19.05.patch.bz2
 $ cd slurm-19.05.2
 $ patch -p1 < ../slurm-redis-0.1.0-slurm-19.05.patch
-patching file configure.ac
-...
+# patching file configure.ac
+# ...
 # Re-run autoreconf (or autogen.sh on 18.08) to apply build system changes
 ./autoreconf
 # Configure slurm as you normally would, noting these additional options:
 ./configure --help # See section "Advanced configuration"
-...
-  --with-jcr-cache-size=N set jobcomp/redis cache size [128]
-  --with-jcr-cache-ttl=N  set jobcomp/redis cache ttl [120]
-  --with-jcr-fetch-count=N
-                          set jobcomp/redis fetch count [500]
-  --with-jcr-fetch-limit=N
-                          set jobcomp/redis fetch limit [1000]
-  --with-jcr-query-ttl=N  set jobcomp/redis query ttl [60]
-  --with-jcr-ttl=N        set jobcomp/redis ttl: -1=permanent [-1]
-  --with-jcr-tmf=N        set jobcomp/redis date/time format: 0=unix epoch,
-                          1=iso8601 [1]
-...
+#  ...
+#  --with-jcr-cache-size=N set jobcomp/redis cache size [128]
+#  --with-jcr-cache-ttl=N  set jobcomp/redis cache ttl [120]
+#  --with-jcr-fetch-count=N
+#                          set jobcomp/redis fetch count [500]
+#  --with-jcr-fetch-limit=N
+#                          set jobcomp/redis fetch limit [1000]
+#  --with-jcr-query-ttl=N  set jobcomp/redis query ttl [60]
+#  --with-jcr-ttl=N        set jobcomp/redis ttl: -1=permanent [-1]
+#  --with-jcr-tmf=N        set jobcomp/redis date/time format: 0=unix epoch,
+#                          1=iso8601 [1]
+#  ...
 ```
 ___
 

generate_patch

@@ -30,6 +30,20 @@
 # without the need for a separate build system (cmake)
 #
 
+#
+# Usage: generate_patch is not meant to be run directly -- use `make patch`
+#        from the cmake build directory. Make sure the slurm source tree is
+#        git clean (if using git) or a fresh tar unpack from slurm source
+#
+# Example:
+#
+# $ cd slurm-redis
+# $ mkdir build
+# $ cd build
+# $ cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_INCLUDE_PATH=/home/phil/slurm/ ..
+# $ make patch
+#
+
 sed_configure_ac()
 {
 echo '\

slurm/jobcomp/jobcomp_redis.c

@@ -189,7 +189,7 @@ int fini(void)
 /*
  * Slurm is sending us the location string from the JobCompLoc config key.
  *
- * We interpret that value as a prefix to be prepending onto redis keys.
+ * We interpret that value as a prefix to be prepended to redis keys.
  * If no location is used, redis job keys will be of the form "job:<id>".
  * If a location prefix is used, keys will of the form "<prefix>:job:<id>".
  * All keys, including the transient query and match keys will also use