[llvm] 49d53a2 - [llvm][Docs] Add explanatory note to MyFirstTypoFix intro

[David Spickett via llvm-commits]

Author: David Spickett
Date: 2024-07-16T12:50:51+01:00
New Revision: 49d53a206faf5fb398aba5c8c1d21b3ec111fe39

URL: https://github.com/llvm/llvm-project/commit/49d53a206faf5fb398aba5c8c1d21b3ec111fe39
DIFF: https://github.com/llvm/llvm-project/commit/49d53a206faf5fb398aba5c8c1d21b3ec111fe39.diff

LOG: [llvm][Docs] Add explanatory note to MyFirstTypoFix intro

To make it 100% clear that the changes are an example and the guide
should later be used with the reader's own changes to submit an
actual PR.

Added: 
    

Modified: 
    llvm/docs/MyFirstTypoFix.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/MyFirstTypoFix.rst b/llvm/docs/MyFirstTypoFix.rst
index 86ea32c6a441b..733b3eac141f2 100644
--- a/llvm/docs/MyFirstTypoFix.rst
+++ b/llvm/docs/MyFirstTypoFix.rst
@@ -9,8 +9,14 @@ Introduction
 ============
 
 This tutorial will guide you through the process of making a change to
-LLVM, and contributing it back to the LLVM project. We'll be making a
-change to Clang, but the steps for other parts of LLVM are the same.
+LLVM, and contributing it back to the LLVM project.
+
+.. note::
+   The code changes presented here are only an example and not something you
+   should actually submit to the LLVM project. For your first real change to LLVM,
+   the code will be 
diff erent but the rest of the guide will still apply.
+
+We'll be making a change to Clang, but the steps for other parts of LLVM are the same.
 Even though the change we'll be making is simple, we're going to cover
 steps like building LLVM, running the tests, and code review. This is
 good practice, and you'll be prepared for making larger changes.