summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBradley M. Kuhn <bkuhn@ebb.org>2012-09-14 16:54:12 -0400
committerBradley M. Kuhn <bkuhn@ebb.org>2012-09-14 16:54:12 -0400
commit06356ebf90bb051b2cfef09dbed646fd4c31a759 (patch)
treeee3c2b98a2f574def4b00d360fbd662894138905
parent438806ac71a9a56645d824d2dbebb2bd565155ce (diff)
downloadledger-06356ebf90bb051b2cfef09dbed646fd4c31a759.tar.gz
ledger-06356ebf90bb051b2cfef09dbed646fd4c31a759.tar.bz2
ledger-06356ebf90bb051b2cfef09dbed646fd4c31a759.zip
Make reference and link to Bug Report #789 in fixed directive documentation.
Due to weirdness that's currently true with the existing next branch of ledger, I believe it's important to tell users in the documentation that there are some discrepancies in the 'fixed' directive behavior. The documentation from my previous commit is written to explain what 'fixed' *should* do; adding the bug report link here is a placeholder to tell users that it may not do what they think it does. Obviously, if someone closes #789, they should remove this paragraph added herein. But, if the bug report is closed, but the documentation lags behind, the worst that happens is some users have to click through to see the bug is closed.
-rw-r--r--doc/ledger3.texi4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/ledger3.texi b/doc/ledger3.texi
index d4c89951..9a91d79e 100644
--- a/doc/ledger3.texi
+++ b/doc/ledger3.texi
@@ -2078,6 +2078,10 @@ Note that ending a @samp{fixed} is done differently than other
directives, as @samp{fixed} is closed with an @samp{endfixed} (i.e.,
there is @strong{no space} between @samp{end} and @samp{fixed}).
+For the moment, users may wish to study
+@uref{http://bugs.ledger-cli.org/show_bug.cgi?id=789, Bug Report 789}
+before using the @samp{fixed} directive in production.
+
@item include
@c instance_t::include_directive in textual.cc
Include the stated file as if it were part of the current file.