Skip to content

Commit

Permalink
;doc: update changelogs
Browse files Browse the repository at this point in the history
  • Loading branch information
simonmichael committed Oct 31, 2024
1 parent a9a4fd2 commit 659e493
Show file tree
Hide file tree
Showing 5 changed files with 82 additions and 14 deletions.
2 changes: 1 addition & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ General changes in the hledger project.
For package-specific changes, see the hledger package changelogs.


# ceeea6926
# 75fd38665

Docs

Expand Down
2 changes: 1 addition & 1 deletion hledger-lib/CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Internal/api/developer-ish changes in the hledger-lib (and hledger) packages.
For user-visible changes, see the hledger package changelog.


# 17dd3d434
# 75fd38665

Breaking changes

Expand Down
17 changes: 14 additions & 3 deletions hledger-ui/CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ User-visible changes in hledger-ui.
See also the hledger changelog.


# f54805a03
# 75fd38665

Breaking changes

- When built with ghc 9.10.1, hledger error messages are displayed with an extra trailing newline.
- When built with ghc 9.10.1, hledger error messages are displayed with two extra trailing newlines.

Fixes

Expand All @@ -35,9 +35,20 @@ Fixes

Features

- Added helix as a supported editor for the `e` key. (amano.kenji)

Improvements

- Support ghc 9.10 / base 4.20.
- Added --pager and --color options as in hledger, affecting command line help.
Also --color=no forces use of the "terminal" theme.

- Disabled the unused `ghcdebug` build flag and ghc-debug support, for now.

- Added a new `debug` build flag. Builds made with ghc 9.10+ and this flag
will show some kind of partial stack trace if the program exits with an error.
These will improve in future ghc versions.

- ghc 9.10 / base 4.20 are now supported.

- Avoid brick 2.3.2, which doesn't build on windows.

Expand Down
14 changes: 11 additions & 3 deletions hledger-web/CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ User-visible changes in hledger-web.
See also the hledger changelog.


# f54805a03
# 75fd38665

Breaking changes

- When built with ghc 9.10.1, hledger error messages are displayed with an extra trailing newline.
- When built with ghc 9.10.1, hledger error messages are displayed with two extra trailing newlines.

Fixes

Expand All @@ -38,7 +38,15 @@ Features

Improvements

- Support ghc 9.10 / base 4.20.
- Added --pager and --color options as in hledger, affecting command line help.

- Disabled the unused `ghcdebug` build flag and ghc-debug support, for now.

- Added a new `debug` build flag. Builds made with ghc 9.10+ and this flag
will show some kind of partial stack trace if the program exits with an error.
These will improve in future ghc versions.

- ghc 9.10 / base 4.20 are now supported.

Docs

Expand Down
61 changes: 55 additions & 6 deletions hledger/CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ API
User-visible changes in the hledger command line tool and library.


# 71a787921
# 75fd38665

Breaking changes

Expand All @@ -50,7 +50,7 @@ Breaking changes
2000-01-01
(a) 105525 C ; right

- When built with ghc 9.10.1, hledger error messages are displayed with an extra trailing newline.
- When built with ghc 9.10.1, hledger error messages are displayed with two extra trailing newlines.

Fixes

Expand All @@ -76,15 +76,41 @@ Fixes
- hledger's bash shell completions are now up to date with latest options.
[#986]

- When showing output with a pager, if `$PAGER` is set to something not found in PATH,
we now ignore it instead of raising an error.

Features

- When generating HTML output with the balance commands,
- `print`, `register` and `aregister` now support HTML and FODS output.
Now all of the "STANDARD REPORTS" commands, and the `balance` command, support text, HTML, CSV, TSV, or FODS output.
(Henning Thielemann)

- When generating HTML output with the register or balance commands,
the `--base-url` option will add hyperlinks to hledger-web,
allowing you to view the detailed transactions if you have hledger-web running.
(Henning Thielemann)

- In unix-like environments, hledger now uses a pager (`$PAGER`, `less`, or `more`)
for all large terminal output, not just for help.
You can override this with the new `--pager` option.
Note, if you use a pager other than `less`, you might need to configure it to display ANSI colour.

Improvements

- The `--color` option now works in config files.
(Except for debug output, currently.)

- The `--color` option's recommended values are now `yes`/`y`/`no`/`n`/`auto`/`a`.
The `always`/`never` spellings are no longer documented, though still supported.

- The `-NUM` shortcut for `--depth NUM` now works in config files.

- `aregister` now supports FODS output (Henning Thielemann)

- `aregister` has a new `--header=YN` option, for disabling the report heading. (Henning Thielemann)

- `aregister` now supports the `--invert` and `--cumulative` flags, like the `register` command. (Henning Thielemann)

- `bs`/`bse`/`cf`/`is` now support FODS output.
(Henning Thielemann)

Expand All @@ -98,25 +124,48 @@ Improvements
- Balance commands now support `--transpose` when generating HTML output.
(Henning Thielemann)

- The `balance` command's `--layout=tidy` now affects HTML and FODS output at least to some extent (not just CSV output).
And it always disables the totals row. (Henning Thielemann)

- The `balance` command's FODS output now picks a report title based on the report mode:
"Balance Report", "Multi-period Balance Report", or "Budget Report". (Henning Thielemann)

- `balance` and `aregister`'s HTML output will now use a hledger.css file if present, like `bs`/`bse`/`cf`/`is`.

- `bs`/`bse`/`cf`/`is` now support the `--count` (postings count) report type, like `balance`.

- Balance commands' options help has had some consistency/readability tweaks.

- hledger now supports GHC 9.10.
- The "equity:conversion" account, and its variations "equity:trade(s)" and "equity:trading",
which by default are detected as `V`/`Conversion` type, now revert to ordinary `E`/`Equity` accounts
if some other account is declared with the `V` type.

- The error message from `check accounts` was simplified a little.

- Disabled the unused `ghcdebug` build flag and ghc-debug support, for now.

- Added a new `debug` build flag. Builds made with ghc 9.10+ and this flag
will show some kind of partial stack trace if the program exits with an error.
These will improve in future ghc versions.

- ghc 9.10 / base 4.20 are now supported.

Docs

- output formats:beancount: mention operating_currency
- output formats: expand, document beancount and FODS output
- Regular expressions: note possible RTL/bidi limitation (?)
- Special characters: rewrite, more precision, mention some Windows differences
- Output formats: expand, document beancount and FODS output
- Text output: expand/consolidate terminal topics
- FODS output: describe the advantages over CSV (Henning Thielemann)
- Debug output: note that the --debug option doesn't work in config files.
- bal: improve --layout doc
- bal: note that tree mode doesn't work in html output [#1846]
- bal: also mention hledger.css and text encoding in balance doc
- html: note safari text encoding issue
- timedot: mention the common journal+timedot file setup [#2238]
- Install, manual: new shell completions doc. [#986]
- Config files: rewrite [#2231]
- examples/csv: an example of YNAB 4 data, and RTL text, with a workaround
- examples: hledger2beancount.conf

Scripts/addons
Expand Down

0 comments on commit 659e493

Please sign in to comment.