Virtualization
/
meson
mirror of https://gitlab.com/qemu-project/meson.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
meson/docs/markdown/Reference-tables.md

215 lines
8.5 KiB
Markdown
Raw Normal View History

Added a page for reference tables.
2017-09-17 00:16:00 +08:00
# Reference tables
## Compiler ids
Add new compiler.get_argument_syntax method Some compilers try very had to pretend they're another compiler (ICC pretends to be GCC and Linux and MacOS, and MSVC on windows), Clang behaves much like GCC, but now also has clang-cl, which behaves like MSVC. This method provides an easy way to determine whether testing for MSVC like arguments `/w1234` or gcc like arguments `-Wfoo` are likely to succeed, without having to check for dozens of compilers and the host operating system, (as you would otherwise have to do with ICC).
2018-10-17 01:03:13 +08:00
These are return values of the `get_id` (Compiler family) and
`get_argument_syntax` (Argument syntax) method in a compiler object.
docs/reference-table: Add intel-cl Because the Intel compiler behaves significantly differently on windows than it does on Linux and MacOS I've decided it would be better to follow the clang/clang-cl split and make id "intel-cl" on windows (leaving "intel" alone on Linux and Mac). Since we've never supported ICL and it hasn't worked in the past I think this is an okay change to make.
2019-05-11 04:56:04 +08:00
| Value | Compiler family | Argument syntax |
| ----- | --------------- | --------------- |
| arm | ARM compiler | |
| armclang | ARMCLANG compiler | |
| ccrx | Renesas RX Family C/C++ compiler | |
| clang | The Clang compiler | gcc |
| clang-cl | The Clang compiler (MSVC compatible driver) | msvc |
| dmd | D lang reference compiler | |
| flang | Flang Fortran compiler | |
| g95 | The G95 Fortran compiler | |
| gcc | The GNU Compiler Collection | gcc |
| intel | Intel compiler (Linux and Mac) | gcc |
| intel-cl | Intel compiler (Windows) | msvc |
| lcc | Elbrus C/C++/Fortran Compiler | |
| llvm | LLVM-based compiler (Swift, D) | |
| mono | Xamarin C# compiler | |
| msvc | Microsoft Visual Studio | msvc |
| nagfor | The NAG Fortran compiler | |
| open64 | The Open64 Fortran Compiler | |
| pathscale | The Pathscale Fortran compiler | |
| pgi | Portland PGI C/C++/Fortran compilers | |
| rustc | Rust compiler | |
| sun | Sun Fortran compiler | |
| valac | Vala compiler | |
Added a page for reference tables.
2017-09-17 00:16:00 +08:00
## Script environment variables
| Value | Comment |
| ----- | ------- |
| MESONINTROSPECT | Command to run to run the introspection command, may be of the form `python /path/to/meson introspect`, user is responsible for splitting the path if necessary. |
docs: Alphabetically sort reference table rows [skip ci]
2018-11-22 19:49:45 +08:00
| MESON_BUILD_ROOT | Absolute path to the build dir |
Add support for custom dist scripts.
2018-07-18 22:11:57 +08:00
| MESON_DIST_ROOT | Points to the root of the staging directory, only set when running `dist` scripts |
docs: Alphabetically sort reference table rows [skip ci]
2018-11-22 19:49:45 +08:00
| MESON_SOURCE_ROOT | Absolute path to the source dir |
| MESON_SUBDIR | Current subdirectory, only set for `run_command` |
Add support for custom dist scripts.
2018-07-18 22:11:57 +08:00
Added a page for reference tables.
2017-09-17 00:16:00 +08:00
## CPU families
These are returned by the `cpu_family` method of `build_machine`,
`host_machine` and `target_machine`. For cross compilation they are
set in the cross file.
| Value | Comment |
| ----- | ------- |
docs: Update cpu families (#3651) [skip ci] Add several archs to the CPU family table ppc64, ppc64le, Itanium,HP PA-RISC, sparc v9 (64 bit) This covers most of the sparc systems in use today.
2018-06-01 19:31:38 +08:00
| aarch64 | 64 bit ARM processor |
docs: Alphabetically sort reference table rows [skip ci]
2018-11-22 19:49:45 +08:00
| arc | 32 bit ARC processor |
| arm | 32 bit ARM processor |
| e2k | MCST Elbrus processor |
| ia64 | Itanium processor |
Validate cpu_family (#3753) * environment: validate cpu_family in cross file * run_unittests: add unittest to ensure CPU family list in docs and environment matches * run_unittests: skip compiler options test if not in a git repository * environment: validate the detected cpu_family * docs: add 32-bit PowerPC and 32/64-bit MIPS to CPU Families table Names gathered by booting Linux in Qemu and running: $ python3 import platform; platform.machine() Partial fix for #3751
2018-06-20 20:45:44 +08:00
| mips | 32 bit MIPS processor |
| mips64 | 64 bit MIPS processor |
docs: Alphabetically sort reference table rows [skip ci]
2018-11-22 19:49:45 +08:00
| parisc | HP PA-RISC processor |
Canonicalise 64-bit PowerPC CPU families to "ppc64" Instead of exposing the endianness in the CPU family, canonicalise the CPU family to just "ppc64" to match MIPS (which is also bi-endian). Part of the work for #3842.
2018-07-06 23:53:49 +08:00
| ppc | 32 bit PPC processors |
| ppc64 | 64 bit PPC processors |
mesonbuild: Recognise risc-v architecture Signed-off-by: Khem Raj <raj.khem@gmail.com>
2018-07-15 04:03:39 +08:00
| riscv32 | 32 bit RISC-V Open ISA|
| riscv64 | 64 bit RISC-V Open ISA|
Add Renesas RL78 CPU family. Closes #4606.
2018-12-11 07:14:41 +08:00
| rl78 | Renesas RL78 |
docs: Alphabetically sort reference table rows [skip ci]
2018-11-22 19:49:45 +08:00
| rx | Renesas RX 32 bit MCU |
| s390x | IBM zSystem s390x |
Add 32 bit sparc processor support. Closes #3901.
2018-08-01 00:14:54 +08:00
| sparc | 32 bit SPARC |
docs: Update cpu families (#3651) [skip ci] Add several archs to the CPU family table ppc64, ppc64le, Itanium,HP PA-RISC, sparc v9 (64 bit) This covers most of the sparc systems in use today.
2018-06-01 19:31:38 +08:00
| sparc64 | SPARC v9 processor |
docs: Alphabetically sort reference table rows [skip ci]
2018-11-22 19:49:45 +08:00
| x86 | 32 bit x86 processor |
| x86_64 | 64 bit x86 processor |
Added a page for reference tables.
2017-09-17 00:16:00 +08:00
Any cpu family not listed in the above list is not guaranteed to
remain stable in future releases.
docs: Add note to cpu_family table about endianess [skip ci] Autotools will add endianess to the name of the architecture in some cases (such as ppc64le vs ppc64) meson doesn't do this. It's worth noting this in the documentation.
2018-10-03 01:14:21 +08:00
Those porting from autotools should note that meson does not add
endianness to the name of the cpu_family. For example, autotools
will call little endian PPC64 "ppc64le", meson will not, you must
also check the `.endian()` value of the machine for this information.
Added a page for reference tables.
2017-09-17 00:16:00 +08:00
## Operating system names
These are provided by the `.system()` method call.
| Value | Comment |
| ----- | ------- |
docs: Add 'cygwin' to reference table for .system() This aligns this table with the set of values tested for by test case common/140
2017-11-17 20:58:05 +08:00
| cygwin | The Cygwin environment for Windows |
docs: Alphabetically sort reference table rows [skip ci]
2018-11-22 19:49:45 +08:00
| darwin | Either OSX or iOS |
docs: Add dragonfly BSD to OS reference table
2017-12-19 08:25:40 +08:00
| dragonfly | DragonFly BSD |
docs: Alphabetically sort reference table rows [skip ci]
2018-11-22 19:49:45 +08:00
| freebsd | FreeBSD and its derivatives |
Add gnu hurd to *_machine information
2018-10-09 05:24:59 +08:00
| gnu | GNU Hurd |
docs: Alphabetically sort reference table rows [skip ci]
2018-11-22 19:49:45 +08:00
| haiku | |
| linux | |
| netbsd | |
| windows | Any version of Windows |
Added a page for reference tables.
2017-09-17 00:16:00 +08:00
Any string not listed above is not guaranteed to remain stable in
docs: Add haiku to reference table
2017-11-21 08:59:21 +08:00
future releases.
[skip ci] docs: Add reference table for language args parameter names (#3126)
2018-02-25 20:02:34 +08:00
## Language arguments parameter names
These are the parameter names for passing language specific arguments to your build target.
docs: Add link args to the table of language args [skip ci]
2019-01-09 03:35:34 +08:00
| 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 |
Add method to check for C/C++ function attributes It's fairly common on Linux and *BSD platforms to check for these attributes existence, so it makes sense to me to have this checking build into meson itself. Autotools also has a builtin for handling these, and by building them in we can short circuit cases that we know that these don't exist (MSVC). Additionally this adds support for two common MSVC __declspec attributes, dllimport and dllexport. This implements the declspec version (even though GCC has an __attribute__ version that both it and clang support), since GCC and Clang support the MSVC version as well. Thus it seems reasonable to assume that most projects will use the __declspec version over teh __attribute__ version.
2017-09-30 02:52:06 +08:00
[skip ci] Document CFLAGS and friends in main docs Currently this is only partially documented in the quick-start guide, include this in the main docs and document all the environment argumens used.
2018-11-18 22:35:25 +08:00
## Compiler and linker flag environment variables
These environment variables will be used to modify the compiler and
linker flags.
docs: document that using environment variables is discouraged [skip ci]
2019-01-09 03:31:58 +08:00
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.
Format Compiler and linker flag table [skip ci]
2018-12-13 16:11:53 +08:00
| Name | Comment |
| ----- | ------- |
[skip ci] Document CFLAGS and friends in main docs Currently this is only partially documented in the quick-start guide, include this in the main docs and document all the environment argumens used.
2018-11-18 22:35:25 +08:00
| CFLAGS | Flags for the C compiler |
| CXXFLAGS | Flags for the C++ compiler |
| OBJCFLAGS | Flags for the Objective C compiler |
| FFLAGS | Flags for the Fortran compiler |
| DFLAGS | Flags for the D compiler |
| VALAFLAGS | Flags for the Vala compiler |
| RUSTFLAGS | Flags for the Rust compiler |
| LDFLAGS | The linker flags, used for all languages |
Add method to check for C/C++ function attributes It's fairly common on Linux and *BSD platforms to check for these attributes existence, so it makes sense to me to have this checking build into meson itself. Autotools also has a builtin for handling these, and by building them in we can short circuit cases that we know that these don't exist (MSVC). Additionally this adds support for two common MSVC __declspec attributes, dllimport and dllexport. This implements the declspec version (even though GCC has an __attribute__ version that both it and clang support), since GCC and Clang support the MSVC version as well. Thus it seems reasonable to assume that most projects will use the __declspec version over teh __attribute__ version.
2017-09-30 02:52:06 +08:00
## Function Attributes
These are the parameters names that are supported using
`compiler.has_function_attribute()` or
`compiler.get_supported_function_attributes()`
docs: Fix gcc attribute list link [skip ci]
2018-10-28 06:11:44 +08:00
### GCC `__attribute__`
Add method to check for C/C++ function attributes It's fairly common on Linux and *BSD platforms to check for these attributes existence, so it makes sense to me to have this checking build into meson itself. Autotools also has a builtin for handling these, and by building them in we can short circuit cases that we know that these don't exist (MSVC). Additionally this adds support for two common MSVC __declspec attributes, dllimport and dllexport. This implements the declspec version (even though GCC has an __attribute__ version that both it and clang support), since GCC and Clang support the MSVC version as well. Thus it seems reasonable to assume that most projects will use the __declspec version over teh __attribute__ version.
2017-09-30 02:52:06 +08:00
These values are supported using the GCC style `__attribute__` annotations,
which are supported by GCC, Clang, and other compilers.
| Name |
|----------------------|
| alias |
| aligned |
| alloc_size |
| always_inline |
| artificial |
| cold |
| const |
| constructor |
| constructor_priority |
| deprecated |
| destructor |
| error |
| externally_visible |
| fallthrough |
| flatten |
| format |
| format_arg |
| gnu_inline |
| hot |
| ifunc |
| malloc |
| noclone |
| noinline |
| nonnull |
| noreturn |
| nothrow |
| optimize |
| packed |
| pure |
| returns_nonnull |
| unused |
| used |
| visibility |
| warning |
| warn_unused_result |
| weak |
| weakreaf |
### MSVC __declspec
These values are supported using the MSVC style `__declspec` annotation,
which are supported by MSVC, GCC, Clang, and other compilers.
| Name |
|----------------------|
| dllexport |
| dllimport |
Add table for dependency method types. [skip ci]
2019-03-03 00:17:16 +08:00
## Dependency lookup methods
These are the values that can be passed to `dependency` function's
`method` keyword argument.
| Name | Comment |
| ----- | ------- |
| auto | Automatic method selection |
| pkg-config | Use Pkg-Config |
| cmake | Look up as a CMake module |
| config-tool | Use a custom dep tool such as `cups-config` |
| system | System provided (e.g. OpenGL) |
| extraframework | A macOS/iOS framework |