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

Windows installation notes #241

Merged
merged 1 commit into from
Apr 24, 2024

Conversation

mitchcapper
Copy link
Contributor

Per #237 notes about Windows platform support for the install docs. Assuming this is what was desired will add additional docs to --allowed-modules and update apple/pkl-jvm-examples#9 . apple/pkl-jvm-examples#9 is mostly not related to Windows, just likely Windows users may run into issues around its usage.

I am not sure what items other than allowed-modules may specifically have path related issues or if there is a better place to discuss Windows paths in more detail.

I have not found a way to sparse-checkout (cone or no-cone) or ignore the two invalid window path areas:

  • pkl-doc/src/test/files/DocGeneratorTest/output/*
  • pkl-core/src/test/files/LanguageSnippetTests/input-helper/globtest/*

Copy link
Contributor

@holzensp holzensp left a comment

Choose a reason for hiding this comment

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

I like it, but wanted to suggest some more compact wording. I think we should avoid spreading timeline promises through the technical documentation; that's bound to be overlooked in future.

docs/modules/pkl-cli/pages/index.adoc Outdated Show resolved Hide resolved
> java -jar pkl-cli-java.jar eval ../Code/pkl/test.pkl
> java -jar pkl-cli-java.jar eval pkl/test.pkl
----
For more details on the current status of Windows support please see https://github.com/apple/pkl/issues/20[GitHub Issue #20].
Copy link
Contributor

Choose a reason for hiding this comment

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

https://github.com/apple/pkl/issues/20[GitHub Issue #20] is used to track progress on support for the Windows platform.

@holzensp
Copy link
Contributor

@mitchcapper had you had a chance to take a look at the comments?

@mitchcapper
Copy link
Contributor Author

Sorry for the delay was trying to figure out where I had the checkout. Should be good to go.

Copy link
Contributor

@holzensp holzensp left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for the submission and the polish!

@holzensp holzensp merged commit 583dfc6 into apple:main Apr 24, 2024
6 checks passed
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.

None yet

2 participants