From 1404f404f804ddd9d892e813ed23ca222c16ad39 Mon Sep 17 00:00:00 2001 From: Dylan Baker Date: Tue, 8 Jan 2019 11:31:58 -0800 Subject: docs: document that using environment variables is discouraged [skip ci] --- docs/markdown/Reference-tables.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/markdown/Reference-tables.md') diff --git a/docs/markdown/Reference-tables.md b/docs/markdown/Reference-tables.md index fa913f5..fd25111 100644 --- a/docs/markdown/Reference-tables.md +++ b/docs/markdown/Reference-tables.md @@ -117,6 +117,12 @@ These are the parameter names for passing language specific arguments to your bu These environment variables will be used to modify the compiler and linker flags. +It is recommended that you **do not use these**. They are provided purely to +for backwards compatibility with other build systems. There are many caveats to +their use, especially when rebuilding the project. It is **highly** recommended +that you use [the command line arguments](#language-arguments-parameters-names) +instead. + | Name | Comment | | ----- | ------- | | CFLAGS | Flags for the C compiler | -- cgit v1.1 From c1b01d54c2418d9dc29fa1c3779be04ea74c2834 Mon Sep 17 00:00:00 2001 From: Dylan Baker Date: Tue, 8 Jan 2019 11:35:34 -0800 Subject: docs: Add link args to the table of language args [skip ci] --- docs/markdown/Reference-tables.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'docs/markdown/Reference-tables.md') diff --git a/docs/markdown/Reference-tables.md b/docs/markdown/Reference-tables.md index fd25111..9688bf8 100644 --- a/docs/markdown/Reference-tables.md +++ b/docs/markdown/Reference-tables.md @@ -99,18 +99,18 @@ future releases. These are the parameter names for passing language specific arguments to your build target. -| Language | Parameter name | -| ----- | ----- | -| C | c_args | -| C++ | cpp_args | -| C# | cs_args | -| D | d_args | -| Fortran | fortran_args | -| Java | java_args | -| Objective C | objc_args | -| Objective C++ | objcpp_args | -| Rust | rust_args | -| Vala | vala_args | +| Language | compiler name | linker name | +| ------------- | ------------- | ----------------- | +| C | c_args | c_link_args | +| C++ | cpp_args | cpp_link_args | +| C# | cs_args | cs_link_args | +| D | d_args | d_link_args | +| Fortran | fortran_args | fortran_link_args | +| Java | java_args | java_link_args | +| Objective C | objc_args | objc_link_args | +| Objective C++ | objcpp_args | objcpp_link_args | +| Rust | rust_args | rust_link_args | +| Vala | vala_args | vala_link_args | ## Compiler and linker flag environment variables -- cgit v1.1