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

Inform about aliases in auditwheel repair --help #297

Merged
merged 1 commit into from
Mar 19, 2021

Conversation

mayeut
Copy link
Member

@mayeut mayeut commented Mar 6, 2021

e.g.

Legacy tags are still supported and alias the new PEP600 tags:
  - manylinux1_x86_64 is an alias for manylinux_2_5_x86_64
  - manylinux2010_x86_64 is an alias for manylinux_2_12_x86_64
  - manylinux2014_x86_64 is an alias for manylinux_2_17_x86_64

Full output for now is:

usage: auditwheel repair [-h]
                          [--plat {linux_x86_64,manylinux_2_5_x86_64,manylinux_2_12_x86_64,manylinux_2_17_x86_64,manylinux_2_24_x86_64,manylinux1_x86_64,manylinux2010_x86_64,manylinux2014_x86_64}]
                          [-L LIB_SDIR] [-w WHEEL_DIR] [--no-update-tags]
                          [--strip] [--only-plat]
                          WHEEL_FILE

Vendor in external shared library dependencies of a wheel.

positional arguments:
  WHEEL_FILE            Path to wheel file.

optional arguments:
  -h, --help            show this help message and exit
  --plat {linux_x86_64,manylinux_2_5_x86_64,manylinux_2_12_x86_64,manylinux_2_17_x86_64,manylinux_2_24_x86_64,manylinux1_x86_64,manylinux2010_x86_64,manylinux2014_x86_64}
                        Desired target platform. (default:
                        "manylinux_2_5_x86_64") Legacy tags are still
                        supported and alias the new PEP600 tags.
                        manylinux1_x86_64 is an alias for
                        manylinux_2_5_x86_64. manylinux2010_x86_64 is an alias
                        for manylinux_2_12_x86_64. manylinux2014_x86_64 is an
                        alias for manylinux_2_17_x86_64.
  -L LIB_SDIR, --lib-sdir LIB_SDIR
                        Subdirectory in packages to store copied libraries.
                        (default: ".libs")
  -w WHEEL_DIR, --wheel-dir WHEEL_DIR
                        Directory to store delocated wheels (default:
                        "wheelhouse/")
  --no-update-tags      Do not update the wheel filename tags and WHEEL info
                        to match the repaired platform tag.
  --strip               Strip symbols in the resulting wheel
  --only-plat           Do not check for higher policy compatibility

Legacy tags are still supported and alias the new PEP600 tags.
manylinux1_x86_64 is an alias for manylinux_2_5_x86_64. manylinux2010_x86_64
is an alias for manylinux_2_12_x86_64. manylinux2014_x86_64 is an alias for
manylinux_2_17_x86_64.

Formatting is messy.

@mayeut mayeut requested a review from lkollar March 6, 2021 14:03
@codecov
Copy link

codecov bot commented Mar 6, 2021

Codecov Report

Merging #297 (7260274) into master (baf4884) will increase coverage by 0.06%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #297      +/-   ##
==========================================
+ Coverage   91.00%   91.06%   +0.06%     
==========================================
  Files          20       20              
  Lines        1089     1097       +8     
  Branches      235      237       +2     
==========================================
+ Hits          991      999       +8     
  Misses         55       55              
  Partials       43       43              
Impacted Files Coverage Δ
auditwheel/main_repair.py 90.00% <100.00%> (+1.53%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update baf4884...7260274. Read the comment docs.

@lkollar
Copy link
Contributor

lkollar commented Mar 11, 2021

@mayeut What do you think about moving the entire list of valid platforms and the explanation about aliases to the bottom, outside of the --plat help? I find the list of platforms hard to read as a list as we have so many now.

Something like this:

...
--plat <platform>            See the available platforms under the PLATFORMS section below.
...

PLATFORMS
These are the possible target platform tags, as specified by PEP 600. 
Note that old, pre-PEP 600 tags are still usable and are aliased as listed below.

- linux_x86_64
- manylinux_2_5_x86_64 (aliased as manylinux1_x86_64)
...

@mayeut
Copy link
Member Author

mayeut commented Mar 12, 2021

This might be cleaner now:

usage: auditwheel repair [-h] [--plat PLATFORM] [-L LIB_SDIR] [-w WHEEL_DIR]
                         [--no-update-tags] [--strip] [--only-plat]
                         WHEEL_FILE

Vendor in external shared library dependencies of a wheel.

positional arguments:
  WHEEL_FILE            Path to wheel file.

optional arguments:
  -h, --help            show this help message and exit
  --plat PLATFORM       Desired target platform. See the available platforms
                        under the PLATFORMS section below. (default:
                        "manylinux_2_5_x86_64")
  -L LIB_SDIR, --lib-sdir LIB_SDIR
                        Subdirectory in packages to store copied libraries.
                        (default: ".libs")
  -w WHEEL_DIR, --wheel-dir WHEEL_DIR
                        Directory to store delocated wheels (default:
                        "wheelhouse/")
  --no-update-tags      Do not update the wheel filename tags and WHEEL info
                        to match the repaired platform tag.
  --strip               Strip symbols in the resulting wheel
  --only-plat           Do not check for higher policy compatibility

PLATFORMS:
These are the possible target platform tags, as specified by PEP 600.
Note that old, pre-PEP 600 tags are still usable and are listed as aliases
below.
- linux_x86_64
- manylinux_2_5_x86_64 (aliased by manylinux1_x86_64)
- manylinux_2_12_x86_64 (aliased by manylinux2010_x86_64)
- manylinux_2_17_x86_64 (aliased by manylinux2014_x86_64)
- manylinux_2_24_x86_64

@mayeut mayeut marked this pull request as ready for review March 19, 2021 07:20
e.g.
```
These are the possible target platform tags, as specified by PEP 600.
Note that old, pre-PEP 600 tags are still usable and are listed as aliases
below.
- linux_x86_64
- manylinux_2_5_x86_64 (aliased by manylinux1_x86_64)
- manylinux_2_12_x86_64 (aliased by manylinux2010_x86_64)
- manylinux_2_17_x86_64 (aliased by manylinux2014_x86_64)
- manylinux_2_24_x86_64
```
@mayeut mayeut merged commit 28964ef into pypa:master Mar 19, 2021
@mayeut mayeut deleted the legacy-policies branch March 19, 2021 07:49
@mayeut mayeut mentioned this pull request Apr 3, 2021
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