compilers: improve docstring to `get_compiler_check_args()`

There was an incomplete list, which wasn't useful as it now takes an
enum anyway. Also add a new entry to the list of reasons to use this
function.
pull/9295/head
Dylan Baker 3 years ago committed by Nirbheek Chauhan
parent 5027afe469
commit c1a1194b63
  1. 5
      mesonbuild/compilers/compilers.py

@ -1150,11 +1150,12 @@ class Compiler(HoldableObject, metaclass=abc.ABCMeta):
def get_compiler_check_args(self, mode: CompileCheckMode) -> T.List[str]: def get_compiler_check_args(self, mode: CompileCheckMode) -> T.List[str]:
"""Arguments to pass the compiler and/or linker for checks. """Arguments to pass the compiler and/or linker for checks.
The default implementation turns off optimizations. mode should be The default implementation turns off optimizations.
one of:
Examples of things that go here: Examples of things that go here:
- extra arguments for error checking - extra arguments for error checking
- Arguments required to make the compiler exit with a non-zero status
when something is wrong.
""" """
return self.get_no_optimization_args() return self.get_no_optimization_args()

Loading…
Cancel
Save