[rustc.git] / src / rustllvm / README

This directory currently contains some LLVM support code. This will generally
be sent upstream to LLVM in time; for now it lives here.

NOTE: the LLVM C++ ABI is subject to between-version breakage and must *never*
be exposed to Rust. To allow for easy auditing of that, all Rust-exposed types
must be typedef-ed as "LLVMXyz", or "LLVMRustXyz" if they were defined here.

Functions that return a failure status and leave the error in
the LLVM last error should return an LLVMRustResult rather than an
int or anything to avoid confusion.

When translating enums, add a single `Other` variant as the first
one to allow for new variants to be added. It should abort when used
as an input.

All other types must not be typedef-ed as such.
Commit	Line	Data
223e47cc LB	1	This directory currently contains some LLVM support code. This will generally
223e47cc LB	2	be sent upstream to LLVM in time; for now it lives here.
5bcae85e SL	3
	4	NOTE: the LLVM C++ ABI is subject to between-version breakage and must never
	5	be exposed to Rust. To allow for easy auditing of that, all Rust-exposed types
	6	must be typedef-ed as "LLVMXyz", or "LLVMRustXyz" if they were defined here.
	7
	8	Functions that return a failure status and leave the error in
	9	the LLVM last error should return an LLVMRustResult rather than an
	10	int or anything to avoid confusion.
	11
	12	When translating enums, add a single `Other` variant as the first
	13	one to allow for new variants to be added. It should abort when used
	14	as an input.
	15
	16	All other types must not be typedef-ed as such.