[#kernel-SanityChecks]
= xref:kernel.adoc[kernel]::SanityChecks
:relfileprefix: ../
:mrdocs:

Ensure a usable environment with all necessary library support.

== Synopsis

Declared in `<kernel/checks.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[nodiscard]]
xref:util/Result.adoc[util::Result<void>]
SanityChecks(xref:kernel/Context.adoc[Context] const& context);
----

== Return Value

A successful result, or an error describing the missing support.

[NOTE]
====
The return value https://en.cppreference.com/cpp/language/attributes/nodiscard[should not be discarded^].
====
== Parameters

[cols="1,4"]
|===
| Name| Description
| *context*
| The kernel context to validate against.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#