Browse code

Merge pull request #31973 from wsong/update_df_docs

Update system df docs to call out performance implications
(cherry picked from commit f453412bd8f161453981a828e989209c6cdf32f5)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Vincent Demeester authored on 2017/03/22 21:46:48
Showing 1 changed files
... ...
@@ -77,6 +77,15 @@ my-named-vol                                                       0
77 77
 > **Note**: Network information is not shown because it doesn't consume the disk
78 78
 > space.
79 79
 
80
+## Performance
81
+
82
+The `system df` command can be very resource-intensive. It traverses the
83
+filesystem of every image, container, and volume in the system. You should be
84
+careful running this command in systems with lots of images, containers, or
85
+volumes or in systems where some images, containers, or volumes have very large
86
+filesystems with many files. You should also be careful not to run this command
87
+in systems where performance is critical.
88
+
80 89
 ## Related commands
81 90
 * [system prune](system_prune.md)
82 91
 * [container prune](container_prune.md)