facebook/zstd

[Documentation] Clarify the variables that affect installation

Open

#3,146 opened on May 27, 2022

View on GitHub
 (6 comments) (0 reactions) (1 assignee)C (27,100 stars) (2,481 forks)batch import
Install issuesdocumentationhelp wanted

Description

Describe the bug The Makefile is very unclear about the destination directory.

To Reproduce Extract the tarball and run "make" and then "make install" seems to try to create files in the system directories.

Expected behavior There should be a DESTDIR target or a configure script or perhaps even some autotools/automake/autoconf input that allows a configure script to exist.

Desktop (please complete the following information): Red Hat Enterprise Linux 6 with gcc 12.1.0 and no CFLAGS other than -std=iso9899:2011 -fno-builtin -g -O0 -m64

Build system is whatever you provide in the tarball. The Makefile.

Software that is compiled and then tested with some testsuite should be optionally installed into a non-system directory.

I see a DESTDIR here :

https://github.com/facebook/zstd/blob/9a5e73c74ef2d621992154306ab1ab6ba44ac8fa/lib/Makefile#L259

However that is not in the main Makefile.

Contributor guide

Tech stack
cshell
Domain
documentationbuild system
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Makefile syntaxUnderstanding of DESTDIR variable
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Examine the main Makefile (https://github.com/facebook/zstd/blob/dev/Makefile) and the lib/Makefile (https://github.com/facebook/zstd/blob/dev/lib/Makefile). Understand how DESTDIR is currently used in lib/Makefile and why it is missing from the main Makefile. Consult comments from maintainers to see if any direction was given. Then add documentation in the main Makefile's help or install target to clarify the variables affecting installation.