aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Compiler-properties.md23
-rw-r--r--docs/markdown/Getting-meson.md2
-rw-r--r--docs/markdown/Gnome-module.md4
-rw-r--r--docs/markdown/Reference-manual.md12
-rw-r--r--docs/markdown/Reference-tables.md60
-rw-r--r--docs/markdown/Videos.md8
-rw-r--r--docs/markdown/index.md4
-rw-r--r--docs/sitemap.txt1
8 files changed, 81 insertions, 33 deletions
diff --git a/docs/markdown/Compiler-properties.md b/docs/markdown/Compiler-properties.md
index 5978b5d..06efff3 100644
--- a/docs/markdown/Compiler-properties.md
+++ b/docs/markdown/Compiler-properties.md
@@ -29,26 +29,9 @@ Compiler id
==
The compiler object has a method called `get_id`, which returns a
-lower case string describing the "family" of the compiler. It has one
-of the following values.
-
-| Value | Compiler family |
-| ----- | ---------------- |
-| gcc | The GNU Compiler Collection |
-| clang | The Clang compiler |
-| msvc | Microsoft Visual Studio |
-| intel | Intel compiler |
-| llvm | LLVM-based compiler (Swift, D) |
-| mono | Xamarin C# compiler |
-| dmd | D lang reference compiler |
-| rustc | Rust compiler |
-| valac | Vala compiler |
-| pathscale | The Pathscale Fortran compiler |
-| pgi | The Portland Fortran compiler |
-| sun | Sun Fortran compiler |
-| g95 | The G95 Fortran compiler |
-| open64 | The Open64 Fortran Compiler |
-| nagfor | The NAG Fortran compiler |
+lower case string describing the "family" of the compiler. See
+[reference tables](Reference-tables.md) for a list of supported
+compiler ids.
Does code compile?
==
diff --git a/docs/markdown/Getting-meson.md b/docs/markdown/Getting-meson.md
index d654ff3..8664d61 100644
--- a/docs/markdown/Getting-meson.md
+++ b/docs/markdown/Getting-meson.md
@@ -5,7 +5,7 @@
Meson releases can be downloaded from the [GitHub release page].
Meson is also available in the [Python Package Index] and can be
-installed with <tt>pip3 install meson</tt>.
+installed with `pip3 install meson`.
The newest development code can be obtained directly from [Git]
diff --git a/docs/markdown/Gnome-module.md b/docs/markdown/Gnome-module.md
index 3672761..99a9c8e 100644
--- a/docs/markdown/Gnome-module.md
+++ b/docs/markdown/Gnome-module.md
@@ -226,6 +226,7 @@ files and the second specifies the XML file name.
* `namespace`: namespace of the interface
* `object_manager`: *(Added 0.40.0)* if true generates object manager code
* `annotations`: *(Added 0.43.0)* list of lists of 3 strings for the annotation for `'ELEMENT', 'KEY', 'VALUE'`
+* `docbook`: *(Added 0.43.0)* prefix to generate `'PREFIX'-NAME.xml` docbooks
Returns an opaque object containing the source files. Add it to a top
level target's source list.
@@ -241,7 +242,8 @@ gdbus_src = gnome.gdbus_codegen('example-interface', 'com.example.Sample.xml',
namespace : 'Sample',
annotations : [
['com.example.Hello()', 'org.freedesktop.DBus.Deprecated', 'true']
- ]
+ ],
+ docbook : 'example-interface-doc'
)
```
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index 7c26d7c..2025ab5 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -1180,11 +1180,13 @@ the following methods.
Python](https://docs.python.org/3/library/os.path.html#os.path.join)
special-case absolute paths.
- `MESONINTROSPECT` contains the path to the `mesonintrospect`
- executable that corresponds to the `meson` executable that was used
- to configure the build. (This might be a different path then the
- first `mesonintrospect` executable found in `PATH`.) It can be used
- to query build configuration.
+ `MESONINTROSPECT` contains the path to the introspect command that
+ corresponds to the `meson` executable that was used to configure the
+ build. (This might be a different path then the first executable
+ found in `PATH`.) It can be used to query build configuration. Note
+ that the value may contain many parts, i.e. it may be `python3
+ /path/to/meson.py introspect`. The user is responsible for splitting
+ the string to an array if needed.
- `source_root()` returns a string with the absolute path to the
source root directory. Note: you should use the `files()` function
diff --git a/docs/markdown/Reference-tables.md b/docs/markdown/Reference-tables.md
new file mode 100644
index 0000000..b604fb6
--- /dev/null
+++ b/docs/markdown/Reference-tables.md
@@ -0,0 +1,60 @@
+# Reference tables
+
+## Compiler ids
+
+These are return values of the `get_id` method in a compiler object.
+
+| Value | Compiler family |
+| ----- | ---------------- |
+| gcc | The GNU Compiler Collection |
+| clang | The Clang compiler |
+| msvc | Microsoft Visual Studio |
+| intel | Intel compiler |
+| llvm | LLVM-based compiler (Swift, D) |
+| mono | Xamarin C# compiler |
+| dmd | D lang reference compiler |
+| rustc | Rust compiler |
+| valac | Vala compiler |
+| pathscale | The Pathscale Fortran compiler |
+| pgi | The Portland Fortran compiler |
+| sun | Sun Fortran compiler |
+| g95 | The G95 Fortran compiler |
+| open64 | The Open64 Fortran Compiler |
+| nagfor | The NAG Fortran compiler |
+
+## Script environment variables
+
+| Value | Comment |
+| ----- | ------- |
+| MESON_SOURCE_ROOT | Absolute path to the source dir |
+| MESON_BUILD_ROOT | Absolute path to the build dir |
+| 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. |
+| MESON_SUBDIR | Current subdirectory, only set for `run_command` |
+
+## 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 |
+| ----- | ------- |
+| x86 | 32 bit x86 processor |
+| x86_64 | 64 bit x86 processor |
+| arm | 32 bit ARM processor |
+
+Any cpu family not listed in the above list is not guaranteed to
+remain stable in future releases.
+
+## Operating system names
+
+These are provided by the `.system()` method call.
+
+| Value | Comment |
+| ----- | ------- |
+| linux | |
+| darwin | Either OSX or iOS |
+| windows | Any version of Windows |
+
+Any string not listed above is not guaranteed to remain stable in
+future releases. \ No newline at end of file
diff --git a/docs/markdown/Videos.md b/docs/markdown/Videos.md
index ab128c6..5abfbe4 100644
--- a/docs/markdown/Videos.md
+++ b/docs/markdown/Videos.md
@@ -9,7 +9,7 @@ short-description: Videos about Meson
(from Linux.conf.au 2015 -- Auckland, New Zealand)
<div class="video-container">
-<iframe width="854" height="480" src="https://www.youtube.com/embed/KPi0AuVpxLI" frameborder="0" allowfullscreen></iframe>
+<iframe width="854" height="480" style="border:0;" src="https://www.youtube.com/embed/KPi0AuVpxLI" allowfullscreen></iframe>
</div>
## Talks about design, goals behind Meson's multiplatform dependency system was held
@@ -17,7 +17,7 @@ short-description: Videos about Meson
(From Linux.conf.au 2016 -- Geelong, Australia)
<div class="video-container">
-<iframe width="854" height="480" src="https://www.youtube.com/embed/CTJtKtQ8R5k" frameborder="0" allowfullscreen></iframe>
+<iframe width="854" height="480" style="border:0;" src="https://www.youtube.com/embed/CTJtKtQ8R5k" allowfullscreen></iframe>
</div>
## Features and benefits of Meson's multiplatform support for building and dependencies]
@@ -25,7 +25,7 @@ short-description: Videos about Meson
(Libre Application Summit 2016 talk _New world, new tools_ explored further)
<div class="video-container">
-<iframe width="854" height="480" src="https://www.youtube.com/embed/0-gx1qU2pPo" frameborder="0" allowfullscreen></iframe>
+<iframe width="854" height="480" style="border:0;" src="https://www.youtube.com/embed/0-gx1qU2pPo" allowfullscreen></iframe>
</div>
## The first ever public presentation on Meson
@@ -33,5 +33,5 @@ short-description: Videos about Meson
(lightning talk at FOSDEM 2014)
<video width="854" height="480" controls>
- < <source src=http://mirror.onet.pl/pub/mirrors/video.fosdem.org/2014/H2215_Ferrer/Sunday/Introducing_the_Meson_build_system.webm>
+ <source src=http://mirror.onet.pl/pub/mirrors/video.fosdem.org/2014/H2215_Ferrer/Sunday/Introducing_the_Meson_build_system.webm>
</video>
diff --git a/docs/markdown/index.md b/docs/markdown/index.md
index 2aba0d7..81c17ff 100644
--- a/docs/markdown/index.md
+++ b/docs/markdown/index.md
@@ -24,10 +24,10 @@ The main design point of Meson is that every moment a developer spends writing o
There are two main methods of connecting with other Meson developers. The first one is the mailing list, which is hosted at [Google Groups](https://groups.google.com/forum/#!forum/mesonbuild).
-The second way is via IRC. The channel to use is <tt>#mesonbuild</tt> at [Freenode](https://freenode.net/).
+The second way is via IRC. The channel to use is `#mesonbuild` at [Freenode](https://freenode.net/).
## Development
-All development on Meson is done on [GitHub project](https://github.com/mesonbuild/meson). For further info look into the <tt>contributing.txt</tt> file that comes with Meson's source checkout.
+All development on Meson is done on [GitHub project](https://github.com/mesonbuild/meson). For further info look into the `contributing.txt` file that comes with Meson's source checkout.
You do not need to sign a CLA to contribute to Meson.
diff --git a/docs/sitemap.txt b/docs/sitemap.txt
index cb1570a..89dfdbd 100644
--- a/docs/sitemap.txt
+++ b/docs/sitemap.txt
@@ -48,6 +48,7 @@ index.md
Creating-OSX-packages.md
Creating-Linux-binaries.md
Reference-manual.md
+ Reference-tables.md
FAQ.md
Reproducible-builds.md
howtox.md
generated by cgit v1.1 at 2025-08-01 16:19:03 +0000