Document smaps_lib

Reported-by: Guy Streeter <streeter@redhat.com>
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>

1 files changed, 9 insertions, 0 deletions

diff --git a/procfs/procfs.py b/procfs/procfs.py
index 6b83151..86813a1 100755
--- a/procfs/procfs.py
+++ b/procfs/procfs.py
@@ -719,6 +719,15 @@ class cpuinfo:
 		self.nr_cores = ("cpu cores" in self.tags and int(self.tags["cpu cores"]) or 1) * self.nr_sockets
 
 class smaps_lib:
+	"""
+	Representation of an mmap in place for a process. Can be used to figure
+	out which processes have an library mapped, etc.
+
+	The 'perm' member can be used to figure out executable mmaps, i.e. libraries.
+
+	The 'vm_start' and 'vm_end' in turn can be used when trying to resolve
+	processor instruction pointer addresses to a symbol name in a library.
+	"""
 	def __init__(self, lines):
 		fields = lines[0].split()
 		self.vm_start, self.vm_end = map(lambda a: int(a, 16), fields[0].split("-"))