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.

Sign up for GitHub

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

Wrap the macOS override path in quotes to prevent splitting #399

Closed
wants to merge 1 commit into from
Closed

Wrap the macOS override path in quotes to prevent splitting #399

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion versioned_docs/version-latest/how-to-guides/increasing-open-file-limit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ First, use lima override.yaml to write the provisioning scripts.
<TabItem value="macOS">

```
~/Library/Application Support/rancher-desktop/lima/_config/override.yaml
"~/Library/Application Support/rancher-desktop/lima/_config/override.yaml"
Copy link
Member

Choose a reason for hiding this comment

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

For shell compatibility the ~ must be outside the quotes, otherwise it won't get expanded:

Suggested change
"~/Library/Application Support/rancher-desktop/lima/_config/override.yaml"
~"/Library/Application Support/rancher-desktop/lima/_config/override.yaml"

Alternative:

Suggested change
"~/Library/Application Support/rancher-desktop/lima/_config/override.yaml"
"$HOME/Library/Application Support/rancher-desktop/lima/_config/override.yaml"

Note that there are several other reference that should be changed too then:

$ grep -r "~/Library/Application Support" *
how-to-guides/increasing-open-file-limit.md:~/Library/Application Support/rancher-desktop/lima/_config/override.yaml
how-to-guides/provisioning-scripts.md:~/Library/Application Support/rancher-desktop/lima/_config/override.yaml
references/rdctl-command-reference.md:- macOS: ~/Library/Application Support/rancher-desktop/
tutorials/working-with-webassembly.md:- macOS: `~/Library/Application Support/rancher-desktop/containerd-shims`
ui/snapshots.md:- macOS: `~/Library/Application Support/rancher-desktop/snapshots`

And the $HOME variant is also used in one place:

$ grep -r "HOME/Library/Application Support" *
how-to-guides/mirror-private-registry.md:`$HOME/Library/Application Support/rancher-desktop/lima/_config/override.yaml`

They should probably all use the same format.

The docs are also duplicated in several places, so to keep the change propagating forward it needs to be updated in the docs/ tree as well. And for consistency versioned_docs/version-1.16/ should match versioned_docs/version-latest.

Let me know if you want me to update your PR instead, as this is just busy-work.

Copy link
Author

Choose a reason for hiding this comment

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

D'oh, I totally should have caught the tilde outside of the double quotes.

If you have the bandwidth and/or are working on docs anyway, please feel free to close this PR and address as you see fit. This was more a "whoops, I just created a new file at ~/Library/Application and wanted to help prevent anyone else from making the same mistake 😅

Copy link
Member

Choose a reason for hiding this comment

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

I've created #400 to replace this PR. I decided to add a backslash before the space instead of quoting just part of the string.

I'm going to close this PR; thank you for bringing the issue to our attention!

```

</TabItem>
Expand Down