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

mavschema.xsd: add superseded tag #809

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

hamishwillee
Copy link
Contributor

@hamishwillee hamishwillee commented May 4, 2023

This adds a superseded tag. Once this is in. my intent is to divide the existing deprecated tags into those that are actually deprecated by the standard (and we hope to remove) and those that are just superseded by a new message, command, enum that we hope one day everyone will upgrade too.

The difference being that superseded is as much a hint to autopilots as users that there is something that might we worth upgrading to.

This is a precondition to any kind of release process.

NOTE. I thought about adding deprecated, wip, superseded as possibilities for field values and param values. However I'm not sure this is useful. I.e. In one way it is - you can indicate that things are new - or not intended to be used with clear tagging. But you can't actually "remove" a field that is in common.xml if you add "deprecated" and you can add WIP but it's public ... so not sure. Assuming not for now.

@@ -202,7 +202,16 @@
</xs:complexType>
</xs:element>

<xs:element name="deprecated">
<xs:element name="wip">
Copy link
Contributor Author

Choose a reason for hiding this comment

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

FYI, just a reorder for wip and deprecate, which is what makes this a bit messier. Sorry.

@hamishwillee
Copy link
Contributor Author

@auturgy @peterbarker Can we get some movement on this? ONly a year and a half late ....

Plan is to move current deprecated to superseded unless they are "really" deprecated. I think that is a little less confusing.

@peterbarker
Copy link
Contributor

@hamishwillee could you provide some concrete examples on where this would be applied, please?

Is this part of a life-cycle of some description? So do things move from superseded to deprecated, for example?

Do we outline a life-cycle anywhere? That would be wip -> -> superseded -> deprecated -> removed, I think with this current proposal?

@hamishwillee
Copy link
Contributor Author

Hi @peterbarker

The intent here is to reduce confusion in the naming so that we can move towards a lifecycle. Currently we use the term deprecated to mean both:

  • superseded: there is a newer way of doing this same thing we'd like flight stacks to implement, and users to use instead of the older alternative. Does not mean that it is implemented or the old version is not in use.
  • deprecated: this is something you should not use because it is planned for removal.

So yes, the intent is to have a lifecycle. We don't outline the lifecycle because it is a mess.

Yes, my thinking was: wip -> "active" -> superseded -> deprecated -> removed.

  • Though something might be deprecated without being superseded.

It isn't perfect, because it doesn't help a user know whether anything can be used - i.e. I come to superseded, navigate to the new API and discover it isn't implemented anywhere. It does however help us know what we'd like flight stacks to be moving towards and deprecating.

Does that make sense?

@hamishwillee
Copy link
Contributor Author

hamishwillee commented Nov 26, 2024

could you provide some concrete examples on where this would be applied, please?

Initially I would move everything that is deprecated to superseded in one PR. Then we would discuss which are really deprecated.

I'd be doing some testing and propose.

But there is no point working out what can really be deprecated if there is no way of me marking it.

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