Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Depracated action tracking #1160

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Conversation

gtribello
Copy link
Member

Description

This PR adds a facility where you can note that an action should no longer be used by adding the command:

setDeprecated("LESS_THAN");

In the registerKeywords method of an action. The deprecated actions are then tracked in the syntax.json file. By putting this information in that file this way we can note eggs and lessons that are using actions that we have moved on from at some stage in the future.

The first commit in this sequence fixes a regtest that appears to be broken on master. I am not sure where this regtest came from.

Target release

I would like my code to appear in release 2.11

Type of contribution
  • changes to code or doc authored by PLUMED developers, or additions of code in the core or within the default modules
  • changes to a module not authored by you
  • new module contribution or edit of a module authored by you
Copyright
  • I agree to transfer the copyright of the code I have written to the PLUMED developers or to the author of the code I am modifying.
  • the module I added or modified contains a COPYRIGHT file with the correct license information. Code should be released under an open source license. I also used the command cd src && ./header.sh mymodulename in order to make sure the headers of the module are correct.
Tests
  • I added a new regtest or modified an existing regtest to validate my changes.
  • I verified that all regtests are passed successfully on GitHub Actions.

Gareth Aneurin Tribello added 2 commits November 26, 2024 17:04
I think this regtest was maybe migrated across from version 2.9.  It can't pass
if you run it in plumed 2.10 unless you make these changes.
// This is used for noting actions that have been deprecated
std::string replacement = keys.getReplacementAction();
if( replacement!="none" ) {
bool found=false;

Check notice

Code scanning / CodeQL

Declaration hides variable Note

Variable found hides another variable of the same name (on
line 117
).
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.

2 participants