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

docs: fix frozen install help #1167

Merged
merged 3 commits into from
Apr 12, 2024

Conversation

ruben-arts
Copy link
Contributor

@ruben-arts ruben-arts commented Apr 11, 2024

Fixes #1165

Could you take a look? @Hofer-Julian

Copy link
Contributor

@Hofer-Julian Hofer-Julian left a comment

Choose a reason for hiding this comment

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

Same for the other changes :)


- `--manifest-path <MANIFEST_PATH>`: the path to [manifest file](configuration.md), by default it searches for one in the parent directories.
- `--frozen`: install the environment as defined in the lockfile. Without checking the status of the lockfile. It can also be controlled by the `PIXI_FROZEN` environment variable (example: `PIXI_FROZEN=true`).
- `--frozen`: install the environment as defined in the lockfile, doesn't abort when lockfile isn't up-to-date with the manifest file. It can also be controlled by the `PIXI_FROZEN` environment variable (example: `PIXI_FROZEN=true`).
Copy link
Contributor

Choose a reason for hiding this comment

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

It would only abort with --locked right?
Without any flags it would update the lockfile.
Maybe this makes more sense then?

Suggested change
- `--frozen`: install the environment as defined in the lockfile, doesn't abort when lockfile isn't up-to-date with the manifest file. It can also be controlled by the `PIXI_FROZEN` environment variable (example: `PIXI_FROZEN=true`).
- `--frozen`: install the environment as defined in the lockfile, doesn't update `pixi.lock` if it isn't up-to-date with `pixi.toml`. It can also be controlled by the `PIXI_FROZEN` environment variable (example: `PIXI_FROZEN=true`).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I changed it but not exactly the same way you suggest.

Copy link
Contributor

Choose a reason for hiding this comment

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

Your change looks good to me :)

@ruben-arts ruben-arts merged commit a3b3f14 into prefix-dev:main Apr 12, 2024
27 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.

Docs for --frozen differ between website and pixi install --help
3 participants