PBR

PBR setup.cfg metadata conflicts with setuptools metadata

Bug #1743951 reported by cmcginty
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
PBR
Confirmed
Medium
Unassigned

Bug Description

At some point PBR and setuptools started supporting the same fields in setup.cfg, but the keys are not the same. Since PBR is an extension of setuptools, it makes sense that PBR should not break the builtin fields supported by setuptools.

Some example is:

      setuptools vs PBR
"description" | "summary"
"long_description" | "description-file" or "description"

It also would be nice if you document the combined setuptools and PBR fields to make it easier to implement a fully working PBR-styled setup.cfg. I imagine most users do not understand there are additional fields that can be added in setup.cfg since they are not documented on the PBR user guide.

For example "long_description_content_type" works in both setuptools and PBR, but is never documented in PBR.

cmcginty (casey-mcginty)
summary: - PBR setup.cfg metadata conflicts with setuptools defines
+ PBR setup.cfg metadata conflicts with setuptools metadata
cmcginty (casey-mcginty)
description: updated
Revision history for this message
Jan Vlčinský (jan-vlcinsky) wrote :

Note, that "description-file" differs from "long_description" in that "description-file" is name of a file to read the description from in contrast to content itself in "long_description".

Ben Nemec (bnemec)
Changed in pbr:
status: New → Confirmed
importance: Undecided → Medium
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.