[Kaleidoscope] Fix DWARF function creation example

[jzbrooks]

Summary

The full code listing was fixed in fdaeb0c647eb66763721a7fe74e0a36b007dcd75

[jzbrooks]

The Debian check failures appear unrelated to this change. Unless all code snippets outside of the full tutorial code listing are compiled somehow, it seems unlikely this change is documentation-only. I'd guess they aren't compiled since this wasn't addressed sooner. I'm happy to be wrong. I'm a little surprised that the development branch has breakages. Is that common?

[dblaikie]

Looks good to me, thanks!

[dblaikie]

(this matches the actual code example here: https://github.com/llvm/llvm-project/blob/a053f359908b3645e54f820b551110764f964c66/llvm/examples/Kaleidoscope/Chapter9/toy.cpp#L1257 )

[jzbrooks]

Thanks @dblaikie. I don’t have commit access, can you land this patch for me? Please use “Justin Brooks [e-mail]” to commit the change.

I also wonder if this change would be beneficial to land in other branches as well. I was working with LLVM 11 (going to update it soon, hopefully), so when I encountered the problem the full code listing wasn't addressed either. I had to read LLVM source to figure out how to fix the problem. I'm happy to do that, but I'm not sure if there's a process for such things or if it would be valuable.

[dblaikie]

In D130217#3676841, @jzbrooks wrote:

Thanks @dblaikie. I don’t have commit access, can you land this patch for me? Please use “Justin Brooks [e-mail]” to commit the change.

Sure, done!

I also wonder if this change would be beneficial to land in other branches as well. I was working with LLVM 11 (going to update it soon, hopefully), so when I encountered the problem the full code listing wasn't addressed either. I had to read LLVM source to figure out how to fix the problem. I'm happy to do that, but I'm not sure if there's a process for such things or if it would be valuable.

@tstellar - any thoughts on whether it's suitable/worthwhile to backport this documentation fix?

[tstellar]

There are no more 14.x updates planned, so we aren't doing backports any more.

llvm/docs/tutorial/MyFirstLanguageFrontend/LangImpl09.rst

 .. code-block:: c++
 
   DIScope *FContext = Unit;
   unsigned LineNo = 0;
   unsigned ScopeLine = 0;
   DISubprogram *SP = DBuilder->createFunction(
       FContext, P.getName(), StringRef(), Unit, LineNo,
       CreateFunctionType(TheFunction->arg_size()),
-      false /* internal linkage */, true /* definition */, ScopeLine,
-      DINode::FlagPrototyped, false);
+      ScopeLine,
+      DINode::FlagPrototyped,
+      DISubprogram::SPFlagDefinition);
   TheFunction->setSubprogram(SP);
 
 and we now have an DISubprogram that contains a reference to all of our
 metadata for the function.
 
 Source Locations
 ================