Commit Graph

15 Commits

Author SHA1 Message Date
Dmitry V. Levin db22551ed9 docs: fix a few grammar and formatting issues 2024-08-12 18:14:44 +03:00
Eli Schwartz f2112d0baa
Revert "Clarify mutable objects usage"
This reverts commit 9f02d0a3e5.

It turns out that this does introduce a behavioral change in existing
users of ConfigurationData, which it wasn't supposed to (it was supposed
to preserve behavior there, and add a new *warning* for
EnvironmentVariables).

This breaks projects such as pulseaudio, libvirt, and probably more.
Roll back the change and try again after 1.5.0 is released.

Fixes: #13372
2024-07-05 13:52:40 -04:00
Xavier Claessens 9f02d0a3e5 Clarify mutable objects usage
Only Environment and ConfigurationData are mutable. However, only
ConfigurationData becomes immutable after first use which is
inconsistent.

This deprecates modification after first use of Environment object and
clarify documentation.
2024-04-14 19:40:02 +03:00
Eli Schwartz 5851c133a0
docs: add some function linkification in code snippets
Let people easily find the documentation for concepts we are trying to
teach.
2022-07-14 00:01:39 -04:00
Eli Schwartz e06dd48ad2
docs: update various function references to be linkified 2022-06-29 20:33:35 -04:00
Jussi Pakkanen 474f4813c4 Capitalize "Meson" consistently as it is a proper name. [skip ci] 2021-01-31 19:49:20 +00:00
Jussi Pakkanen f72ee8e742 Rewrap long text lines in docs. [skip ci] 2021-01-30 16:19:59 +00:00
Xavier Claessens 38a6582145 configure_file: Support taking values from a dict
Closes #4218
2018-10-08 21:03:32 +03:00
Sander Sweers 38fa281448 Add new encoding keyword for configure_file to manual
Also add a section how to deal with file encodings.
2018-06-09 18:17:48 +00:00
Aleksey Filippov 5f5360470f Clarify that configuration_data()'s copy is immutable 2018-05-24 22:19:22 +03:00
Andrea G 030c39f33e Use the same name for the conf_data variable
Before, each example used a different variable name making them more difficult to understand for a novice.
2018-02-12 19:48:57 +05:30
Jussi Pakkanen f381284969 A full example for using the conf object. Closes #2235. 2017-08-22 23:08:44 +03:00
Jussi Pakkanen 3ff76f62a2 Clarify immutability description. Closes #2234. 2017-08-22 23:00:26 +03:00
Peter Hutterer 7ec6e6df20 docs: add a short description for all top pages in the Manual 2017-05-03 21:00:36 +10:00
Thibault Saunier b371875e02 docs: Import the website and wiki and build with hotdoc
This allows us to more easily have the documentation in sync with
the source code as people will have to document new features etc
right at the time where they implement it.
2017-04-26 17:56:33 +03:00