[LLVMdev] Inserting comments

[Scott Graham]

On Tue, Nov 4, 2008 at 9:39 AM, Devang Patel <dpatel at apple.com> wrote:
>
>> Anyone have any clever way of inserting a comment (or
>> comment-ish-thing) that will make it to an .ll that's generated at the
>> same time as writing out the bitcode?
>> ...
>
> Try using llvm.var.annotation intrinsic.

Thanks for the suggestion. I'd tried doing that by annotating a null,
but then at each "comment" point I get:

	call void @llvm.var.annotation( i8* null, i8* getelementptr ([16 x
i8]* @comment4852, i32 0, i32 0), i8* null, i32 0 )

Slightly useful, but then you have to hunt down the definition of
"@comment4852" which isn't great.

... Oh, but llvm.annotation.* is workable (ignoring the unique-ing
append of "14"):

	%"------- my comment here14" = call i8 @llvm.annotation.i8( i8 0, i8*
null, i8* null, i32 0 )		; <i8> [#uses=0]

Thanks!