From 116b5a5a4eb72d94ba30d60b7d0032741755ca12 Mon Sep 17 00:00:00 2001
From: PENGUINLIONG <admin@penguinliong.moe>
Date: Sun, 4 Feb 2018 02:10:50 +0800
Subject: [PATCH] Note about CodeGenC's Range of Use (#866)
---
src/codegen/codegen_c.h | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/src/codegen/codegen_c.h b/src/codegen/codegen_c.h
index ce882eda4..bc44e3812 100644
--- a/src/codegen/codegen_c.h
+++ b/src/codegen/codegen_c.h
@@ -24,6 +24,11 @@ using namespace ir;
* \brief A base class to generate C code.
*
* CodeGenC have two modes: generate SSA formed C code or normal form.
+ *
+ * **NOTE** CodeGenC does not aim at generating C codes consumed by MSVC or GCC,
+ * Rather, it's providing infrastructural abstraction for C variants like CUDA
+ * and OpenCL-C. You might find some odd variant features, e.g., type `int3` for
+ * a vector of 3 `int`s. For native C code generator, see `CodeGenLLVM`.
*/
class CodeGenC :
public ExprFunctor<void(const Expr&, std::ostream&)>,
--
GitLab