BF: CS-678 Incorrect format in qstat man page and manuals

ernst-bablick · ernst-bablick · commit 5977a08d83e9 · 2024-10-12T19:52:45.000+02:00
diff --git a/doc/markdown/man/man1/qstat.md b/doc/markdown/man/man1/qstat.md
@@ -160,8 +160,8 @@ Display information only on those jobs and queues being associated with the user
 status information is displayed if the `-f` or `-F` options are specified additionally and if the user runs jobs in 
 those queues.
 
-The string *$user* is a placeholder for the current username. An asterisk "\*" can be used as username wildcard to 
-request any user's jobs be displayed. The default value for this switch is `-u` *$user*.
+The string *$user* is a placeholder for the current username. An asterisk * can be used as username wildcard to 
+request any user's jobs be displayed. The default value for this switch is `-u $user`.
 
 ## -urg  
 Displays additional information for each job related to the job urgency policy scheme (see *OUTPUT FORMATS* below).
diff --git a/doc/markdown/manual/copyright.md b/doc/markdown/manual/copyright.md
@@ -1,4 +1,4 @@
 # Copyright
 
-Copyright: 2024 by xxx
+Copyright 2024 HPC-Gridware GmbH 
 
diff --git a/doc/markdown/manual/development-guide/01_prepare_dev_env.md b/doc/markdown/manual/development-guide/01_prepare_dev_env.md
@@ -224,3 +224,5 @@ git clone https://github.com/hpc-gridware/gcs-extensions
 git clone https://github.com/hpc-gridware/gcs-testsuite
 ```
 
+[//]: # (Eeach file has to end with two emty lines)
+
diff --git a/doc/markdown/manual/development-guide/02_build_configuration.md b/doc/markdown/manual/development-guide/02_build_configuration.md
@@ -173,3 +173,5 @@ Here we use *CLion* as example because it provides full integration with CMake t
 
 Next step is to build and install xxQS_NAMExx.
 
+[//]: # (Eeach file has to end with two emty lines)
+
diff --git a/doc/markdown/manual/development-guide/03_build_and_installation.md b/doc/markdown/manual/development-guide/03_build_and_installation.md
@@ -19,4 +19,7 @@ make install
 ```
 
 You can now either install the product (follow the instructions in the *Installation Guide*) or you can continue to 
-setup the automated test environment as described in the next chapter.
+setup the automated test environment as described in the next chapter.
+
+[//]: # (Eeach file has to end with two emty lines)
+
diff --git a/doc/markdown/manual/development-guide/04_automated_test_environmet.md b/doc/markdown/manual/development-guide/04_automated_test_environmet.md
@@ -4,4 +4,5 @@ xxQS_NAMExx comes with a TCL/Expect based test environment that allows to automa
 test framework can also be integrated in a CI/CD framework.
 
 TODO
+[//]: # (Eeach file has to end with two emty lines)
 
diff --git a/doc/markdown/manual/development-guide/05_simulating_hosts_and_execution.md b/doc/markdown/manual/development-guide/05_simulating_hosts_and_execution.md
@@ -99,4 +99,7 @@ By setting the execd_param SIMULATE_JOBS
 job execution by sge_execd / via sge_shepherd can be prevented.
 Instead, the job execution is just simulated.
 
-@todo add details
+@todo add details
+
+[//]: # (Eeach file has to end with two emty lines)
+
diff --git a/doc/markdown/manual/development-guide/25_scheduler_thread.md b/doc/markdown/manual/development-guide/25_scheduler_thread.md
@@ -297,3 +297,6 @@ In many clusters, especial when there is no external load,
 we can switch off a few potentially expensive features and just rely on scheduling by slots:
 * do not configure queue load_thresholds and suspend_thresholds
 * do not use load adjustments (in the scheduler config)
+
+[//]: # (Eeach file has to end with two emty lines)
+
diff --git a/doc/markdown/manual/installation-guide/01_planning_the_installation.md b/doc/markdown/manual/installation-guide/01_planning_the_installation.md
@@ -364,3 +364,5 @@ If this is your first time installing xxQS_NAMExx, we suggest a manual installat
 Automatic installation is recommended if you need to install or reinstall a cluster multiple times or if you plan 
 to install multiple clusters with slightly different settings.
 
+[//]: # (Eeach file has to end with two emty lines)
+
diff --git a/doc/markdown/manual/installation-guide/02_installation.md b/doc/markdown/manual/installation-guide/02_installation.md
@@ -617,4 +617,5 @@ Here are the steps required to complete the installation.
 
 ## Troubleshooting
 
+[//]: # (Eeach file has to end with two emty lines)
 
diff --git a/doc/markdown/manual/release-notes/01_license.md b/doc/markdown/manual/release-notes/01_license.md
@@ -1,3 +1,4 @@
 # License
 
+[//]: # (Eeach file has to end with two emty lines)
 
diff --git a/doc/markdown/manual/release-notes/02_os_matrix.md b/doc/markdown/manual/release-notes/02_os_matrix.md
@@ -3,41 +3,41 @@
 The following table shows the matrix of operating systems, versions and architectures on one axis and 
 xxQS_NAMExx components on the other axis. 
 
-| Operating System | Version | Architecture | Master and Shadow Service | Execution Service | Admin and Submit Clients |
-|:-----------------|:--------|:-------------|:-------------------------:|:-----------------:|:------------------------:|
-| macOS Sonoma     | 14      | ARM64        | a                         | a                 | x                        |
-| Rocky Linux      | 8       | ARM64        | x                         | x                 | x                        |
-| Rocky Linux      | 9       | ARM64        | x                         | x                 | x                        |
-| Raspbian Linux   | 11      | ARM64        | x                         | x                 | x                        |
-| Raspbian Linux   | 12      | ARM64        | x                         | x                 | x                        |
-|                  |         |              |                           |                   |                          |
-| Alma Linux       | 8       | ppc64le      | x                         | x                 | x                        |
-| Centos Linux     | 8       | ppc64le      | x                         | x                 | x                        |
-| Rocky Linux      | 8       | ppc64le      | x                         | x                 | x                        |
-|                  |         |              |                           |                   |                          |
-| SUSE Tumbleweed  |         | Risc-V64     | a                         | x                 | x                        |
-|                  |         |              |                           |                   |                          |
-| Alma Linux       | 8       | x86-64       | x                         | x                 | x                        |
-| Alma Linux       | 9       | x86-64       | x                         | x                 | x                        |
-| CentOS Linux     | 7       | x86-64       | x                         | x                 | x                        |
-| CentOS Linux     | 8       | x86-64       | x                         | x                 | x                        |
-| CentOS Linux     | 9       | x86-64       | x                         | x                 | x                        |
-| Free BSD         | 13      | x86-64       | a                         | x                 | x                        |
-| Free BSD         | 14      | x86-64       | a                         | x                 | x                        |
-| Redhat Linux     | 8       | x86-64       | x                         | x                 | x                        |
-| Redhat Linux     | 9       | x86-64       | x                         | x                 | x                        |
-| Rocky Linux      | 8       | x86-64       | x                         | x                 | x                        |
-| Rocky Linux      | 9       | x86-64       | x                         | x                 | x                        |
-| Solaris          | 11      | x86-64       | x                         | x                 | x                        |
-| SUSE Leap Linux  | 15      | x86-64       | x                         | x                 | x                        |
-| SUSE Tumbleweed  |         | x86-64       | a                         | x                 | x                        |
-| Ubuntu Linux     | 20.04   | x86-64       | x                         | x                 | x                        |
-| Ubuntu Linux     | 22.04   | x86-64       | x                         | x                 | x                        |
-| Ubuntu Linux     | 24.04   | x86-64       | x                         | x                 | x                        |
+| Operating System | Version | Architecture | Master/Shadow Service | Execution Service | Admin/Submit Clients |
+|:-----------------|:--------|:-------------|:---------------------:|:-----------------:|:--------------------:|
+| macOS            | 14      | ARM64        |           a           | a                 |          x           |
+| Rocky Linux      | 8       | ARM64        |           x           | x                 |          x           |
+| Rocky Linux      | 9       | ARM64        |           x           | x                 |          x           |
+| Raspbian Linux   | 11      | ARM64        |           x           | x                 |          x           |
+| Raspbian Linux   | 12      | ARM64        |           x           | x                 |          x           |
+|                  |         |              |                       |                   |                      |
+| Alma Linux       | 8       | ppc64le      |           x           | x                 |          x           |
+| Centos Linux     | 8       | ppc64le      |           x           | x                 |          x           |
+| Rocky Linux      | 8       | ppc64le      |           x           | x                 |          x           |
+|                  |         |              |                       |                   |                      |
+| SUSE Tumbleweed  |         | Risc-V64     |           a           | x                 |          x           |
+|                  |         |              |                       |                   |                      |
+| Alma Linux       | 8       | x86-64       |           x           | x                 |          x           |
+| Alma Linux       | 9       | x86-64       |           x           | x                 |          x           |
+| CentOS Linux     | 7       | x86-64       |           x           | x                 |          x           |
+| CentOS Linux     | 8       | x86-64       |           x           | x                 |          x           |
+| CentOS Linux     | 9       | x86-64       |           x           | x                 |          x           |
+| Free BSD         | 13      | x86-64       |           a           | x                 |          x           |
+| Free BSD         | 14      | x86-64       |           a           | x                 |          x           |
+| Redhat Linux     | 8       | x86-64       |           x           | x                 |          x           |
+| Redhat Linux     | 9       | x86-64       |           x           | x                 |          x           |
+| Rocky Linux      | 8       | x86-64       |           x           | x                 |          x           |
+| Rocky Linux      | 9       | x86-64       |           x           | x                 |          x           |
+| Solaris          | 11      | x86-64       |           x           | x                 |          x           |
+| SUSE Leap Linux  | 15      | x86-64       |           x           | x                 |          x           |
+| SUSE Tumbleweed  |         | x86-64       |           a           | x                 |          x           |
+| Ubuntu Linux     | 20.04   | x86-64       |           x           | x                 |          x           |
+| Ubuntu Linux     | 22.04   | x86-64       |           x           | x                 |          x           |
+| Ubuntu Linux     | 24.04   | x86-64       |           x           | x                 |          x           |
 
--: Unsupported  
-a: Available but still not supported  
-x: Supported  
+  -: Unsupported  
+  a: Available but still not supported  
+  x: Supported  
 
 > **Note**
 > 
@@ -46,3 +46,5 @@ x: Supported
 > older operating systems if the OS version has been supported in the past. Please contact our sales and support 
 > team for more information.
 
+[//]: # (Eeach file has to end with two emty lines)
+
diff --git a/doc/markdown/manual/release-notes/03_major_enhancements.md b/doc/markdown/manual/release-notes/03_major_enhancements.md
@@ -4,18 +4,19 @@
 
 ### Utilization of additional data stores and activation of new thread pools
 
-Beginning with patch v9.0.1 the new internal architecture of `sge_qmaster` is activated so that the component can
-utilize additional data stores by starting new thread pools.
+Starting with patch 9.0.1, the new internal architecture of `sge_qmaster` is enabled, allowing the component to use 
+additional data stores that can be utilized by pools of threads.
 
-* Listener thread pool: The listener thread pool was already activated in v9.0.0. It is used to handle incoming 
-  requests from clients and to distribute them to the corresponding processing components. Additionally, this pool
-  of threads utilizes a new data store to answer authentication requests. Beginning with v9.0.1 this data store
-  is used for even more requests to relieve other internal components within `sge_qmaster`.
+* Listener threads: The listener thread pool was already available in earlier versions of Grid Engine. Starting with 
+  version 9.0.0 of Cluster Scheduler, this pool received a dedicated datastore to forward incoming requests faster to 
+  the component that ultimately has to process the request. New in version 9.0.1 is that this datastore includes more 
+  information so that the listener threads themselves can directly answer certain requests without having to forward 
+  them. This reduces internal friction and makes the cluster more responsive even in high load situations.
 
-* Reader thread pool: The reader thread pool is activated and can now utilize a corresponding thread pool.
+* Reader thread pool: The reader thread pool is activated and can now utilize a corresponding data store.
   This will boost the performance of clusters in large environments where also users tend to request the status of the
   system very often, by using client commands like `qstat`, `qhost` or other commands that send read-only requests 
-  to `sge_qmaster`. The additional data store needs to be enabled manually by setting following qmaster parameter in the 
+  to `sge_qmaster`. The additional data store needs to be enabled manually by setting following parameter in the 
   *qmaster_params* of the cluster configuration:
 
   ```
@@ -40,7 +41,7 @@ utilize additional data stores by starting new thread pools.
   the accuracy of the data.
  
   With one of the upcoming patches we will introduce an addition concept of automatic-sessions that will allow to
-  synchronize the data stores more efficiently and so that client commands can be enforced to get the most recent data.
+  synchronize the data stores more efficiently so that client commands can be enforced to get the most recent data.
 
 * Enhanced monitoring: The monitoring of `sge_qmaster` has been enhanced to provide more detailed information about
   the utilization of the different thread pools. As also in the past the monitoring is enabled by setting the monitor 
@@ -58,17 +59,22 @@ utilize additional data stores by starting new thread pools.
   ``` 
   qping -i 1 -f  <master_host> $SGE_QMASTER_PORT qmaster 1
   ...
-  10/11/2024 12:54:53 | reader: runs: 261.04r/s (GDI (a:0.00,g:2871.45,m:0.00,d:0.00,c:0.00,t:0.00,p:0.00)/s 
-                                                 OTHER (ql:0)) 
-                                                 out: 261.04m/s APT: 0.0007s/m idle: 80.88% wait: 0.01% time: 9.99s
-  10/11/2024 12:54:53 | reader: runs: 279.50r/s (GDI (a:0.00,g:3074.50,m:0.00,d:0.00,c:0.00,t:0.00,p:0.00)/s 
-                                                 OTHER (ql:0)) 
-                                                 out: 279.50m/s APT: 0.0007s/m idle: 79.08% wait: 0.01% time: 10.00s
-  10/11/2024 12:54:53 | listener: runs: 268.65r/s (in (g:268.34 a:0.00 e:0.00 r:0.30)/s 
-                                                   GDI (g:0.00,t:0.00,p:0.00)/s) 
-                                                   out: 0.00m/s APT: 0.0001s/m idle: 98.42% wait: 0.00% time: 9.99s
-  10/11/2024 12:54:53 | listener: runs: 255.37r/s (in (g:255.37 a:0.00 e:0.00 r:0.00)/s GDI (g:0.00,t:0.00,p:0.00)/s) 
-                                                   out: 0.00m/s APT: 0.0001s/m idle: 98.54% wait: 0.00% time: 10.00s
+  10/11/2024 12:54:53 | reader: runs: 261.04r/s (
+     GDI (a:0.00,g:2871.45,m:0.00,d:0.00,c:0.00,t:0.00,p:0.00)/s 
+     OTHER (ql:0)) 
+     out: 261.04m/s APT: 0.0007s/m idle: 80.88% wait: 0.01% time: 9.99s
+  10/11/2024 12:54:53 | reader: runs: 279.50r/s (
+     GDI (a:0.00,g:3074.50,m:0.00,d:0.00,c:0.00,t:0.00,p:0.00)/s 
+     OTHER (ql:0)) 
+     out: 279.50m/s APT: 0.0007s/m idle: 79.08% wait: 0.01% time: 10.00s
+  10/11/2024 12:54:53 | listener: runs: 268.65r/s (
+     in (g:268.34 a:0.00 e:0.00 r:0.30)/s 
+     GDI (g:0.00,t:0.00,p:0.00)/s) 
+     out: 0.00m/s APT: 0.0001s/m idle: 98.42% wait: 0.00% time: 9.99s
+  10/11/2024 12:54:53 | listener: runs: 255.37r/s (
+     in (g:255.37 a:0.00 e:0.00 r:0.00)/s 
+     GDI (g:0.00,t:0.00,p:0.00)/s) 
+     out: 0.00m/s APT: 0.0001s/m idle: 98.54% wait: 0.00% time: 10.00s
   ```
 
 ## v9.0.0
@@ -313,3 +319,6 @@ The `-scope master -q qname` replaces the old `-masterq qname` option. The `-mas
 for backward compatibility, but it is recommended to use the new `-scope master` option.
 
 Resource requests per scope can also be modified by `qalter` and via JSV scripts.
+
+[//]: # (Eeach file has to end with two emty lines)
+
diff --git a/doc/markdown/manual/release-notes/04_full_list_of_fixes.md b/doc/markdown/manual/release-notes/04_full_list_of_fixes.md
@@ -1,6 +1,46 @@
 # Full List of Fixes
 
-## 9.0.0
+# v9.0.1beta
+
+### Improvement
+
+[CS-270](https://hpc-gridware.atlassian.net/browse/CS-270) Allow threads to handle RO-request in parallel
+
+### Task
+
+[CS-662](https://hpc-gridware.atlassian.net/browse/CS-662) verify delayed job reporting of sge\_execd after reconnecting to sge\_qmaster
+
+### Sub-task
+
+[CS-655](https://hpc-gridware.atlassian.net/browse/CS-655) Block requests for secondary DS until initialization is complete
+
+[CS-656](https://hpc-gridware.atlassian.net/browse/CS-656) Allow to enforce that execd requests will be handled with data from primary DS
+
+[CS-657](https://hpc-gridware.atlassian.net/browse/CS-657) Allow to configure the max reader delay
+
+[CS-658](https://hpc-gridware.atlassian.net/browse/CS-658) Allow to disable use of secondary DS
+
+[CS-659](https://hpc-gridware.atlassian.net/browse/CS-659) Increase the max  number of allowed listener/reader/worker threads
+
+[CS-667](https://hpc-gridware.atlassian.net/browse/CS-667) Disable the use of the reader DS unless automatic sessions are available
+
+[CS-675](https://hpc-gridware.atlassian.net/browse/CS-675) Enhance monitoring so that it can observe more than 256 threads
+
+### Bug
+
+[CS-145](https://hpc-gridware.atlassian.net/browse/CS-145) qping monitoring output is broken
+
+[CS-630](https://hpc-gridware.atlassian.net/browse/CS-630) several testsuite tests fail in environments where primary hostname is fully qualified
+
+[CS-663](https://hpc-gridware.atlassian.net/browse/CS-663) In a default installation on Google Cloud the hostname length is too long for commands
+
+[CS-665](https://hpc-gridware.atlassian.net/browse/CS-665) Potential core of qmaster \(in listener thread\) due to concurrent access to data
+
+[CS-674](https://hpc-gridware.atlassian.net/browse/CS-674) Monitoring show threads in W or E state, although they are working properly
+
+[CS-676](https://hpc-gridware.atlassian.net/browse/CS-676) Improve qmaster shutdown performance for scenarios where the master has more than 128 threads
+
+## v9.0.0
 
 ### Improvement
 
@@ -28,7 +68,7 @@
 
 [CS-653](https://hpc-gridware.atlassian.net/browse/CS-653) a tightly integrated parallel job running in a pe with job\_is\_first\_task = FALSE and with limits set might get killed erroneously
 
-## 9.0.0 RC4
+## v9.0.0 RC4
 
 ### Improvement
 
@@ -80,7 +120,7 @@
 
 [CS-627](https://hpc-gridware.atlassian.net/browse/CS-627) error during start of prolog/epilog/pe_start/pe_stop is interpreted as job error and not as queue error
 
-## 9.0.0 RC3
+## v9.0.0 RC3
 
 ### Improvement
 
@@ -124,7 +164,7 @@
 
 [CS-610](https://hpc-gridware.atlassian.net/browse/CS-610) leak within pthread call during shutdown of scheduler
 
-## 9.0.0 RC2
+## v9.0.0 RC2
 
 ### Improvement
 
@@ -138,7 +178,7 @@
 
 [CS-574](https://hpc-gridware.atlassian.net/browse/CS-574) information about job requests gets lost when restarting sge\_qmaster
 
-## 9.0.0 RC1
+## v9.0.0 RC1
 
 ### Improvement
 
@@ -148,7 +188,7 @@
 
 [CS-568](https://hpc-gridware.atlassian.net/browse/CS-568) make sure that qalter works correctly with the -scope switch
 
-## 9.0.0alpha1
+## v9.0.0alpha1
 
 ### Improvement
 
@@ -606,3 +646,5 @@
 
 [CS-561](https://hpc-gridware.atlassian.net/browse/CS-561) Resource requests cannot be reset to NONE via JSV
 
+[//]: # (Eeach file has to end with two emty lines)
+
diff --git a/doc/markdown/manual/release-notes/05_issues_and_limitations.md b/doc/markdown/manual/release-notes/05_issues_and_limitations.md
@@ -1,2 +1,4 @@
 # Known Issues and Limitations
 
+[//]: # (Eeach file has to end with two emty lines)
+
diff --git a/doc/markdown/manual/release-notes/06_upgrade_notes.md b/doc/markdown/manual/release-notes/06_upgrade_notes.md
@@ -1,2 +1,4 @@
 # Upgrade Notes
 
+[//]: # (Eeach file has to end with two emty lines)
+
diff --git a/doc/markdown/manual/release-notes/07_compatibility_notes.md b/doc/markdown/manual/release-notes/07_compatibility_notes.md
@@ -1,2 +1,4 @@
 # Compatibility Notes
 
+[//]: # (Eeach file has to end with two emty lines)
+

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`# Copyright`
`2`	`2`
`3`		`-Copyright: 2024 by xxx`
	`3`	`+Copyright 2024 HPC-Gridware GmbH`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -173,3 +173,5 @@ Here we use CLion as example because it provides full integration with CMake t`
`173`	`173`
`174`	`174`	`Next step is to build and install xxQS_NAMExx.`
`175`	`175`
	`176`	`+[//]: # (Eeach file has to end with two emty lines)`
	`177`	`+`
Original file line number	Diff line number	Diff line change
`@@ -4,4 +4,5 @@ xxQS_NAMExx comes with a TCL/Expect based test environment that allows to automa`
`4`	`4`	`test framework can also be integrated in a CI/CD framework.`
`5`	`5`
`6`	`6`	`TODO`
	`7`	`+[//]: # (Eeach file has to end with two emty lines)`
`7`	`8`
Original file line number	Diff line number	Diff line change
`@@ -617,4 +617,5 @@ Here are the steps required to complete the installation.`
`617`	`617`
`618`	`618`	`## Troubleshooting`
`619`	`619`
	`620`	`+[//]: # (Eeach file has to end with two emty lines)`
`620`	`621`