Correct lie in contract

[dabrahams]

The method asserts when passed a null pointer.

[github-actions]

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be
notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write
permissions for the repository. In which case you can instead tag reviewers by
name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review
by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate
is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

[llvmbot]

@llvm/pr-subscribers-llvm-ir

Author: Dave Abrahams (dabrahams)

Changes

The method asserts when passed a null pointer.

---

Full diff: https://github.com/llvm/llvm-project/pull/82517.diff

1 Files Affected:

• (modified) llvm/include/llvm/IR/GlobalVariable.h (+2-2)

diff --git a/llvm/include/llvm/IR/GlobalVariable.h b/llvm/include/llvm/IR/GlobalVariable.h
index bcaf8e91432ba9..d76db8463c9dfa 100644
--- a/llvm/include/llvm/IR/GlobalVariable.h
+++ b/llvm/include/llvm/IR/GlobalVariable.h
@@ -146,8 +146,8 @@ class GlobalVariable : public GlobalObject, public ilist_node<GlobalVariable> {
     assert(hasInitializer() && "GV doesn't have initializer!");
     return static_cast<Constant*>(Op<0>().get());
   }
-  /// setInitializer - Sets the initializer for this global variable, removing
-  /// any existing initializer if InitVal==NULL.  If this GV has type T*, the
+  /// setInitializer - Sets the initializer for this global variable to 
+  /// InitVal, which must be non-null.  If this GV has type T*, the
   /// initializer must have type T.
   void setInitializer(Constant *InitVal);
 

[github-actions]

✅ With the latest revision this PR passed the C/C++ code formatter.

[dabrahams]

Ping

I don't understand the CI failure I'm seeing and thus I don't know how to address it. Thanks!