facebook/zstd

[Documentation] Clarify the variables that affect installation

Open

#3,146 opened on 2022年5月27日

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

説明

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.

コントリビューターガイド

技術スタック
cshell
領域
documentationbuild system
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
blocked
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Basic Makefile syntaxUnderstanding of DESTDIR variable
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
25
調査方針
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.