document the possibility of integer overloading

[chaz/p5-Linux-Proc-Maps] / lib / Linux / Proc / Maps.pm

diff --git a/lib/Linux/Proc/Maps.pm b/lib/Linux/Proc/Maps.pm
index 21a3b12666c2fdffa00fe1b274ccab8782ca88d9..c09ed301c9a75dcc9787421f9b28b088b9fb39be 100644 (file)
--- a/lib/Linux/Proc/Maps.pm
+++ b/lib/Linux/Proc/Maps.pm
@@ -2,6 +2,7 @@ package Linux::Proc::Maps;
 # ABSTRACT: Read and write /proc/[pid]/maps files
 # KEYWORDS: linux proc procfs
 
+use 5.008;
 use warnings;
 use strict;
 
@@ -30,7 +31,7 @@ our @EXPORT_OK = qw(read_maps write_maps parse_maps_single_line format_maps_sing
 
 This module reads and writes F</proc/[pid]/maps> files that contain listed mapped memory regions.
 
-=method read_maps
+=func read_maps
 
 Read and parse a maps file, returning an arrayref of regions (each represented as a hashref). See
 L</parse_maps_single_line> to see the format of the hashrefs.
@@ -80,7 +81,7 @@ sub read_maps {
     return \@regions;
 }
 
-=method write_maps
+=func write_maps
 
 Returns a string with the contents of a maps file from the memory regions passed.
 
@@ -118,7 +119,7 @@ sub write_maps {
     return $out;
 }
 
-=method parse_maps_single_line
+=func parse_maps_single_line
 
 Parse and return a single line from a maps file into a region represented as a hashref.
 
@@ -179,7 +180,7 @@ sub parse_maps_single_line {
     };
 }
 
-=method format_maps_single_line
+=func format_maps_single_line
 
 Return a single line for a maps file from a region represented as a hashref.
 
@@ -205,6 +206,12 @@ sub format_maps_single_line {
 
 L<proc(5)> describes the file format.
 
+=head1 CAVEATS
+
+Integer overloading may occur if you try to parse memory regions from address spaces larger than
+your current architecture (or perl) supports. This is currently not fatal, though you will get
+warnings from perl that you probably shouldn't ignore.
+
 =cut
 
 1;