summaryrefslogtreecommitdiffstats
path: root/libnetdata/procfile/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'libnetdata/procfile/README.md')
-rw-r--r--libnetdata/procfile/README.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/libnetdata/procfile/README.md b/libnetdata/procfile/README.md
index 7487e6c63..3eeb1e205 100644
--- a/libnetdata/procfile/README.md
+++ b/libnetdata/procfile/README.md
@@ -1,3 +1,8 @@
+<!--
+title: "PROCFILE"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/procfile/README.md
+-->
+
# PROCFILE
procfile is a library for reading text data files (i.e `/proc` files) in the fastest possible way.
@@ -23,9 +28,9 @@ For each iteration, the caller:
- calls `procfile_readall()` to read updated contents.
This call also rewinds (`lseek()` to 0) before reading it.
- For every file, a [BUFFER](../buffer/) is used that is automatically adjusted to fit
- the entire file contents of the file. So the file is read with a single `read()` call
- (providing atomicity / consistency when the data are read from the kernel).
+ For every file, a [BUFFER](/libnetdata/buffer/README.md) is used that is automatically adjusted to fit the entire
+ file contents of the file. So the file is read with a single `read()` call (providing atomicity / consistency when
+ the data are read from the kernel).
Once the data are read, 2 arrays of pointers are updated: