sparklemotion/nokogiri

[doc] Document memory management model

Open

#2183 opened on Feb 1, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Ruby (5,615 stars) (806 forks)batch import
help wantedtopic/documentation

Description

This issue comment should be expanded upon and made into a page explaining how we deal with libxml2's memory model within Ruby's mark-and-sweep GC model:

https://github.com/sparklemotion/nokogiri/issues/1952#issuecomment-770856928

Contributor guide

Tech stack
rubyc
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of Ruby's mark and sweep garbage collectionFamiliarity with libxml2 memory managementAccess to Nokogiri source code
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Read the linked comment at https://github.com/sparklemotion/nokogiri/issues/1952#issuecomment 770856928 and expand it into a documentation page. Review existing documentation in the docs/ folder for style and structure. Ensure the page explains how libxml2's memory model works with Ruby's garbage collector in Nokogiri.