Uploaded image for project: 'RHEL Documentation'
  1. RHEL Documentation
  2. RHELDOCS-19470

Semantic problem in the BuildRequires directive explanation of the "An example SPEC file for a program written in Python" section of the "Packaging and distributing software" documentation

XMLWordPrintable

    • None
    • None
    • False
    • False
    • Hide

      None

      Show
      None
    • None
    • Red Hat Enterprise Linux
    • None
    • None
    • Unspecified
    • Unspecified
    • Unspecified

      Document link: <https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html-single/packaging_and_distributing_software/index#an-example-spec-file-for-a-program-written-in-python-rhel9_working-with-spec-files>

      Section number and name: 4.5.4. An example SPEC file for a program written in Python

      Describe the issue:

      In bullet point 3. of this section:

      In BuildRequires, always include items providing tools necessary for building Python packages: python3-devel (or python3.11-devel or python3.12-devel) and the relevant projects needed by the specific software that you package, for example, python3-setuptools (or python3.11-setuptools or python3.12-setuptools) or the runtime and testing dependencies needed to run the tests in the %check section.

      The "projects" term usage doesn't seem accurate IMO.

      Impact of this issue: Documentation consumers may be confused by the term.

      Suggestions for improvement: In this context, it should probably be replaced with one of the following terms:

      • packages
      • software
      • dependencies
      • components

              mpershin@redhat.com Mariya Pershina
              lin-buo-ren ๆž—ๅšไป Buo-ren Lin (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: