Skip to content

Commit 0cb070a

Browse files
committed
GettingStarted.md: Reformat notes
1 parent 655d7f9 commit 0cb070a

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

docs/HowToGuides/GettingStarted.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,10 @@ toolchain as a one-off, there are a couple of differences:
8181
cd swift
8282
utils/update-checkout --clone
8383
```
84-
**Note:** If you've already forked the project on GitHub at this stage,
85-
**do not clone your fork** to start off. We describe
86-
[how to setup your fork](#setting-up-your-fork) in a subsection below.
84+
> **Note**
85+
> If you've already forked the project on GitHub at this stage, **do not
86+
> clone your fork** to start off. We describe [how to setup your fork](#setting-up-your-fork)
87+
> in a subsection below.
8788
<!-- Recommending against cloning the fork due to https://github.com/apple/swift/issues/55918 and https://github.com/apple/swift/issues/55947. -->
8889
3. Double-check that `swift`'s sibling directories are present.
8990
```sh
@@ -106,10 +107,10 @@ toolchain as a one-off, there are a couple of differences:
106107
Detailed branching information, including names for release branches, can
107108
be found in [Branches.md](/docs/Branches.md).
108109
109-
**Note:**
110-
The commands used in the rest of this guide assumes that the absolute path
111-
to your working directory is something like `/path/to/swift-project/swift`.
112-
Double-check that running `pwd` prints a path ending with `swift`.
110+
> **Note**
111+
> The commands used in the rest of this guide assumes that the absolute path
112+
> to your working directory is something like `/path/to/swift-project/swift`.
113+
> Double-check that running `pwd` prints a path ending with `swift`.
113114
114115
[uploaded your SSH keys to GitHub]: https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/
115116
@@ -173,8 +174,9 @@ Double-check that running `pwd` prints a path ending with `swift`.
173174
sudo chmod +x /usr/local/bin/sccache
174175
```
175176

176-
**Note:** LLDB currently requires at least `swig-1.3.40` but will
177-
gsuccessfully build with version 2 shipped with Ubuntu.
177+
> **Note**
178+
> LLDB currently requires at least `swig-1.3.40` but will successfully build
179+
> with version 2 shipped with Ubuntu.
178180

179181
[Sccache]: https://github.com/mozilla/sccache
180182

@@ -258,7 +260,7 @@ Phew, that's a lot to digest! Now let's proceed to the actual build itself!
258260
containing the Swift compiler and standard library and clang/LLVM build artifacts.
259261
If the build fails, see [Troubleshooting build issues](#troubleshooting-build-issues).
260262

261-
> **Note:**
263+
> **Note**
262264
> `--release-debuginfo` means that although debug information will be produced, all targets will
263265
> be compiled in release mode, meaning optimized code, which can affect your debugging experience.
264266
> Consider [`--debug-swift` to build a debug variant of the compiler](#debugging-issues) and have

0 commit comments

Comments
 (0)