Merge pull request #1791 from c-ewing/c-ewing-clarify-check-cpu

servantftransperfect · web-flow · commit b4515cf6dc8a · 2024-12-23T09:32:09.000+01:00
Clarify check-cpu.sh documentation
diff --git a/docker/check-cpu.sh b/docker/check-cpu.sh
@@ -1,7 +1,7 @@
 #!/bin/sh
 
 # This script is used to check the amount of available memory to ensure 2 GB of memory per process.
-# If the number of processes is greater than the amount of available memory (considering 2 GB per core) we restrict the number of cores to use.
+# If the number of processes is greater than the amount of available memory (considering 2 GB per core) we restrict the number of parallel make jobs to avoid resource contention. 
 #
 # Sample usage:
 # CPU_CORES=`check-cpu.sh`

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`#!/bin/sh`
`2`	`2`
`3`	`3`	`# This script is used to check the amount of available memory to ensure 2 GB of memory per process.`
`4`		`-# If the number of processes is greater than the amount of available memory (considering 2 GB per core) we restrict the number of cores to use.`
	`4`	`+# If the number of processes is greater than the amount of available memory (considering 2 GB per core) we restrict the number of parallel make jobs to avoid resource contention.`
`5`	`5`	`#`
`6`	`6`	`# Sample usage:`
`7`	`7`	# CPU_CORES=`check-cpu.sh`