summaryrefslogtreecommitdiffhomepage
path: root/pkg/sentry/fs
diff options
context:
space:
mode:
authorMichael Pratt <mpratt@google.com>2018-07-12 10:36:16 -0700
committerShentubot <shentubot@google.com>2018-07-12 10:37:21 -0700
commit41e0b977e5ffc667750c0f706bb70173c5de2161 (patch)
tree0684cdc1122057eb8d2651943cfe513256d9e26c /pkg/sentry/fs
parentb363799bd879a7c36a87bc4a91f5c45c91ad6473 (diff)
Format documentation
PiperOrigin-RevId: 204323728 Change-Id: I1ff9aa062ffa12583b2e38ec94c87db7a3711971
Diffstat (limited to 'pkg/sentry/fs')
-rw-r--r--pkg/sentry/fs/README.md8
-rw-r--r--pkg/sentry/fs/proc/README.md5
2 files changed, 8 insertions, 5 deletions
diff --git a/pkg/sentry/fs/README.md b/pkg/sentry/fs/README.md
index 898271ee8..76638cdae 100644
--- a/pkg/sentry/fs/README.md
+++ b/pkg/sentry/fs/README.md
@@ -149,10 +149,10 @@ An `fs.File` references the following filesystem objects:
fs.File -> fs.Dirent -> fs.Inode -> fs.MountedFilesystem
```
-The `fs.Inode` is restored using its `fs.MountedFilesystem`. The [Mount
-points](#mount-points) section above describes how this happens in detail. The
-`fs.Dirent` restores its pointer to an `fs.Inode`, pointers to parent and
-children `fs.Dirents`, and the basename of the file.
+The `fs.Inode` is restored using its `fs.MountedFilesystem`. The
+[Mount points](#mount-points) section above describes how this happens in
+detail. The `fs.Dirent` restores its pointer to an `fs.Inode`, pointers to
+parent and children `fs.Dirents`, and the basename of the file.
Otherwise an `fs.File` restores flags, an offset, and a unique identifier (only
used internally).
diff --git a/pkg/sentry/fs/proc/README.md b/pkg/sentry/fs/proc/README.md
index 6ad7297d2..cec842403 100644
--- a/pkg/sentry/fs/proc/README.md
+++ b/pkg/sentry/fs/proc/README.md
@@ -6,6 +6,7 @@ procfs generally.
inconsistency, please file a bug.
[TOC]
+
## Kernel data
The following files are implemented:
@@ -91,6 +92,7 @@ Num currently running processes | Always zero
Total num processes | Always zero
TODO: Populate the columns with accurate statistics.
+
### meminfo
```bash
@@ -122,7 +124,7 @@ Shmem: 0 kB
Notable divergences:
Field name | Notes
-:---------------- | :--------------------------------------------------------
+:---------------- | :-----------------------------------------------------
Buffers | Always zero, no block devices
SwapCache | Always zero, no swap
Inactive(anon) | Always zero, see SwapCache
@@ -182,6 +184,7 @@ softirq 0 0 0 0 0 0 0 0 0 0 0
```
All fields except for `btime` are always zero.
+
TODO: Populate with accurate fields.
### sys