Skip to content

Commit 49d53a2

Browse files
committed
[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.
1 parent 46505b3 commit 49d53a2

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

llvm/docs/MyFirstTypoFix.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,14 @@ Introduction
99
============
1010

1111
This tutorial will guide you through the process of making a change to
12-
LLVM, and contributing it back to the LLVM project. We'll be making a
13-
change to Clang, but the steps for other parts of LLVM are the same.
12+
LLVM, and contributing it back to the LLVM project.
13+
14+
.. note::
15+
The code changes presented here are only an example and not something you
16+
should actually submit to the LLVM project. For your first real change to LLVM,
17+
the code will be different but the rest of the guide will still apply.
18+
19+
We'll be making a change to Clang, but the steps for other parts of LLVM are the same.
1420
Even though the change we'll be making is simple, we're going to cover
1521
steps like building LLVM, running the tests, and code review. This is
1622
good practice, and you'll be prepared for making larger changes.

0 commit comments

Comments
 (0)