Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document debugging with allocation tests #1277

Merged
merged 1 commit into from Dec 2, 2019

Conversation

@weissi
Copy link
Member

weissi commented Nov 28, 2019

Motivation:

The tooling around the allocation counter tests is pretty opaque and
also not easy to use.

Modifications:

Document what interested folks should know.

Result:

More people will be able to debug allocations in SwiftNIO.

@weissi weissi requested review from Davidde94, glbrntt and Lukasa Nov 28, 2019
@weissi

This comment has been minimized.

Copy link
Member Author

weissi commented Nov 28, 2019

sorry guys, this is still a bit rough but I wanted to get something out ASAP for @2bjake :)

@weissi weissi added this to the 2.11.0 milestone Nov 29, 2019
@Lukasa
Lukasa approved these changes Nov 29, 2019
Copy link
Contributor

Lukasa left a comment

This looks really good! I've left some suggested changes in the diff just to help with wording and clean up some inconsistencies, but other than that I think we can call this ready to merge.

docs/debugging-allocations.md Outdated Show resolved Hide resolved
docs/debugging-allocations.md Outdated Show resolved Hide resolved
docs/debugging-allocations.md Outdated Show resolved Hide resolved
docs/debugging-allocations.md Outdated Show resolved Hide resolved
docs/debugging-allocations.md Outdated Show resolved Hide resolved
docs/debugging-allocations.md Outdated Show resolved Hide resolved
docs/debugging-allocations.md Outdated Show resolved Hide resolved
docs/debugging-allocations.md Outdated Show resolved Hide resolved
docs/debugging-allocations.md Outdated Show resolved Hide resolved
Copy link
Contributor

glbrntt left a comment

Great idea @weissi!

docs/debugging-allocations.md Show resolved Hide resolved
docs/debugging-allocations.md Outdated Show resolved Hide resolved
Motivation:

The tooling around the allocation counter tests is pretty opaque and
also not easy to use.

Modifications:

Document what interested folks should know.

Result:

More people will be able to debug allocations in SwiftNIO.

Co-Authored-By: Cory Benfield <lukasa@apple.com>
@weissi weissi force-pushed the weissi:jw-doc-alloc-tests branch from bb09400 to b35f4f7 Nov 29, 2019
@weissi

This comment has been minimized.

Copy link
Member Author

weissi commented Nov 29, 2019

thanks so much @Lukasa and @glbrntt for the reviews, took all feedback.

@richardalow

This comment has been minimized.

Copy link
Member

richardalow commented Nov 29, 2019

Very nice, it all makes sense to a newbie.

Copy link
Contributor

Davidde94 left a comment

Agree with Rich, makes sense to a newbie

@weissi weissi merged commit 6bd0a9e into apple:master Dec 2, 2019
4 checks passed
4 checks passed
pull request validation (5.0) Build finished.
Details
pull request validation (5.1) Build finished.
Details
pull request validation (api breakage) Build finished.
Details
pull request validation (sanity) Build finished.
Details
@weissi weissi deleted the weissi:jw-doc-alloc-tests branch Dec 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can’t perform that action at this time.