summaryrefslogtreecommitdiffstats
path: root/tapset/proc_mem.stp
diff options
context:
space:
mode:
authorMark Wielaard <mjw@redhat.com>2009-10-09 14:31:18 +0200
committerMark Wielaard <mjw@redhat.com>2009-10-09 14:31:18 +0200
commiteb5363b8f07d51caeb263c6a686c9a2556aa4c05 (patch)
tree794d959ea249342b114696e905878c8af74cc677 /tapset/proc_mem.stp
parente34d5d1388d3c7817313685e3f7424ffc158474f (diff)
downloadsystemtap-steved-eb5363b8f07d51caeb263c6a686c9a2556aa4c05.tar.gz
systemtap-steved-eb5363b8f07d51caeb263c6a686c9a2556aa4c05.tar.xz
systemtap-steved-eb5363b8f07d51caeb263c6a686c9a2556aa4c05.zip
tapset/proc_mem.stp: Document function parameters.
Diffstat (limited to 'tapset/proc_mem.stp')
-rw-r--r--tapset/proc_mem.stp2
1 files changed, 2 insertions, 0 deletions
diff --git a/tapset/proc_mem.stp b/tapset/proc_mem.stp
index 1493bd92..7641ffe2 100644
--- a/tapset/proc_mem.stp
+++ b/tapset/proc_mem.stp
@@ -134,6 +134,7 @@ function _stp_number_to_string_postfix:string (x:long, y:long, p:string)
/**
* sfunction bytes_to_string - Human readable string for given bytes.
+ * @bytes: Number of bytes to translate.
*
* Description: Returns a string representing the number of bytes (up
* to 1024 bytes), the number of kilobytes (when less than 1024K)
@@ -166,6 +167,7 @@ function bytes_to_string:string (bytes:long)
/**
* sfunction pages_to_string - Turns pages into a human readable string.
+ * @pages: Number of pages to translate.
*
* Description: Multiplies pages by page_size() to get the number of
* bytes and returns the result of bytes_to_string().