From fa2585d0b364143fb588b8bb611eaa4d1c277811 Mon Sep 17 00:00:00 2001 From: Elliott Sales de Andrade Date: Sat, 22 Oct 2022 16:42:21 -0400 Subject: [PATCH] Fix typos in docs --- docs/extensions/refman_links.py | 2 +- docs/markdown/Creating-OSX-packages.md | 4 ++-- docs/markdown/Dependencies.md | 4 ++-- docs/markdown/Generating-sources.md | 2 +- docs/markdown/GuiTutorial.md | 2 +- docs/markdown/Release-notes-for-0.57.0.md | 2 +- docs/markdown/Release-notes-for-0.62.0.md | 2 +- docs/markdown/Release-notes-for-0.63.0.md | 2 +- docs/markdown/Unit-tests.md | 2 +- docs/markdown/Yaml-RefMan.md | 2 +- docs/markdown/_include_qt_base.md | 2 +- docs/markdown/snippets/conf_pager.md | 2 +- docs/refman/generatormd.py | 2 +- docs/refman/jsonschema.py | 4 ++-- docs/refman/loaderbase.py | 4 ++-- docs/refman/templates/args.mustache | 2 +- docs/refman/templates/root.mustache | 2 +- docs/yaml/builtins/meson.yaml | 4 ++-- docs/yaml/elementary/str.yml | 2 +- docs/yaml/functions/_build_target_base.yaml | 2 +- docs/yaml/functions/configuration_data.yaml | 2 +- docs/yaml/functions/custom_target.yaml | 2 +- docs/yaml/functions/environment.yaml | 4 ++-- docs/yaml/functions/is_disabler.yaml | 2 +- docs/yaml/functions/is_variable.yaml | 2 +- docs/yaml/objects/compiler.yaml | 6 +++--- 26 files changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/extensions/refman_links.py b/docs/extensions/refman_links.py index 3aec36847..5c22a0a0b 100644 --- a/docs/extensions/refman_links.py +++ b/docs/extensions/refman_links.py @@ -97,7 +97,7 @@ class RefmanLinksExtension(Extension): raw = Path(self._data_file).read_text(encoding='utf-8') self._data = loads(raw) - # Register formater + # Register formatter for ext in self.project.extensions.values(): ext = T.cast(Extension, ext) ext.formatter.formatting_page_signal.connect(self._formatting_page_cb) diff --git a/docs/markdown/Creating-OSX-packages.md b/docs/markdown/Creating-OSX-packages.md index 5a30b97d5..7e0d05bf4 100644 --- a/docs/markdown/Creating-OSX-packages.md +++ b/docs/markdown/Creating-OSX-packages.md @@ -132,7 +132,7 @@ ready for distribution. #### Qt 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 ```console @@ -140,7 +140,7 @@ optionally create the final `.dmg` installer 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 to automatically alter the search path of the executable `myapp.app/Contents/MacOS/myapp` for the Qt libraries. One can also pass the `-dmg` diff --git a/docs/markdown/Dependencies.md b/docs/markdown/Dependencies.md index 0938e0692..6eab6ab16 100644 --- a/docs/markdown/Dependencies.md +++ b/docs/markdown/Dependencies.md @@ -570,7 +570,7 @@ versions would statically link, due to a quirk in `llvm-config`. ### 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 will do the right thing: @@ -756,7 +756,7 @@ See [threads](Threads.md). ## Valgrind 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. ## Vulkan diff --git a/docs/markdown/Generating-sources.md b/docs/markdown/Generating-sources.md index 3cdfbc459..b954a415f 100644 --- a/docs/markdown/Generating-sources.md +++ b/docs/markdown/Generating-sources.md @@ -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 -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` depends on `foo.h` just because `libfoo` does, it could be a private header. diff --git a/docs/markdown/GuiTutorial.md b/docs/markdown/GuiTutorial.md index 6990eef86..85930d7dc 100644 --- a/docs/markdown/GuiTutorial.md +++ b/docs/markdown/GuiTutorial.md @@ -181,7 +181,7 @@ the system downloads and configures SDL2: ![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) diff --git a/docs/markdown/Release-notes-for-0.57.0.md b/docs/markdown/Release-notes-for-0.57.0.md index 4ac003c4d..f16cf2404 100644 --- a/docs/markdown/Release-notes-for-0.57.0.md +++ b/docs/markdown/Release-notes-for-0.57.0.md @@ -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 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 -`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. ## `summary()` now uses left alignment for both keys and values diff --git a/docs/markdown/Release-notes-for-0.62.0.md b/docs/markdown/Release-notes-for-0.62.0.md index f5382df8e..cc32ac688 100644 --- a/docs/markdown/Release-notes-for-0.62.0.md +++ b/docs/markdown/Release-notes-for-0.62.0.md @@ -176,7 +176,7 @@ Meson has a new command `env2mfile` that can be used to convert "environment variable based" cross and native compilation environments to Meson machine files. This is especially convenient for e.g. distro 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 its settings from the `CC`, `CXX`, `CFLAGS` etc environment variables. diff --git a/docs/markdown/Release-notes-for-0.63.0.md b/docs/markdown/Release-notes-for-0.63.0.md index f64c2a3a2..9f8da3e1f 100644 --- a/docs/markdown/Release-notes-for-0.63.0.md +++ b/docs/markdown/Release-notes-for-0.63.0.md @@ -247,7 +247,7 @@ set explicitly (in which case that will take precedence). ## Added support for multiline fstrings Added support for multiline f-strings which use the same syntax as f-strings -for string substition. +for string substitution. ```meson x = 'hello' diff --git a/docs/markdown/Unit-tests.md b/docs/markdown/Unit-tests.md index 421270e51..664f99e3e 100644 --- a/docs/markdown/Unit-tests.md +++ b/docs/markdown/Unit-tests.md @@ -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. 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. *New in 0.55.0* diff --git a/docs/markdown/Yaml-RefMan.md b/docs/markdown/Yaml-RefMan.md index 0e59bf51c..1bb800f8d 100644 --- a/docs/markdown/Yaml-RefMan.md +++ b/docs/markdown/Yaml-RefMan.md @@ -115,7 +115,7 @@ warnings: - 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: posargs_inherit: _build_target_base # Use the posargs definition of `_build_target_base` here diff --git a/docs/markdown/_include_qt_base.md b/docs/markdown/_include_qt_base.md index e624c1737..0ecd63a0b 100644 --- a/docs/markdown/_include_qt_base.md +++ b/docs/markdown/_include_qt_base.md @@ -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: - `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 - 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)[]: 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. diff --git a/docs/markdown/snippets/conf_pager.md b/docs/markdown/snippets/conf_pager.md index 8924adc47..3d936ad05 100644 --- a/docs/markdown/snippets/conf_pager.md +++ b/docs/markdown/snippets/conf_pager.md @@ -2,5 +2,5 @@ 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 -be controled by setting `PAGER` environment variable, or `--no-pager` command +be controlled by setting `PAGER` environment variable, or `--no-pager` command line option. diff --git a/docs/refman/generatormd.py b/docs/refman/generatormd.py index 8fd0ef965..97230340e 100644 --- a/docs/refman/generatormd.py +++ b/docs/refman/generatormd.py @@ -119,7 +119,7 @@ class GeneratorMD(GeneratorBase): raise RuntimeError(f'Invalid argument {obj}') 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) out_file = self.out_dir / self.generated_files[file_id] diff --git a/docs/refman/jsonschema.py b/docs/refman/jsonschema.py index 1b948569c..00c0b5e11 100644 --- a/docs/refman/jsonschema.py +++ b/docs/refman/jsonschema.py @@ -30,10 +30,10 @@ class Type(T.TypedDict): 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_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 default: T.Optional[str] min_varargs: T.Optional[int] # Only relevant for varargs, must be `null` for all other types of arguments diff --git a/docs/refman/loaderbase.py b/docs/refman/loaderbase.py index 1db92e26a..3011126bc 100644 --- a/docs/refman/loaderbase.py +++ b/docs/refman/loaderbase.py @@ -151,7 +151,7 @@ class _Resolver: self.type_map[obj.name] = obj for m in obj.methods: 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 # Build func map for functions @@ -169,7 +169,7 @@ class _Resolver: mlog.log(' -- validating', mlog.bold(obj.name)) self._validate_named_object(obj) self._validate_feature_check(obj) - # Resolve and validate inheritence + # Resolve and validate inheritance if obj.extends: assert obj.extends in self.type_map, f'Unknown extends object {obj.extends} in {obj.name}' obj.extends_obj = self.type_map[obj.extends] diff --git a/docs/refman/templates/args.mustache b/docs/refman/templates/args.mustache index 802bcd610..f3ee84bc9 100644 --- a/docs/refman/templates/args.mustache +++ b/docs/refman/templates/args.mustache @@ -16,7 +16,7 @@ {{name}} {{&type}} - + {{&description}} diff --git a/docs/refman/templates/root.mustache b/docs/refman/templates/root.mustache index c793b04b2..a540c2ca6 100644 --- a/docs/refman/templates/root.mustache +++ b/docs/refman/templates/root.mustache @@ -55,4 +55,4 @@ or other methods. {{/modules}} {{/enable_modules}} - + diff --git a/docs/yaml/builtins/meson.yaml b/docs/yaml/builtins/meson.yaml index 1ae3499a3..b8b1ad48d 100644 --- a/docs/yaml/builtins/meson.yaml +++ b/docs/yaml/builtins/meson.yaml @@ -450,7 +450,7 @@ methods: type: env | str | list[str] | dict[str] | dict[list[str]] description: | 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. kwargs: separator: @@ -467,5 +467,5 @@ methods: description: | Must be one of 'set', 'prepend', or 'append' (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. diff --git a/docs/yaml/elementary/str.yml b/docs/yaml/elementary/str.yml index 9c4ec9d83..7b60e1e94 100644 --- a/docs/yaml/elementary/str.yml +++ b/docs/yaml/elementary/str.yml @@ -39,7 +39,7 @@ methods: # str.replace(old, new) - 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 since: 0.58.0 example: | diff --git a/docs/yaml/functions/_build_target_base.yaml b/docs/yaml/functions/_build_target_base.yaml index d299a854d..4e7afadb6 100644 --- a/docs/yaml/functions/_build_target_base.yaml +++ b/docs/yaml/functions/_build_target_base.yaml @@ -145,7 +145,7 @@ kwargs: type: bool since: 0.42.0 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: type: list[inc | str] diff --git a/docs/yaml/functions/configuration_data.yaml b/docs/yaml/functions/configuration_data.yaml index e16a69fc1..61297b58a 100644 --- a/docs/yaml/functions/configuration_data.yaml +++ b/docs/yaml/functions/configuration_data.yaml @@ -10,6 +10,6 @@ optargs: type: dict[str | bool | int] since: 0.49.0 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 as if the [[cfg_data.set]] method was called for each of them. diff --git a/docs/yaml/functions/custom_target.yaml b/docs/yaml/functions/custom_target.yaml index dae6a4f35..7d052820c 100644 --- a/docs/yaml/functions/custom_target.yaml +++ b/docs/yaml/functions/custom_target.yaml @@ -6,7 +6,7 @@ description: | 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, `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. ```meson custom_target('foo', output: 'file.txt', ...) diff --git a/docs/yaml/functions/environment.yaml b/docs/yaml/functions/environment.yaml index 5c3a43d5f..4c18ffc27 100644 --- a/docs/yaml/functions/environment.yaml +++ b/docs/yaml/functions/environment.yaml @@ -12,7 +12,7 @@ optargs: description: | If provided, each key/value pair is added into the [[@env]] object 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. kwargs: @@ -31,5 +31,5 @@ kwargs: description: | Must be one of 'set', 'prepend', or 'append' (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. diff --git a/docs/yaml/functions/is_disabler.yaml b/docs/yaml/functions/is_disabler.yaml index 9f1dd9327..278634541 100644 --- a/docs/yaml/functions/is_disabler.yaml +++ b/docs/yaml/functions/is_disabler.yaml @@ -6,4 +6,4 @@ description: Returns true if a variable is a disabler and false otherwise. posargs: var: type: any - description: The varaible to test + description: The variable to test diff --git a/docs/yaml/functions/is_variable.yaml b/docs/yaml/functions/is_variable.yaml index 6c338eec4..9012679ae 100644 --- a/docs/yaml/functions/is_variable.yaml +++ b/docs/yaml/functions/is_variable.yaml @@ -6,4 +6,4 @@ description: Returns true if a variable of the given name exists and false other posargs: var: type: str - description: The varaible to test + description: The variable to test diff --git a/docs/yaml/objects/compiler.yaml b/docs/yaml/objects/compiler.yaml index 6f49ec526..cf341119d 100644 --- a/docs/yaml/objects/compiler.yaml +++ b/docs/yaml/objects/compiler.yaml @@ -37,7 +37,7 @@ methods: The source code to check. 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 - name: _args @@ -105,7 +105,7 @@ methods: 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. -# Even more convinient +# Even more convenient - name: _common returns: void description: You have found a bug if you can see this! @@ -564,7 +564,7 @@ methods: posargs: name: type: str - description: The attribute nane to check. + description: The attribute name to check. - name: get_supported_function_attributes returns: list[str]