summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRahix <rahix@rahix.de>2020-05-13 00:49:15 +0200
committerJohn Wiegley <johnw@newartisans.com>2020-07-21 14:50:01 -0700
commit41ca4a7551cdc0e06496006d2adb1f62ba5dab5b (patch)
treee5befae781f1db7851b180bcbe0e6ae8d0591931 /doc
parentfa5073ecdc1c53705a434e82e9beddf70a7a80a1 (diff)
downloadfork-ledger-41ca4a7551cdc0e06496006d2adb1f62ba5dab5b.tar.gz
fork-ledger-41ca4a7551cdc0e06496006d2adb1f62ba5dab5b.tar.bz2
fork-ledger-41ca4a7551cdc0e06496006d2adb1f62ba5dab5b.zip
docs: Document new --depth in register reports
Diffstat (limited to 'doc')
-rw-r--r--doc/ledger.15
-rw-r--r--doc/ledger3.texi4
2 files changed, 7 insertions, 2 deletions
diff --git a/doc/ledger.1 b/doc/ledger.1
index 29414b75..82241894 100644
--- a/doc/ledger.1
+++ b/doc/ledger.1
@@ -513,7 +513,10 @@ will print balances only for accounts with two levels, i.e.
but not
.Sy Expenses:Entertainment:Dining .
This is a display predicate, which means it only affects display,
-not the total calculations.
+not the total calculations. In register reports,
+.Fl \-depth
+will collapse postings of child accounts beyond the given level and add
+their balances to the parent account.
.It Fl \-detail
Related to
.Ic convert
diff --git a/doc/ledger3.texi b/doc/ledger3.texi
index ea053162..ce31f9aa 100644
--- a/doc/ledger3.texi
+++ b/doc/ledger3.texi
@@ -6468,7 +6468,9 @@ Limit the depth of the account tree. In a balance report, for example,
a @samp{--depth 2} statement will print balances only for accounts with
two levels, i.e. @samp{Expenses:Entertainment} but not
@samp{Expenses:Entertainment:Dining}. This is a display predicate, which
-means it only affects display, not the total calculations.
+means it only affects display, not the total calculations. In register
+reports, @samp{--depth} will collapse postings of child accounts beyond
+the given level and add their balances to the parent account.
@item --deviation
Report each posting’s deviation from the average. It is only meaningful