Fix typos in docs

pull/10942/head
Elliott Sales de Andrade 2 years ago committed by Jussi Pakkanen
parent b98356e055
commit fa2585d0b3
  1. 2
      docs/extensions/refman_links.py
  2. 4
      docs/markdown/Creating-OSX-packages.md
  3. 4
      docs/markdown/Dependencies.md
  4. 2
      docs/markdown/Generating-sources.md
  5. 2
      docs/markdown/GuiTutorial.md
  6. 2
      docs/markdown/Release-notes-for-0.57.0.md
  7. 2
      docs/markdown/Release-notes-for-0.62.0.md
  8. 2
      docs/markdown/Release-notes-for-0.63.0.md
  9. 2
      docs/markdown/Unit-tests.md
  10. 2
      docs/markdown/Yaml-RefMan.md
  11. 2
      docs/markdown/_include_qt_base.md
  12. 2
      docs/markdown/snippets/conf_pager.md
  13. 2
      docs/refman/generatormd.py
  14. 4
      docs/refman/jsonschema.py
  15. 4
      docs/refman/loaderbase.py
  16. 2
      docs/refman/templates/args.mustache
  17. 2
      docs/refman/templates/root.mustache
  18. 4
      docs/yaml/builtins/meson.yaml
  19. 2
      docs/yaml/elementary/str.yml
  20. 2
      docs/yaml/functions/_build_target_base.yaml
  21. 2
      docs/yaml/functions/configuration_data.yaml
  22. 2
      docs/yaml/functions/custom_target.yaml
  23. 4
      docs/yaml/functions/environment.yaml
  24. 2
      docs/yaml/functions/is_disabler.yaml
  25. 2
      docs/yaml/functions/is_variable.yaml
  26. 6
      docs/yaml/objects/compiler.yaml

@ -97,7 +97,7 @@ class RefmanLinksExtension(Extension):
raw = Path(self._data_file).read_text(encoding='utf-8') raw = Path(self._data_file).read_text(encoding='utf-8')
self._data = loads(raw) self._data = loads(raw)
# Register formater # Register formatter
for ext in self.project.extensions.values(): for ext in self.project.extensions.values():
ext = T.cast(Extension, ext) ext = T.cast(Extension, ext)
ext.formatter.formatting_page_signal.connect(self._formatting_page_cb) ext.formatter.formatting_page_signal.connect(self._formatting_page_cb)

@ -132,7 +132,7 @@ ready for distribution.
#### Qt #### Qt
Qt offers a [deployment tool](https://doc.qt.io/qt-5/macos-deployment.html#macdeploy), Qt offers a [deployment tool](https://doc.qt.io/qt-5/macos-deployment.html#macdeploy),
called `macdeployqt`, that automatizes bundling Qt's libraries in your application folder and called `macdeployqt`, that automates bundling Qt's libraries in your application folder and
optionally create the final `.dmg` installer optionally create the final `.dmg` installer
```console ```console
@ -140,7 +140,7 @@ optionally create the final `.dmg` installer
macdeployqt myapp.app -executable=myapp.app/Contents/MacOS/myapp macdeployqt myapp.app -executable=myapp.app/Contents/MacOS/myapp
``` ```
This copies the needed Qt libaries to the correct subfolders within `myapp.app`. This copies the needed Qt libraries to the correct subfolders within `myapp.app`.
The `-executable=myapp.app/Contents/MacOS/myapp` argument is The `-executable=myapp.app/Contents/MacOS/myapp` argument is
to automatically alter the search path of the executable to automatically alter the search path of the executable
`myapp.app/Contents/MacOS/myapp` for the Qt libraries. One can also pass the `-dmg` `myapp.app/Contents/MacOS/myapp` for the Qt libraries. One can also pass the `-dmg`

@ -570,7 +570,7 @@ versions would statically link, due to a quirk in `llvm-config`.
### Modules, a.k.a. Components ### Modules, a.k.a. Components
Meson wraps LLVM's concept of components in it's own modules concept. Meson wraps LLVM's concept of components in its own modules concept.
When you need specific components you add them as modules as Meson When you need specific components you add them as modules as Meson
will do the right thing: will do the right thing:
@ -756,7 +756,7 @@ See [threads](Threads.md).
## Valgrind ## Valgrind
Meson will find valgrind using `pkg-config`, but only uses the Meson will find valgrind using `pkg-config`, but only uses the
compilation flags and avoids trying to link with it's non-PIC static compilation flags and avoids trying to link with its non-PIC static
libs. libs.
## Vulkan ## Vulkan

@ -75,7 +75,7 @@ executable('myexe', ['main.c', foo_h], link_with : libfoo)
``` ```
Each target that depends on a generated header should add that header Each target that depends on a generated header should add that header
to it's sources, as seen above with `libfoo` and `myexe`. This is to its sources, as seen above with `libfoo` and `myexe`. This is
because there is no way for Meson or the backend to know that `myexe` because there is no way for Meson or the backend to know that `myexe`
depends on `foo.h` just because `libfoo` does, it could be a private depends on `foo.h` just because `libfoo` does, it could be a private
header. header.

@ -181,7 +181,7 @@ the system downloads and configures SDL2:
![Running the sample application](images/sdltutorial_05.png) ![Running the sample application](images/sdltutorial_05.png)
A bit later the compilation exits succesfully. A bit later the compilation exits successfully.
![Running the sample application](images/sdltutorial_06.png) ![Running the sample application](images/sdltutorial_06.png)

@ -337,7 +337,7 @@ Likewise, `add_test_setup(..., timeout_multiplier: 0)`, or
Both the gnu linker and lld support using threads for speeding up LTO, meson Both the gnu linker and lld support using threads for speeding up LTO, meson
now provides a knob for this: `-Db_lto_threads`. Currently this is only now provides a knob for this: `-Db_lto_threads`. Currently this is only
supported for clang and gcc. Any positive integer is supported, `0` means supported for clang and gcc. Any positive integer is supported, `0` means
`auto`. If the compiler or linker implements it's on `auto` we use that, `auto`. If the compiler or linker implements its own `auto` we use that,
otherwise the number of threads on the machine is used. otherwise the number of threads on the machine is used.
## `summary()` now uses left alignment for both keys and values ## `summary()` now uses left alignment for both keys and values

@ -176,7 +176,7 @@ Meson has a new command `env2mfile` that can be used to convert
"environment variable based" cross and native compilation environments "environment variable based" cross and native compilation environments
to Meson machine files. This is especially convenient for e.g. distro to Meson machine files. This is especially convenient for e.g. distro
packagers so they can easily generate unambiguous configuration files packagers so they can easily generate unambiguous configuration files
for packge building. for package building.
As an example here's how you would generate a cross file that takes As an example here's how you would generate a cross file that takes
its settings from the `CC`, `CXX`, `CFLAGS` etc environment variables. its settings from the `CC`, `CXX`, `CFLAGS` etc environment variables.

@ -247,7 +247,7 @@ set explicitly (in which case that will take precedence).
## Added support for multiline fstrings ## Added support for multiline fstrings
Added support for multiline f-strings which use the same syntax as f-strings Added support for multiline f-strings which use the same syntax as f-strings
for string substition. for string substitution.
```meson ```meson
x = 'hello' x = 'hello'

@ -279,7 +279,7 @@ When tests use the `tap` protocol each test will be recorded as a
testsuite container, with each case named by the number of the result. testsuite container, with each case named by the number of the result.
When tests use the `gtest` protocol Meson will inject arguments to the When tests use the `gtest` protocol Meson will inject arguments to the
test to generate it's own JUnit XML, which Meson will include as part test to generate its own JUnit XML, which Meson will include as part
of this XML file. of this XML file.
*New in 0.55.0* *New in 0.55.0*

@ -115,7 +115,7 @@ warnings:
- Warnings are also optional. - Warnings are also optional.
# To avoid duplicating documentation / code, argument inheritence is supported with # To avoid duplicating documentation / code, argument inheritance is supported with
# the following optional keys: # the following optional keys:
posargs_inherit: _build_target_base # Use the posargs definition of `_build_target_base` here posargs_inherit: _build_target_base # Use the posargs definition of `_build_target_base` here

@ -7,7 +7,7 @@ Compiles Qt's resources collection files (.qrc) into c++ files for compilation.
It takes no positional arguments, and the following keyword arguments: It takes no positional arguments, and the following keyword arguments:
- `name` (string | empty): if provided a single .cpp file will be generated, - `name` (string | empty): if provided a single .cpp file will be generated,
and the output of all qrc files will be combined in this file, otherwise and the output of all qrc files will be combined in this file, otherwise
each qrc file be written to it's own cpp file. each qrc file be written to its own cpp file.
- `sources` (File | string | custom_target | custom_target index | generator_output)[]: - `sources` (File | string | custom_target | custom_target index | generator_output)[]:
A list of sources to be transpiled. Required, must have at least one source A list of sources to be transpiled. Required, must have at least one source
*New in 0.60.0*: support for custom_target, custom_target_index, and generator_output. *New in 0.60.0*: support for custom_target, custom_target_index, and generator_output.

@ -2,5 +2,5 @@
The output of `meson configure`, printing all options, is now more readable by The output of `meson configure`, printing all options, is now more readable by
automatically using a pager (`less` by default) and colors. The pager used can automatically using a pager (`less` by default) and colors. The pager used can
be controled by setting `PAGER` environment variable, or `--no-pager` command be controlled by setting `PAGER` environment variable, or `--no-pager` command
line option. line option.

@ -119,7 +119,7 @@ class GeneratorMD(GeneratorBase):
raise RuntimeError(f'Invalid argument {obj}') raise RuntimeError(f'Invalid argument {obj}')
def _write_file(self, data: str, file_id: str) -> None:# def _write_file(self, data: str, file_id: str) -> None:#
''' Write the data to disk ans store the id for the generated data ''' ''' Write the data to disk and store the id for the generated data '''
self.generated_files[file_id] = self._gen_filename(file_id) self.generated_files[file_id] = self._gen_filename(file_id)
out_file = self.out_dir / self.generated_files[file_id] out_file = self.out_dir / self.generated_files[file_id]

@ -30,10 +30,10 @@ class Type(T.TypedDict):
class Argument(BaseObject): class Argument(BaseObject):
''' '''
Object that represents any type of a single function or method argumet. Object that represents any type of a single function or method argument.
''' '''
type: T.List[Type] # A non-empty list of types that are supported. type: T.List[Type] # A non-empty list of types that are supported.
type_str: str # Formated version of `type`. Is guranteed to not contain any whitespaces. type_str: str # Formatted version of `type`. Is guaranteed to not contain any whitespaces.
required: bool required: bool
default: T.Optional[str] default: T.Optional[str]
min_varargs: T.Optional[int] # Only relevant for varargs, must be `null` for all other types of arguments min_varargs: T.Optional[int] # Only relevant for varargs, must be `null` for all other types of arguments

@ -151,7 +151,7 @@ class _Resolver:
self.type_map[obj.name] = obj self.type_map[obj.name] = obj
for m in obj.methods: for m in obj.methods:
mid = f'{obj.name}.{m.name}' mid = f'{obj.name}.{m.name}'
assert mid not in self.type_map, f'Duplicate metod {mid}' assert mid not in self.type_map, f'Duplicate method {mid}'
self.func_map[mid] = m self.func_map[mid] = m
# Build func map for functions # Build func map for functions
@ -169,7 +169,7 @@ class _Resolver:
mlog.log(' -- validating', mlog.bold(obj.name)) mlog.log(' -- validating', mlog.bold(obj.name))
self._validate_named_object(obj) self._validate_named_object(obj)
self._validate_feature_check(obj) self._validate_feature_check(obj)
# Resolve and validate inheritence # Resolve and validate inheritance
if obj.extends: if obj.extends:
assert obj.extends in self.type_map, f'Unknown extends object {obj.extends} in {obj.name}' assert obj.extends in self.type_map, f'Unknown extends object {obj.extends} in {obj.name}'
obj.extends_obj = self.type_map[obj.extends] obj.extends_obj = self.type_map[obj.extends]

@ -16,7 +16,7 @@
<tr> <tr>
<td style="white-space: nowrap; text-align: center; padding: 6px;"><code class="language-meson">{{name}}</code></td> <td style="white-space: nowrap; text-align: center; padding: 6px;"><code class="language-meson">{{name}}</code></td>
<td style="white-space: revert; text-align: center; padding: 6px; word-wrap: break-word;">{{&type}}</td> <td style="white-space: revert; text-align: center; padding: 6px; word-wrap: break-word;">{{&type}}</td>
<!-- This suboptimal formating is required to ensure hotdoc correctly generates the HTML --> <!-- This suboptimal formatting is required to ensure hotdoc correctly generates the HTML -->
<td style="width: 56%; padding: 6px;"> <td style="width: 56%; padding: 6px;">
{{&description}} {{&description}}

@ -55,4 +55,4 @@ or other methods.
{{/modules}} {{/modules}}
{{/enable_modules}} {{/enable_modules}}
<!-- The links used to be generated wit {>root_link}, but this is a bit hard to read --> <!-- The links used to be generated with {>root_link}, but this is a bit hard to read -->

@ -450,7 +450,7 @@ methods:
type: env | str | list[str] | dict[str] | dict[list[str]] type: env | str | list[str] | dict[str] | dict[list[str]]
description: | description: |
The [[@env]] object to add. The [[@env]] object to add.
Since *0.62.0* list of strings is allowed in dictionnary values. In that Since *0.62.0* list of strings is allowed in dictionary values. In that
case values are joined using the separator. case values are joined using the separator.
kwargs: kwargs:
separator: separator:
@ -467,5 +467,5 @@ methods:
description: | description: |
Must be one of 'set', 'prepend', or 'append' Must be one of 'set', 'prepend', or 'append'
(defaults to 'set'). Controls if initial values defined in the first (defaults to 'set'). Controls if initial values defined in the first
positional argument are prepended, appended or repace the current value positional argument are prepended, appended or replace the current value
of the environment variable. of the environment variable.

@ -39,7 +39,7 @@ methods:
# str.replace(old, new) # str.replace(old, new)
- name: replace - name: replace
description: Search all occurences of `old` and and replace it with `new` description: Search all occurrences of `old` and and replace it with `new`
returns: str returns: str
since: 0.58.0 since: 0.58.0
example: | example: |

@ -145,7 +145,7 @@ kwargs:
type: bool type: bool
since: 0.42.0 since: 0.42.0
default: true default: true
description: Controlls whether Meson adds the current source and build directories to the include path description: Controls whether Meson adds the current source and build directories to the include path
include_directories: include_directories:
type: list[inc | str] type: list[inc | str]

@ -10,6 +10,6 @@ optargs:
type: dict[str | bool | int] type: dict[str | bool | int]
since: 0.49.0 since: 0.49.0
description: | description: |
Optional dictionary to specifiy an inital data set. If Optional dictionary to specify an initial data set. If
provided, each key/value pair is added into the [[@cfg_data]] object provided, each key/value pair is added into the [[@cfg_data]] object
as if the [[cfg_data.set]] method was called for each of them. as if the [[cfg_data.set]] method was called for each of them.

@ -6,7 +6,7 @@ description: |
The name of custom target might not be used by every backends, for instance with The name of custom target might not be used by every backends, for instance with
the Ninja backend, `subdir/meson.build` containing the example below, the Ninja backend, `subdir/meson.build` containing the example below,
`ninja -C builddir foo` or `ninja -C builddir subdir/foo` won't work, `ninja -C builddir foo` or `ninja -C builddir subdir/foo` won't work,
it is instead `ninja -C builddir subdir/file.txt`. Howerver, `meson compile subdir/foo` it is instead `ninja -C builddir subdir/file.txt`. However, `meson compile subdir/foo`
is accepted. is accepted.
```meson ```meson
custom_target('foo', output: 'file.txt', ...) custom_target('foo', output: 'file.txt', ...)

@ -12,7 +12,7 @@ optargs:
description: | description: |
If provided, each key/value pair is added into the [[@env]] object If provided, each key/value pair is added into the [[@env]] object
as if [[env.set]] method was called for each of them. as if [[env.set]] method was called for each of them.
Since *0.62.0* list of strings is allowed in dictionnary values. In that Since *0.62.0* list of strings is allowed in dictionary values. In that
case values are joined using the separator. case values are joined using the separator.
kwargs: kwargs:
@ -31,5 +31,5 @@ kwargs:
description: | description: |
Must be one of 'set', 'prepend', or 'append' Must be one of 'set', 'prepend', or 'append'
(defaults to 'set'). Controls if initial values defined in the first (defaults to 'set'). Controls if initial values defined in the first
positional argument are prepended, appended or repace the current value positional argument are prepended, appended or replace the current value
of the environment variable. of the environment variable.

@ -6,4 +6,4 @@ description: Returns true if a variable is a disabler and false otherwise.
posargs: posargs:
var: var:
type: any type: any
description: The varaible to test description: The variable to test

@ -6,4 +6,4 @@ description: Returns true if a variable of the given name exists and false other
posargs: posargs:
var: var:
type: str type: str
description: The varaible to test description: The variable to test

@ -37,7 +37,7 @@ methods:
The source code to check. The source code to check.
If a string is passed, the code is used directly. If a [[@file]] object If a string is passed, the code is used directly. If a [[@file]] object
is passed, it's content is used for the compiler check. is passed, its content is used for the compiler check.
# Helper methods to pre-define common kwargs # Helper methods to pre-define common kwargs
- name: _args - name: _args
@ -105,7 +105,7 @@ methods:
The name to use for printing a message about the compiler check. The name to use for printing a message about the compiler check.
If this keyword argument is not passed, no message will be printed about the check. If this keyword argument is not passed, no message will be printed about the check.
# Even more convinient # Even more convenient
- name: _common - name: _common
returns: void returns: void
description: You have found a bug if you can see this! description: You have found a bug if you can see this!
@ -564,7 +564,7 @@ methods:
posargs: posargs:
name: name:
type: str type: str
description: The attribute nane to check. description: The attribute name to check.
- name: get_supported_function_attributes - name: get_supported_function_attributes
returns: list[str] returns: list[str]

Loading…
Cancel
Save