Detect generating into output from a different nunavut or support version (all languages)

Open
#413 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
32/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
cpp, python

Research direction

Start by reading the design discussion for #403, especially condition C6, and trace how Nunavut records generator and support versions for C, C++, and Python outputs. Identify the output-directory generation entry points and tests for each target language. Done means generation detects only unambiguous version differences, emits a warning with an option to treat it as an error, and has coverage across all target languages.

Written by the indexing model from the issue text.

Description

feature under consideration

Summary

Nunavut doesn't notice when it generates into an output directory holding files from a different nunavut version (or a different support-library version). The output directory then mixes code from two generator versions. Nothing reports it at generation time, in any language.

Today

Language What's recorded What's checked
C // Generator: nunavut-<version> comment in each header Nothing
C++ Generator version and Support Version comments in each header Nothing
Python nunavut_support.API_VERSION in the support module Each generated module checks the support major API version when imported, at runtime, not at generation time

nunavut_support.py (and the C/C++ support headers) are rewritten by every run, so a newer run can update the support code under modules generated by an older one.

Proposal

Make "this output directory contains output from a different nunavut or support version" a detectable condition at generation time, consistently for every target language:

  • Record the generator and support versions in a form nunavut can read back. That could be per generated file, or wherever #403's namespace manifest ends up.
  • When generating into an output directory with a different recorded version, emit a warning. Make it available as an error too (for example via an option) for builds that want to refuse.

Detection should follow the rule being adopted for #403: report a condition only when it can be determined unambiguously from what nunavut itself recorded.

Context

This came out of the design discussion for #403 (condition C6). It was decided there that a version difference is not a conflict for #403's append-only namespace merging, and that this enhancement doesn't block #403.

Dominant language
Python
Stars
48
Forks
26
Avg merge
1d 18h
Merged PRs (30d)
9

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OpenCyphal/nunavut

All issues in OpenCyphal/nunavut

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.