summaryrefslogtreecommitdiff
path: root/docs/markdown/Contributing.md
AgeCommit message (Collapse)Author
2025-03-07docs: describe the support policy for python versionsEli Schwartz
Bug: https://github.com/mesonbuild/meson/issues/14322
2024-07-28add initial support for llvm-flangH. Vetinari
2024-03-17tests: rename skip_on_jobname to expect_skip_on_jobname and skip_on_os to ↵Christoph Reiter
expect_skip_on_os The test.json format currently has three keys related to skipping tests: * `skip_on_jobname` * `skip_on_os` * `skip_on_env` While `skip_on_env` marks the test itself as skipped, i.e. they don't get run when the conditions are met, the other two skip options are just marking the test as "expected to be skipped" if the conditions apply, i.e. they want to see `MESON_SKIP_TEST` in the output and things will fail if that doesn't happen. They don't actually skip the tests as the names imply. To make this clearer rename the keys: * `skip_on_jobname` -> `expect_skip_on_jobname` * `skip_on_os` -> `expect_skip_on_os` `skip_on_env` stays the same, since that actually skips. The docs were also confused about this, so adjust that too.
2023-04-11fix various spelling issuesJosh Soref
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2022-12-12Fixing typosAndreas Deininger
Convert http to https in some links
2022-05-26don't tell documentation contributors to skip CIGuilherme Janczak
The CI correctly handles documentation changes automatically, it's no longer necessary to do it by hand.
2022-02-15fix missing documentation for testsuite option in test.jsonEli Schwartz
stdout line matching supports count since commit 66d62a224e92c41d6012dc6c23912a965da4da8f to fail if certain output is present (count: 0) but it was never documented in the contribution guidelines.
2022-02-10Contributing.md: fix typoAlyssa Ross
2022-01-23Contributing.md:specify max line length for docsandy5995
I thought it would good to specify a general rule here so people can set their line wrapping appropriately. [skip ci]
2021-08-18test runner: add the ability to configure test.json for python pathsEli Schwartz
Adds new installed file types with @VAR@ substitution.
2021-08-16Document new rules for green CI.Jussi Pakkanen
2021-07-07Allow `skip_*` test.json keys at top-level or in `matrix:`Jon Turney
2021-07-07Add `skip_on_os` to test.jsonJon Turney
2021-07-07Add `skip_on_jobname` to test.jsonJon Turney
Plan to replace the hard-coded list of 'may be skipped' framework tests in skippable() with annotations in test.json which record 'will be skipped in these specific CI jobs'. If the value of the MESON_CI_JOBNAME env var (an arbitrary string expected to be unique for each CI configuration) contains any of the strings in the `skip_on_jobname` key in test.json, the test is expected to output MESON_SKIP_TEST. Unexpected skips or runs are treated as an error. Future work: Maybe we should add additional count categories 'unexpected skip' and 'unexpected not skipped', rather than counting those as 'skipped' and 'failed', respectively.
2021-03-21Docs: Fix small typoHRXN
2021-01-31Capitalize "Meson" consistently as it is a proper name. [skip ci]Jussi Pakkanen
2021-01-30Rewrap long text lines in docs. [skip ci]Jussi Pakkanen
2021-01-13Fix misspellsAntonin Décimo
Signed-off-by: Antonin Décimo <antonin.decimo@gmail.com>
2021-01-10cmake: add PATH logic to preliminary dep check (fixes #8133)Daniel Mensinger
2020-12-11CI: Move all remaining jobs from travis-ci to GHAChristoph Reiter
Some changes: * Set HOME to /root, since github mounts its own HOME and 'wine' (because of permissions) and 'dub' (can't find packages) don't like that. * Remove the seccomp option, doesn't seem to be needed.
2020-08-27test: Add 'dir' support for installed files in test.jsonDaniel Mensinger
This is useful for automatically generated docs (doxygen, hotdoc) with a lot of generated files that may differ with different versions of the generator.
2020-04-30Update test.json schema to add stdoutJon Turney
Update the test.json schema, adding the 'stdout' property. Also amend the test.json schema so the presence of an unexpected property on the root object causes a validation error. v2: Also add 'tools' property to json schema. Amend the documentation not to use the word 'list' to describe a dict.
2020-04-30Add a mechanism for validating meson output in testsJon Turney
Expected stdout lines must match lines from the actual stdout, in the same order. Lines with match type 're' are regex matched. v2: Ignore comment lines in expected_stdout v3: Automatically adjust path separators for location in expected output v4: Put expected stdout in test.json, rather than a separate file
2020-04-28tests: Add support for specifying tool requirementsDaniel Mensinger
Adds the `tools` section to `tests.json` to specify requirements for the tools in the environment. All tests that fail at least one tool requirements check are skipped.
2020-04-28docs: Fix Contributing.mdDaniel Mensinger
2020-04-17Add a json schema for the test.json used in testsDylan Baker
This does a couple of nice things, one is that editors like vscode can be configured to use this schema to provide auto completion and error highlighting if invalid values are added or required values are missing. It also allows us test that the format of the test matrix work in a unit test, which I've added. It does require that the python jsonschema package is installed.
2020-04-13Remove alignment syntax not supported by hotdoc. Closes: #6954. [skip ci]Jussi Pakkanen
2020-03-09project_tests: Add the option to the test format to mark the languageDylan Baker
This is needed when mixing D and C code, as it's possible to end up witha combination of linkers and compilres such that C produces pdb files but D does not.
2020-03-09project_tests: Add "version" to "shared_lib" and "pdb" typesDylan Baker
This allows the harness to apply the version correctly, putting it in the right place, dropping the right amount of numbers, etc. pdb taking a version allows it to be more easily copied from the shared_lib type.
2020-03-06project_tests: Add a "shared_lib" typeDylan Baker
This allows fixing tests that produce .dylib's on macOS and .so's on elf Unices.
2020-02-26test: Updated docsDaniel Mensinger
2020-02-13Document some more details of how project tests workJon Turney
2019-12-23doc: examples of run_project_tests.py optionsMichael Hirsch, Ph.D
2019-11-06Fix typos found by codespellWolfgang Stöggl
- Typos were found by codespell v1.16.0
2019-10-19docs: Fix some incorrect links [skip ci]Anton Leontiev
2019-07-11docMichael Hirsch, Ph.D
2019-07-05Explain that using shell functionality is forbidden. [skip ci]Jussi Pakkanen
2019-05-12Add entry for random design points. [skip ci]Jussi Pakkanen
2018-11-28docs: Remove mention of appveyor from Contributing docJon Turney
Add mention of azure Also fix anchor in travis URL Also make 'see below' into a link
2018-07-05Fix flake8 issues (#3834)Jon Turney
* Fix flake8 whitespace reports $ flake8 | grep -E '(E203|E221|E226|E303|W291|W293)' ./mesonbuild/coredata.py:337:5: E303 too many blank lines (2) * Fix flake8 'variable assigned value but unused' reports $ flake8 | grep -E F841 ./mesonbuild/modules/gnome.py:922:9: F841 local variable 'target_name' is assigned to but never used * Fix flake8 'imported but unused' reports $ flake8 | grep F401 ./mesonbuild/compilers/__init__.py:128:1: F401 '.c.ArmclangCCompiler' imported but unused ./mesonbuild/compilers/__init__.py:138:1: F401 '.cpp.ArmclangCPPCompiler' imported but unused ./mesonbuild/modules/__init__.py:4:1: F401 '..mlog' imported but unused PR #3717 imports ARMCLANG compilers in __init__, but does not add them to __all__, so they are not re-exported by the compilers package like everything else. * More details about flake8 in Contributing.md Mention that Sider runs flake8 Suggest seting flake8 as a pre-commit hook
2018-07-02Contributing.md: Document procedure for new features [skip ci]Nirbheek Chauhan
2018-07-01Document merge workflow for contributors and maintainers. [skip ci]Jussi Pakkanen
2018-03-22Document the new and improved review guidelines. [skip ci]Jussi Pakkanen
2018-02-20Add references to CI and recommendation to disable them for doc only changes ↵Aleksey Filippov
[skip ci]
2018-01-19Correct spelling mistakes.Edward Betts
2017-12-26Explain test setup a bit more.Jussi Pakkanen
2017-12-20Created documentation page for code contributions.Jussi Pakkanen