Makefile documentation could be clearer #3603
Description
| Bugzilla Link | 3231 |
| Resolution | WONTFIX |
| Resolved on | Nov 23, 2016 05:23 |
| Version | unspecified |
| OS | All |
| Reporter | LLVM Bugzilla Contributor |
| CC | @RKSimon |
Extended Description
In Makefile.config.in, it says "there are several locations that need to be defined", but it's unclear as to whether these a) need to be defined by the user, b) need to be defined by the configuration script, or c) are defined by this file.
In Makefile.common, it says that you can define "Sources", however Makefile.rules overwrites the definition of Sources. It seems as though you want to set SOURCES.
In Makefile.common, it says you can define "SourceDir", however that variable appears nowhere in the LLVM source tree other than in that comment.
In Makefile.common, the distinction between LLVM_SRC_ROOT and PROJ_SRC_ROOT is not really clear, mainly because it doesn't really define what a "project" is. (I'm assuming it's a subproject.)
In Makefile.common, the following text is unclear as to what is meant:
For building,
LLVM, LLVM_SRC_ROOT = PROJ_SRC_ROOT
It could be read as "if you want to build, then you should set these", or "when building, these will be set."