Skip to content

Commit 9d60e16

Browse files
committed
doc: Quirks
1 parent fd5f5bb commit 9d60e16

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,10 @@ The [parallel-disk-usage crate](https://crates.io/crates/parallel-disk-usage) is
115115

116116
Alternatively, the `pdu` command provides `--json-input` flag and `--json-output` flag. The `--json-output` flag converts disk usage data into JSON and the `--json-input` flag turns said JSON into visualization. These 2 flags allow integration with other CLI tools (via pipe, as per the UNIX philosophy).
117117

118+
Beware that the structure of the JSON tree differs depends on the number of file/directory names that were provided (as CLI arguments):
119+
* If there are only 0 or 1 file/directory names, the name of the tree root would be a real path (either `.` or the provided name).
120+
* If there are 2 or more file/directory names, the name of the tree root would be `(total)` (which is not a real path), and the provided names would correspond to the children of the tree root.
121+
118122
## Installation
119123

120124
### Any Desktop OS

0 commit comments

Comments
 (0)