Release Linux-Proc-Maps 0.002

[chaz/p5-Linux-Proc-Maps] / README.md

diff --git a/README.md b/README.md
index 3bc06f0fbf976f2b2b3b6f52a670b28c2392a089..5873c9bf6364dde831e03c931a28435391fd8231 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ Linux::Proc::Maps - Read and write /proc/\[pid\]/maps files
 
 # VERSION
 
-version 0.001
+version 0.002
 
 # SYNOPSIS
 
@@ -23,7 +23,7 @@ version 0.001
 
 This module reads and writes `/proc/[pid]/maps` files that contain listed mapped memory regions.
 
-# METHODS
+# FUNCTIONS
 
 ## read\_maps
 
@@ -89,6 +89,12 @@ This is the opposite of ["parse\_maps\_single\_line"](#parse_maps_single_line).
 
 [proc(5)](http://man.he.net/man5/proc) describes the file format.
 
+# 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.
+
 # BUGS
 
 Please report any bugs or feature requests on the bugtracker website