Skip to content

[v6.0.x] docs: document bindings generator auto-regeneration behavior#14188

Open
ompi-backport-bot[bot] wants to merge 1 commit into
v6.0.xfrom
backport/pr-14184-to-v6.0.x
Open

[v6.0.x] docs: document bindings generator auto-regeneration behavior#14188
ompi-backport-bot[bot] wants to merge 1 commit into
v6.0.xfrom
backport/pr-14184-to-v6.0.x

Conversation

@ompi-backport-bot

Copy link
Copy Markdown

Backport of #14184 to v6.0.x.


Commit 726e66e added automatic regeneration of generated bindings when the Python bindings generator is modified. This commit documents that behavior for developers.

Updates to AGENTS.md explain that:

  • Generated bindings automatically regenerate when generator files are edited; no manual deletion or regeneration is needed
  • When adding or removing generator files, developers must update OMPI_BINDINGS_GENERATOR in Makefile.ompi-rules and EXTRA_DIST in ompi/mpi/Makefile.am to maintain proper dependency tracking
  • Makefile.ompi-rules is a special include file requiring only "make", not full autogen.pl + ./configure

Updates to docs/developers/building-open-mpi.rst add a new "Working on the Bindings Generator" subsection with similar guidance, including an important admonition block highlighting the requirement to update both Makefile.ompi-rules and EXTRA_DIST when modifying the generator's file structure.

Commit 726e66e added automatic regeneration of generated bindings
when the Python bindings generator is modified. This commit documents
that behavior for developers.

Updates to AGENTS.md explain that:
- Generated bindings automatically regenerate when generator files
  are edited; no manual deletion or regeneration is needed
- When adding or removing generator files, developers must update
  OMPI_BINDINGS_GENERATOR in Makefile.ompi-rules and EXTRA_DIST in
  ompi/mpi/Makefile.am to maintain proper dependency tracking
- Makefile.ompi-rules is a special include file requiring only
  "make", not full autogen.pl + ./configure

Updates to docs/developers/building-open-mpi.rst add a new
"Working on the Bindings Generator" subsection with similar guidance,
including an important admonition block highlighting the requirement
to update both Makefile.ompi-rules and EXTRA_DIST when modifying
the generator's file structure.

Signed-off-by: Howard Pritchard <howardp@lanl.gov>
(cherry picked from commit 2f533af)
@ompi-backport-bot ompi-backport-bot Bot added the target:v6.0.x Backport targeting the v6.0.x branch label Jul 20, 2026
@github-actions github-actions Bot added this to the v6.0.0 milestone Jul 20, 2026
@hppritcha
hppritcha requested a review from jsquyres July 21, 2026 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Target: v6.0.x target:v6.0.x Backport targeting the v6.0.x branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants