Overhauled allocations documentation for helpfulness #643
Conversation
RobinBateman808
requested review from
0xTim,
alexandersandberg,
daveverwer,
dempseyatgithub,
parispittman,
kaishin,
shahmishal,
cthielen and
federicobucchi
as code owners
|
@0xTim - made changes as suggested and corrected code formatting. |
|
|
||
| ```swift | ||
| An example program using AsyncHTTPClient can be written as: | ||
| ``` |
There was a problem hiding this comment.
Missing language on the code block, re-add
There was a problem hiding this comment.
@0xTim - Thanks for the review. I'm not sure what's happening with the code. I'm not making any changes to the blocks or text unless it was something you previously caught. Any suggestions or insight would be appreciated. :-)
There was a problem hiding this comment.
Adjusted space before code blocks. Preview of text renders language in code block.
|
|
||
| ```bash | ||
| In this instance, a user probe was installed for all allocation functions because Swift uses other functions like `calloc` and `posix_memalign`. | ||
| ``` |
There was a problem hiding this comment.
Missing language in the code block
There was a problem hiding this comment.
Adjusted space before code blocks. The text renders as it should.
| On Apple platforms, Swift uses a slightly larger number of allocation functions than Linux. Therefore, specifying a few more functions is required. | ||
|
|
||
| Once the data is collected, run this command to create an SVG file: | ||
| ``` |
There was a problem hiding this comment.
Not sure what you mean here. But removed "Therefore, specifying a few more functions is required." to mitigate confusion.
| perf script | \ | ||
| /FlameGraph/stackcollapse-perf.pl - | \ | ||
| swift demangle --simplified | \ | ||
| /FlameGraph/flamegraph.pl --countname allocations \ | ||
| --width 1600 > out.svg | ||
| --width 1600 > out.svg |
There was a problem hiding this comment.
Still missing the indentation
There was a problem hiding this comment.
Added indent again. Hoping it "sticks" this time.
Co-authored-by: Tim Condon <0xTim@users.noreply.github.com>
|
@0xTim - Hopefully, the latest changes will fix things. Thanks for your time and patience! :-) |
Motivation:
Edited documentation to improve helpfulness for new and experienced Swift on Server (SOS) users.
Modifications:
Added definitions and explanations where needed, edited existing content for clarity, and formatted for scannability.
Result:
Increase user adoption and bolster the SOS community.