Add style guide documentation.

pull/3031/head
Jussi Pakkanen 7 years ago
parent 54d7817087
commit 0cc90ae234
  1. 36
      docs/markdown/Style-guide.md
  2. 1
      docs/sitemap.txt

@ -0,0 +1,36 @@
---
short-description: Style recommendations for Meson files
...
# Style recommendations
This page lists some recommendations on organizing and formatting your
Meson build files.
## Tabs or spaces?
Always spaces.
## Naming options
There are two ways of naming project options. As an example for
booleans the first one is `foo` and the second one is
`enable-foo`. The former style is recommended, because in Meson
options have strong type, rather than being just strings.
You should try to name options the same as is common in other
projects. This is especially important for yielding options, because
they require that both the parent and subproject options have the same
name.
# Global arguments
Prefer `add_project_arguments` to `add_global_arguments` because using
the latter prevents using the project as a subproject.
# Cross compilation arguments
Try to keep cross compilation arguments away from your build files as
much as possible. Keep them in the cross file instead. This adds
portability, since all changes needed to compile to a different
platform are isolated in one place.

@ -52,6 +52,7 @@ index.md
Project-templates.md
Reference-manual.md
Reference-tables.md
Style-Guide.md
FAQ.md
Reproducible-builds.md
howtox.md

Loading…
Cancel
Save