nir: Document the function inlining process
authorJason Ekstrand <jason.ekstrand@intel.com>
Mon, 29 Oct 2018 17:00:40 +0000 (12:00 -0500)
committerJason Ekstrand <jason.ekstrand@intel.com>
Wed, 12 Dec 2018 14:32:32 +0000 (08:32 -0600)
commitca98902d093d27d3fb4b6d6d95b1eaacdd9bbc7b
treead34aa3bfe88851c9aef98a9f74c96548d664f72
parent5749c0ebc43674aab1632bfd590238b13182fcdb
nir: Document the function inlining process

This has thrown a few people off recently and it's good to have the
process and all the rational for it documented somewhere.  A comment at
the top of nir_inline_functions seems as good a place as any.

Acked-by: Karol Herbst <kherbst@redhat.com>
Reviewed-by: Matt Turner <mattst88@gmail.com>
src/compiler/nir/nir_inline_functions.c