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

Move module-info back to the main root? #484

Open
cpovirk opened this issue Feb 22, 2024 · 2 comments
Open

Move module-info back to the main root? #484

cpovirk opened this issue Feb 22, 2024 · 2 comments
Labels
dev development tasks, build issues...

Comments

@cpovirk
Copy link
Collaborator

cpovirk commented Feb 22, 2024

Currently, it's under the 9+ section of the mrjar. That's fine, but I wonder if we'd be better off getting modular-style Javadoc output, as we might if we moved it to the root? (Such output might either help or hurt people who are trying to link to us. Maybe it is part of the story with maxcellent/javadoc.io#182, but I haven't tried to understand that....)

@cpovirk
Copy link
Collaborator Author

cpovirk commented Feb 23, 2024

If the only reason to care is Javadoc, we might also be able to just run Javadoc differently.

My feeling has been that this isn't too important. But if it changes the URLs of our Javadoc output, then we might want to do it sooner rather than later (or decide to never do it, which may or may not be swimming upstream). Or we could insert our own redirects from the old locations to the new at any point.

@kevinb9n kevinb9n added the dev development tasks, build issues... label Mar 3, 2024
@cpovirk
Copy link
Collaborator Author

cpovirk commented Mar 8, 2024

I have discovered an extremely trivial reason to put module-info in the root: It makes --describe-module slightly easier to use (but kudos to it for the helpful error message!):

$ jar --describe-module --file j2objc-annotations-3.0.0.jar
releases: 9

No root module descriptor, specify --release

$ jar --describe-module --file j2objc-annotations-3.0.0.jar --release 9
releases: 9

com.google.j2objc.annotations@3.0.0 jar:file:///tmp/jobjc_release.SF8NzIp/j2objc/annotations/target/j2objc-annotations-3.0.0.jar/!META-INF/versions/9/module-info.class open
exports com.google.j2objc.annotations
requires java.base

Presumably the original command would Just Work if the module-info were in the root.

Anyway, I don't think that should have much effect on a decision here. I'm still not sure if either way is significantly better than the other.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev development tasks, build issues...
Projects
None yet
Development

No branches or pull requests

2 participants