Add timeout to perf_buffer_poll docs

GaoHuijian · Apr 19, 2019 · e76a7c7 · e76a7c7
1 parent 440268e
commit e76a7c7
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/docs/reference_guide.md b/docs/reference_guide.md
@@ -1244,10 +1244,12 @@ Normal output from a BPF program is either:
 
 ### 1. perf_buffer_poll()
 
-Syntax: ```BPF.perf_buffer_poll()```
+Syntax: ```BPF.perf_buffer_poll([timeout])```
 
 This polls from all open perf ring buffers, calling the callback function that was provided when calling open_perf_buffer for each entry.
 
+The timeout parameter is optional and measured in milliseconds.
+
 Example:
 
 ```Python