Merge 1efe75b into 47695ac

LeonarddeR · web-flow · commit deb3b7bb5e2c · 2024-08-01T17:57:25.000Z
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -48,13 +48,13 @@ repos:
   hooks:
     - id: scons-source
       name: build c/c++ files
-      entry: cmd.exe /c "scons source -j 0"
+      entry: cmd.exe /c "scons source --all-cores"
       language: system
       pass_filenames: false
       types_or: [c, c++]
     - id: checkPot
       name: translation string check
-      entry: cmd.exe /c "scons checkPot -j 0"
+      entry: cmd.exe /c "scons checkPot --all-cores"
       language: system
       pass_filenames: false
       types: [python]
diff --git a/projectDocs/dev/buildingNVDA.md b/projectDocs/dev/buildingNVDA.md
@@ -18,6 +18,12 @@ scons source user_docs
 
 While simply testing or committing changes, it may be faster usually just doing `scons source` as user documentation will change each time the revision number changes.
 
+You can speed up scons calls by appending the `--all-cores` parameter to the call, however note that output will be scrambled:
+
+```cmd
+scons source --all-cores
+```
+
 ## Running the Source Code
 It is possible to run NVDA directly from source without having to build the full binary package and launcher.
 To launch NVDA from source, using `cmd.exe`, execute `runnvda.bat` in the root of the repository.
diff --git a/sconstruct b/sconstruct
@@ -159,19 +159,28 @@ env = Environment(
 # speed up subsequent runs by checking timestamps of targets and dependencies, and only using md5 if timestamps differ.
 env.Decider("MD5-timestamp")
 
+AddOption(
+	"--all-cores",
+	action="store_true",
+	dest="all_cores",
+	default=False,
+	help="always use the maximum number of available processor cores",
+)
 # Warn to run the build on multiple threads so it runs faster
-numJobs = env.GetOption("num_jobs")
 numCores = multiprocessing.cpu_count()
-if numJobs == 0:
-	numJobs = numCores
-	env.SetOption("num_jobs", numJobs)
-if numJobs < numCores:
-	print(
-		f"Warning: Building with {numJobs} concurrent job{'s' if numJobs != 1 else ''} "
+if (allCores := GetOption("all_cores")):
+	SetOption("num_jobs", numCores)
+if (numJobs := GetOption("num_jobs")) < numCores:
+	msg = "Warning: "
+	if allCores:
+		msg += "Providing both the '--all-cores' and '-j'/'--num-jobs' parameters is not supported. "
+	msg += (
+		f"Building with {numJobs} concurrent job{'s' if numJobs != 1 else ''} "
 		f"while {numCores} CPU threads are available. "
 		f"Running SCONS with the parameter '-j{numCores}' may lead to a faster build. "
-		"Running SCONS with parameter '-j0' will automatically pick all available cores. "
+		"Running SCONS with parameter '--all-cores' will automatically pick all available cores."
 	)
+	print(msg)
 else:
 	print(f"Building with {numJobs} concurrent jobs")
 
diff --git a/user_docs/en/changes.md b/user_docs/en/changes.md
@@ -45,7 +45,7 @@ Please refer to [the developer guide](https://www.nvaccess.org/files/nvda/docume
   * Dictionary metadata can be added to an optional `symbolDictionaries` section in the add-on manifest.
   * Please consult the [Custom speech symbol dictionaries section in the developer guide](https://www.nvaccess.org/files/nvda/documentation/developerGuide.html#AddonSymbolDictionaries) for more details.
 * It is now possible to redirect objects retrieved from on-screen coordinates, by using the `NVDAObject.objectFromPointRedirect` method. (#16788, @Emil-18)
-* Running SCons with the parameter `-j0` will automatically pick the maximum number of available CPU cores. (#16868, @LeonarddeR)
+* Running SCons with the parameter `--all-cores` will automatically pick the maximum number of available CPU cores. (#16868, @LeonarddeR)
 
 #### Deprecations
 
