From: David Mitchell <davem@iabyn.com>
Date: Mon, 16 Dec 2013 14:18:58 +0000 (+0000)
Subject: regexp.h: document the fields of reg_substr_datum
X-Git-Tag: upstream/5.20.0~464^2~66
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=c4828ca064b9f0fedfefdb69a599f1c8f59fd0f6;p=platform%2Fupstream%2Fperl.git

regexp.h: document the fields of reg_substr_datum

In particular, specify that the various offset fields are char rather
than byte counts.
---

diff --git a/regexp.h b/regexp.h
index b609136..eba5974 100644
--- a/regexp.h
+++ b/regexp.h
@@ -36,11 +36,11 @@ struct regexp_engine;
 struct regexp;
 
 struct reg_substr_datum {
-    SSize_t min_offset;
-    SSize_t max_offset;
+    SSize_t min_offset; /* min pos (in chars) that substr must appear */
+    SSize_t max_offset  /* max pos (in chars) that substr must appear */;
     SV *substr;		/* non-utf8 variant */
     SV *utf8_substr;	/* utf8 variant */
-    SSize_t end_shift;
+    SSize_t end_shift;  /* how many fixed chars must end the string */
 };
 struct reg_substr_data {
     struct reg_substr_datum data[3];	/* Actual array */