mwrap user+dev discussion/patches/pulls/bugs/help
 help / color / Atom feed
From: Eric Wong <e@80x24.org>
To: <mwrap-public@80x24.org>
Subject: [PATCH] doc: 2.1 pre-release updates
Date: Sat, 11 Aug 2018 04:08:14 +0000
Message-ID: <20180811040814.29656-1-e@80x24.org> (raw)

Mwrap.total_bytes_allocated/total_bytes_freed API needs docs,
and we need to clarify heap page stats are not reset.
---
 ext/mwrap/mwrap.c | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/ext/mwrap/mwrap.c b/ext/mwrap/mwrap.c
index cbda436..2ee04a5 100644
--- a/ext/mwrap/mwrap.c
+++ b/ext/mwrap/mwrap.c
@@ -1193,11 +1193,17 @@ static VALUE mwrap_quiet(VALUE mod)
 	return rb_ensure(rb_yield, SIZET2NUM(cur), reset_locating, 0);
 }
 
+/*
+ * total bytes allocated as tracked by mwrap
+ */
 static VALUE total_inc(VALUE mod)
 {
 	return SIZET2NUM(total_bytes_inc);
 }
 
+/*
+ * total bytes freed as tracked by mwrap
+ */
 static VALUE total_dec(VALUE mod)
 {
 	return SIZET2NUM(total_bytes_dec);
@@ -1338,6 +1344,10 @@ void Init_mwrap(void)
 	 * from posix_memalign(3) use in mainline Ruby:
 	 *
 	 *   https://sourceware.org/bugzilla/show_bug.cgi?id=14581
+	 *
+	 * These statistics are never reset by Mwrap.reset or
+	 * any other method.  They only make sense in the context
+	 * of an entire program lifetime.
 	 */
 	hpb = rb_define_class_under(mod, "HeapPageBody", rb_cObject);
 	rb_define_singleton_method(hpb, "stat", hpb_stat, -1);
-- 
EW


                 reply index

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://80x24.org/mwrap/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180811040814.29656-1-e@80x24.org \
    --to=e@80x24.org \
    --cc=mwrap-public@80x24.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

mwrap user+dev discussion/patches/pulls/bugs/help

Archives are clonable:
	git clone --mirror https://80x24.org/mwrap-public/0 mwrap-public/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 mwrap-public mwrap-public/ https://80x24.org/mwrap-public \
		mwrap-public@80x24.org
	public-inbox-index mwrap-public

Example config snippet for mirrors

Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.lang.ruby.mwrap
	nntp://ou63pmih66umazou.onion/inbox.comp.lang.ruby.mwrap

 note: .onion URLs require Tor: https://www.torproject.org/

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git