← Back to issue list

docs: document autotools disable-parallel key

View original Github issue

Metadata

Project
craft-parts
Number
#1631
Type
pull request
State
open
Author
GreyViperTooth
Labels
—
Created
Updated
Closed
—

Current evaluation

Docs-only PR adding the autotools `disable-parallel` key and a parallel-build note plus a changelog entry to the Autotools plugin reference. Approved by one reviewer but 2 unresolved comments remain; author agreed to revert the "How it works" line and awaits maintainer guidance; 3 CI checks failing.

Suggested action: needs review

Reason: The change is small (+22/-1, docs only) and the Autotools reference genuinely lacks the `disable-parallel` key and the `make -j{parallel_build_count}` behavior seen in craft_parts/plugins/autotools_plugin.py:133, so it addresses craft-parts#1603. However the review status is "approved (1 reviewers)" with 2 unresolved comments: bepri asked for the "How it works" line to be reverted to `#. Call ``make`` to build.`` and the author said "agreed, I'll revert" (not yet pushed), and the placement question to @jahn-junior is still unanswered ("how would you like me to proceed?"). Three checks are also red (test-common / Minimum dependencies, test-java-plugins on noble-s390x-edge and 24.04) which, even if likely unrelated flakes for a docs change, need a maintainer triage. Hence ready for maintainer review rather than immediate merge.

Evaluated by: mr-cal-bot

Impact: 32 Quick Win: 15 Complexity: 12 Confidence: 78 Actionability: 52

Issue body

The [Autotools plugin reference](https://documentation.ubuntu.com/craft-parts/en/latest/common/craft-parts/reference/plugins/autotools_plugin/) didn't mention that the plugin builds in parallel, nor did it document the `disable-parallel` key, even though the option is supported by the plugin. This PR documents both: - Adds a `disable-parallel` key entry under **Keys** (type boolean, default `false`), explaining that the plugin runs `make` with `-j` set to `CRAFT_PARALLEL_BUILD_COUNT` by default, and that setting the key to `true` forces a serial build for projects whose build system isn't parallel-safe. - Updates the **How it works** section so the `make` step notes the parallel behavior and the opt-out. - Adds a changelog entry under the Unreleased section. Docs only — no functional changes. Fixes #1603

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 32
Quick Win: 15
Complexity: 12
Confidence: 78
Actionability: 52
needs review Docs-only PR adding the autotools `disable-parallel` key and a parallel-build note plus a changelog entry to the Autotools plugin reference. Approved by one reviewer but 2 unresolved comments remain; author agreed to revert the "How it works" line and awaits maintainer guidance; 3 CI checks failing.
stealth/space-bunny-alpha
Impact: 25
Quick Win: 11
Complexity: 10
Confidence: 93
Actionability: 50
needs review Open docs update for the Autotools disable-parallel key and parallel make behavior, including a changelog entry; approved, but two review comments remain unresolved and three CI jobs are failing.
qwen/qwen3.6-35b-a3b
Impact: 20
Quick Win: 17
Staleness: 25
Complexity: 15
Confidence: 75
needs review Documentation PR adding disable-parallel key docs for autotools plugin. Approved by 1 reviewer but has 2 unresolved comments and failing CI checks.
qwen/qwen3.6-35b-a3b
Impact: 25
Quick Win: 22
Staleness: 10
Complexity: 10
Confidence: 85
needs review Documents the autotools plugin's disable-parallel key and parallel build behavior. Approved by 1 reviewer with 2 unresolved comments; CI passing.
qwen3.6-35b-a3b-mtp-q6
Impact: 15
Quick Win: 14
Staleness: 20
Complexity: 5
Confidence: 85
needs review Documents the disable-parallel key for the Autotools plugin and updates build behavior notes. Approved by one reviewer with 2 unresolved comments, CI passing.
qwen/qwen3.6-35b-a3b
Staleness: 45
Complexity: 10
Confidence: 85
needs review Documents the disable-parallel key for the Autotools plugin, updates build behavior notes, and adds a changelog entry. Currently approved by one reviewer with two unresolved comments, and CI is passing.
qwen/qwen3.6-35b-a3b
Staleness: 10
Complexity: 5
Confidence: 85
needs review Documents the disable-parallel key for the Autotools plugin and updates related build steps. Approved by one reviewer but has 5 unresolved comments and a failing OSV-scanner check.
qwen3.6-35b-a3b-mtp-q6
Staleness: 5
Complexity: 5
Confidence: 90
needs review Documents the disable-parallel key for the Autotools plugin, explaining its boolean type, default value, and usage for serial builds. Updates plugin reference and changelog. Docs-only change. Awaiting review.

Update history

Date Change
updated
updated
updated
updated

Related work

  • Likely Fixed By: craft-parts#1603 (confidence 92%)

    The PR body states "Fixes #1603"; that issue is the docs gap for the autotools disable-parallel key and remains open.

Related issues

Issue Project State Summary Similarity
#1603 docs: for the autotools plugin relevant flags are not described, e.g. disable_parallel craft-parts open Docs gap: the Autotools plugin reference does not document the disable-parallel part property or its effect on make -j. Triaged; fix PR #1631 is open with unresolved review comments and failing CI.
84%
#1167 feat: add parallel parameter to autotools plugin craft-parts merged Merged #1167 as commit 7dfd1bf7, adding disable_parallel to the Autotools plugin so builds can omit make -j and addressing #1069.
74%
#1608994 Need a way to disable parallel building per part snapcraft (launchpad) closed Per-part parallel-build control was added by merged PR #698 (commit b7fc3eb66), which introduced the disable-parallel plugin property; the autotools plugin later gained it (commit 634d72466), documented in the 8.13 release notes.
73%
#1242 make plugin: Support `disable-parallel` parameter craft-parts open Enhancement: make plugin should honor the disable-parallel part property (currently always emits make -j"N"). Filed by a maintainer, labeled Triaged/Enhancement, and explicitly deferred as "extremely low priority" until a real-world non-parallel-build use case is supplied; autotools already has it via PR #1167.
72%
#357 Support parallel builds (enabled by default). snapcraft merged Merged PR #357 (commit 35cd5ca2c, merge 1a62686da) adding parallel build support, enabled by default in autotools/cmake/make plugins, plus a --no-parallel-build option. Resolves LP: #1551417.
70%