Skip to content

Docs: Add doc for shared cache #5129

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

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

Conversation

qwint
Copy link
Collaborator

@qwint qwint commented Jun 22, 2025

What is this fixing or adding?

adds doc file describing what the shared cache is, how to use it, and what you can currently expect in it

Note: includes the uuid cache in #5088 but since that is already approved for next release and this is just documentation I feel it's not actually blocked by that

How was this tested?

If this makes graphical changes, please attach screenshots.

@github-actions github-actions bot added is: documentation Improvements or additions to documentation. waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. labels Jun 22, 2025
@cjmang
Copy link

cjmang commented Jun 22, 2025

My only comment on this doc change is that to my knowledge, there is no Java library that obtains the relevant directories. I had thought that JNA might, but I'm not sure this is within its wheelhouse either.

So someone in Java (or some other language that doesn't have such a library) trying to follow this part of the documentation would have to dig into the exact implementation of a library that does follow spec, as the documentation here would be inadequate. And defacto AFAIK this is going to be platformdirs used by CommonClient.

@qwint
Copy link
Collaborator Author

qwint commented Jun 22, 2025

some quick searching led to com.sun.deploy.config.Config.getCacheDirectory() does that not do what is necessary here?

@cjmang
Copy link

cjmang commented Jun 22, 2025

Using anything in the sun namespace is sketchy. Java's been removing APIs from there pretty regularly over the last 6 years.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
is: documentation Improvements or additions to documentation. waiting-on: peer-review Issue/PR has not been reviewed by enough people yet.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants