rustwasm/book

Add section about debugging memory leaks

Open

#166 opened on May 10, 2019

View on GitHub
 (0 comments) (8 reactions) (0 assignees)Handlebars (215 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (1,832 stars)
PR merge metrics
 (PR metrics pending)

Description

Recently we gained two new helpful tools for debugging memory leaks:

We should add a reference guide for boosting their visibility and explaining how to use them a little bit. Maybe even have an example code that intentionally leaks, use the tools to diagnose the leak, and then show the fix.

Contributor guide

Research direction
Examine the linked pull request and tool repositories to understand the debugging tools, then write a guide with an example of intentional memory leak detection and fix.
Tech stack
rust
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustWebAssembly
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60