Skip to content

build instructions are missing from release tarballs #4783

@gdt

Description

@gdt

AI usage

No AI!

Example of problem

Build instructions are missing from the release tarballs. Look for docs/source/install.rst and notice that it is not present.

Problem description

Instructions for building from source are needed by precisely those with source code. The instructions need to correspond to the source version, as dependencies, build systems, etc. change over time. They should be available to those with the sources and without internet access.

Expected Output

The file that explains what dependencies are needed and how to build from source is tin the source code release tarballs.

Environment Information

  • proj 9.8.1
  • NetBSD 10 amd64, but this is about the tar file contents.

Suggested fix

One option is to move the list of dependencies and build commands to BUILDING.rst at top level in git, and have it be in the tarball, and have the last section of install.rst be a super brief pointer to BUILDING.rst with a note that for older versions one should consult docs/source/install.rst in git.

Another would be to include install.rst in the tarball. All of docs is currently excluded.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions