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

What version(s), exactly? #1116

Open
ndw opened this issue Nov 2, 2024 · 3 comments · May be fixed by #1121
Open

What version(s), exactly? #1116

ndw opened this issue Nov 2, 2024 · 3 comments · May be fixed by #1121

Comments

@ndw
Copy link
Contributor

ndw commented Nov 2, 2024

The section Versioning Considerations in the 3.1 specification is a hot mess. It still very explicitly says "3.0" which either needs to change or be clarified. Also, we say:

XProc 3.0 takes a draconian approach to versioning. It is a static error (err:XS0060) if the processor encounters an explicit request for a version of the language other than “3.0”.

What are we doing about that? I think we could say:

  1. 3.1 doesn't change the version of pipeline documents, it's a minor revision, you must still use "3.0"
  2. Or we could say that "3.1" is allowed
  3. Or we could say that "3.1" is required.

I don't think option 3 is a good idea. I could live with 1 or 2. I'd want to make it implementation defined, however, if a 3.1 processor must handle 3.0 pipelines in some backwards compatible way (using the old, 3.0 library declarations for example). I'm not eager to do that.

@xatapult
Copy link
Contributor

xatapult commented Nov 2, 2024

From a consistency perspective, option 3 would be the best! Why isn't that a good idea? Because its hard to implement? I can understand that it's a nuisance to create an XProc processor that must support both...

I think we should at least allow 3.1, so option 2. Whether (if we don't do option 3) version="3.0" actually does 3.1 could be implementation defined, yes. Still, it will be confusing.

@ndw
Copy link
Contributor Author

ndw commented Nov 2, 2024

There are only a very few, small changes between 3.0 and 3.1. I don't think you're suggesting that a 3.1 processor should reject, out of hand, any pipeline labeled 3.0. So you must be suggesting that a 3.1 processor should also handle 3.0 pipelines. But then we need to define rules for what it means if a 3.0 pipeline imports a 3.1 step, and vice versa. It's impractical to have different declarations in scope for steps in a 3.0 pipeline vs steps in a 3.1 pipeline. It's not impossible but it is absolutely not worth the (significant, IMHO) effort that would be required.

I think it's easier to say that a 3.1 processor may load 3.0 pipelines and then pretend they were labeled 3.1. But if you're going to do that, would it be better to just leave them all labeled "3.0"?

@ndw
Copy link
Contributor Author

ndw commented Dec 7, 2024

How about this:

An XProc 3.1 processor must accept pipelines labeled with version "3.1". It may but is not required to reject pipelines labeled "3.0". If it accepts pipelines labeled "3.0", it must process them as if they were labeled "3.1".

This:

  1. Allows users to run pipelines labeled 3.0 without being forced to update the version
  2. Assures that 3.1 implementations will treat pipelines labeled "3.0" in a consistent way.

Is it possible to construct a 3.0 pipeline that won't work correctly in 3.1 with these rules? Perhaps, but we have good reason to believe that no implementation will ever reveal this.

@ndw ndw linked a pull request Dec 14, 2024 that will close this issue
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 a pull request may close this issue.

2 participants