Skip to content

Rename the mock switch of the example PDI_EXAMPLE_USE_MOCK_PDI - #868

Merged
jbigot merged 1 commit into
mainfrom
example_mock_pdi
Nov 4, 2026
Merged

jbigot merged 1 commit into
mainfrom
example_mock_pdi

Conversation

@jbigot

@jbigot jbigot commented Oct 18, 2026

Copy link
Copy Markdown
Member

DISABLE_PDI is a very generic a name for a cache variable: any project that adds the example, the distribution among them, may own a variable of that name. The switch that builds the example against the mock PDI is renamed PDI_EXAMPLE_USE_MOCK_PDI, after the project it belongs to, and the documentation that uses it as the model of a SubdirMock setup follows.

Fix #785

List of things to check before making a PR

Before merging your code, please check the following:

  • you have added a line describing your changes to the Changelog;
  • you have checked your code format:
    • you have checked that you respect all conventions specified in CONTRIBUTING.md;
  • you have correctly updated the copyright headers:
    • your institution is in the copyright header of every file you (substantially) modified;
    • you have checked that the end-year of the copyright there is the current one;
  • you have updated the AUTHORS file:
    • you have added yourself to the AUTHORS file;
    • if this is a new contribution, you have added it to the AUTHORS file;
  • you have added everything to the user documentation:
    • any other new or changed user-facing feature;
  • you have correctly linked your PR to one or more issues:
    • your PR solves an identified issue;
    • your commit contain the Fix #issue keyword to autoclose the issue when merged.

@jbigot
jbigot requested a review from a team October 18, 2026 13:27
@jbigot
jbigot force-pushed the example_mock_pdi branch 2 times, most recently from 5bc0b66 to cd98cb2 Compare October 18, 2026 13:29

@jmorice91 jmorice91 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest a little change in the variable name to improve the understanding and the reusing of the users.

When we are agree with the new name, this PR is ready to ship.

Comment thread pdi/docs/Using_PDI.md Resolved
@Yushan-Wang
Yushan-Wang force-pushed the example_mock_pdi branch 4 times, most recently from d8d9414 to 2a25543 Compare November 3, 2026 09:50
@jbigot
jbigot requested a review from jmorice91 November 3, 2026 10:53
@jbigot
jbigot force-pushed the example_mock_pdi branch 3 times, most recently from bc7bf51 to 946bfb2 Compare November 4, 2026 09:16
DISABLE_PDI is a very generic a name for a cache variable: any project that
adds the example, the distribution among them, may own a variable of that name.
The switch that builds the example against the mock PDI is renamed
PDI_EXAMPLE_USE_MOCK_PDI, after the project it belongs to, and the
documentation that uses it as the model of a SubdirMock setup follows.

Fix #785
@jbigot
jbigot merged commit 804f866 into main Nov 4, 2026
1 check passed
@jbigot
jbigot deleted the example_mock_pdi branch November 4, 2026 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

A DISABLE_PDI variable of a project that adds the example silently builds the example against the mock PDI

3 participants