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

Rename --platform to --python-platform #3146

Merged
merged 1 commit into from
Apr 19, 2024
Merged

Conversation

charliermarsh
Copy link
Member

@charliermarsh charliermarsh commented Apr 19, 2024

Summary

--platform is a flag that exists in pip and it has a different meaning. (Not breaking as this hasn't been released yet anyway.)

@charliermarsh charliermarsh added the cli Related to the command line interface label Apr 19, 2024
@charliermarsh charliermarsh marked this pull request as ready for review April 19, 2024 22:02
@charliermarsh charliermarsh enabled auto-merge (squash) April 19, 2024 22:02
@charliermarsh charliermarsh force-pushed the charlie/python-platform branch 2 times, most recently from 910e01b to 397a74b Compare April 19, 2024 22:07
@charliermarsh charliermarsh force-pushed the charlie/python-platform branch from 397a74b to 434b89a Compare April 19, 2024 22:15
@charliermarsh charliermarsh merged commit 5e4e2fa into main Apr 19, 2024
38 checks passed
@charliermarsh charliermarsh deleted the charlie/python-platform branch April 19, 2024 22:24
zanieb pushed a commit that referenced this pull request Apr 23, 2024
<!--
Thank you for contributing to uv! To help us out with reviewing, please
consider the following:

- Does this pull request include a summary of the change? (See below.)
- Does this pull request include a descriptive title?
- Does this pull request include references to any relevant issues?
-->

## Summary

The option `--platform` for `uv pip compile` was added in #3111 and was
later renamed to `--python-platform` #3146.
This PR updates the documentation such that the listed option is working
again.

## Test Plan

```bash
❯ uv --version
uv 0.1.37 (645d039 2024-04-23)
```

Before:
```bash
❯ uv pip compile requirements.in --platform=linux
error: unexpected argument '--platform' found

  tip: to pass '--platform' as a value, use '-- --platform'

Usage: uv pip compile <SRC_FILE>...

For more information, try '--help'.
```

After:
```bash
❯ uv pip compile requirements.in --python-platform=linux
Resolved 1 package in 215ms
# This file was autogenerated by uv via the following command:
#    uv pip compile requirements.in --python-platform=linux
uv==0.1.37
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Related to the command line interface
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant