doc: changelogs

This commit is contained in:
Simon Michael 2019-02-01 16:57:52 -08:00
parent 022dc09f11
commit ca0d0b0d81
6 changed files with 90 additions and 108 deletions

View File

@ -1,64 +1,49 @@
General/project-related changes in the hledger project.
For package-specific changes, see the package changelogs.
# afd7cae1
# 1.13 (2019/01/02)
- install: fix "stack" installation when .local/bin is not in PATH (Dmitry Astapov)
- packaging: A docker image providing the main hledger tools is now
linked on the download page. This is another way to get up-to-date
hledger tools without building them yourself (and, a way to run
hledger-ui on windows ?) (Dmitry Astapov, Simon Michael)
- package: added helper scripts in docker/ (Dmitry Astapov)
- hledger-install.sh: fix installation of stack when .local/bin is not
in PATH (Dmitry Astapov)
- cli: command help: reduce width, line wrapping
cmdargs wraps any lines longer than 78 characters. To (mostly) avoid
this, we now display verbatim blocks unindented, and some of
register's examples have been altered to make them fit.
- doc: fixed pandoc typography conversion in web manuals. Eg `--` was
being rendered as en-dash. (#954).
- shake: Shake PKG (or Shake build) builds packages plus their docs
"stack build hledger" will not notice changes in documentation source
files (like hledger/Hledger/Cli/Commands/Add.md or
hledger-lib/hledger_journal.m4.md), but "./Shake hledger" will.
"./Shake build" builds all the packages, like a doc-aware "stack build".
- make: ghci-shake
- package: added Dockerfile (Dmitry Astapov)
- site: download: link adept's & other docker images
- site: download: link sandstorm
- site: download: platform headings
- site: download: fix the TOC links
- site: home: link download page
I accidentally the link.
- make: include Shake.hs in tags
- fixed pandoc typography conversion in web manuals (#954).
Eg `--` was being rendered as en-dash.
Developers:
- developer docs have moved from the wiki into CONTRIBUTING.md (#920)
- new streamlined changelog update process.
"make changelogs" updates the project-wide and package changelogs,
inserting new commits at the top, formatted as changelog entries.
New commits means commits touching that directory since the tag
version or commit hash which is the first word in the changelog's
previous top-most heading.
- new streamlined changelog update process. Shake targets:
./Shake changelogs
./Shake CHANGES.md
./Shake CHANGES.md-dry
./Shake PKG/CHANGES.md
./Shake PKG/CHANGES.md-dry
- new command documentation process.
Commands' CLI help and manual section are now generated from the same
source (just the `close` command so far).
update the project-wide and/or package changelogs, inserting new
commits (touching the respective directory, since the tag version or
commit hash which is the first word in the changelog's previous top
heading) at the top, formatted as changelog entries.
- doc files and hpack/cabal files are included in TAGS again
- ./Shake PKG - builds a package plus its embedded docs.
./Shake build - builds all the packages and their embedded docs.
("stack build PKG" does not notice changes in embedded doc files.)
- make ghci-shake - loads Shake.hs in ghci
- make tags - includes doc source files, hpack/cabal files, Shake.hs
- make site-livereload - opens a reloading browser view on the website html
(requires `livereloadx`)
- site: home: focus on "robust"
- site: remove the wasteful top nav bar, mostly
- added a Dockerfile and helper scripts (Dmitry Astapov)
- doc files and hpack/cabal files are included in TAGS again
# 1.12 (2018/12/02)

View File

@ -1,9 +1,9 @@
User-visible changes in hledger-api.
See also the hledger changelog.
# 9fe32129
# 1.13 (2019/02/01)
- use hledger 1.12.99
- use hledger 1.13
# 1.12 (2018/12/02)

View File

@ -1,21 +1,28 @@
Internal/api/developer-ish changes in the hledger-lib package.
Internal/api/developer-ish changes in the hledger-lib (and hledger) packages.
For user-visible changes, see the hledger package changelog.
# 9fe32129
# 1.13 (2019/02/01)
added:
- in Journal's jtxns field, forecasted txns are appended rather than prepended
- setFullPrecision
- setMinimalPrecision
- expectParseStateOn
- embedFileRelative
- hereFileRelative
- API changes:
changed:
added:
+setFullPrecision
+setMinimalPrecision
+expectParseStateOn
+embedFileRelative
+hereFileRelative
changed:
- amultiplier -> aismultiplier
- Amount fields reordered for clearer debug output
- tpreceding_comment_lines -> tprecedingcomment, reordered
- Hledger.Data.TransactionModifier.transactionModifierToFunction -> modifyTransactions
- Hledger.Read.Common.applyTransactionModifiers -> Hledger.Data.Journal.journalModifyTransactions
- HelpTemplate -> CommandDoc
- amultiplier -> aismultiplier
- Amount fields reordered for clearer debug output
- tpreceding_comment_lines -> tprecedingcomment, reordered
# 1.12 (2018/12/02)

View File

@ -1,15 +1,15 @@
User-visible changes in hledger-ui.
See also the hledger changelog.
# 9fe32129
# 1.13 (2019/02/01)
- on posix systems, control-z suspends the program
- control-l now works everywhere and redraws more reliably
- show clearer top status info
- the top status info is clearer
- use hledger 1.12.99
- use hledger 1.13
# 1.12.1 (2018/12/10)

View File

@ -1,9 +1,9 @@
User-visible changes in hledger-web.
See also the hledger changelog.
# 9fe32129
# 1.13 (2019/02/01)
- use hledger 1.12.99
- use hledger 1.13
# 1.12 (2018/12/02)

View File

@ -1,62 +1,30 @@
User-visible changes in the hledger command line tool and library.
# 5435150d
# 1.13 (2019/02/01)
- cli: command help: reduce width, line wrapping
cmdargs wraps any lines longer than 78 characters. To (mostly) avoid
this, we now display verbatim blocks unindented, and some of
register's examples have been altered to make them fit.
- cli: reorganised commands list. Addons now have a + prefix.
- cli: render command help as plain text, hiding markup
This means committing a bunch more generated files, but it's probably
worthwhile, so we can have both rich hyperlinked/styled command docs
and clean readable command help.
- cli: the command line help and manual section for all hledger's
commands are now consistent, and generated from the same source.
- cli: commands list: update, reorganise, show addons prefixed with +
- doc: integrate CLI help & manual for remaining commands
- renamed HelpTemplate -> CommandDoc
- journal: account directive: account sort codes like `account 1000`
are no longer supported. (introduced in 1.9, deprecated in 1.11)
- journal: account directive: the account name can now be followed by
a comment on the same line
- journal: account directive: account types can now be set with a
`type:` tag, whose value is `Asset`, `Liability`, `Equity`,
`Revenue`, `Expense`, `A`, `L`, `E`, `R` or `X` (case-insensitive).
The previous syntax (`account assets A`) is now deprecated.
- journal: transaction modifiers can affect periodic transactions
(--auto can add postings to transactions generated with --forecast).
(Dmitry Astapov)
- journal: fixed a periodic transaction parsing failure (Dmitry
Astapov)
- journal: balance assertion errors now show exact amounts with all
decimal digits. Previously it was possible, in case of a commodity
directive limiting the display precision, to have a balance
assertion error with asserted and actual amounts looking the
same. (#941)
- cli: comprehensive bash completion support is now provided (in
shell-completion/). See how-to in the Cookbook. (Jakob Schöttl)
- balance --budget: budget amounts now aggregate hierarchically, like
account balances. Unbudgeted accounts can be shown with -E/--empty
(along with zero-balance accounts), and the --show-budgeted flag has
been dropped. (Dmitry Astapov)
- balance: a new --transpose flag switches the rows and columns of
tabular balance reports (in txt and csv output formats) (Dmitry
- balance: new --transpose flag switches the rows and columns of
tabular balance reports (in txt and csv output formats). (Dmitry
Astapov)
- close: generated balance assertions now have exact amounts with all
decimal digits, ignoring display precision. Also, balance assertion
amounts will no longer contain prices. (#941, #824, #958)
- files: added this command to the commands list
- files: now shows up in the commands list
- import: be silent when there's nothing to import
@ -65,8 +33,30 @@ User-visible changes in the hledger command line tool and library.
- stats, ui: correct file order is preserved when using --auto (#949)
- comprehensive bash completion support is now provided (in the
hledger repo, see shell-completion/) (Jakob Schöttl)
- journal: account directive: the account name can now be followed by
a comment on the same line
- journal: account directive: account types for the bs/bse/cf/is
commands can now be set with a `type:` tag, whose value is `Asset`,
`Liability`, `Equity`, `Revenue`, `Expense`, `A`, `L`, `E`, `R` or
`X` (case-insensitive). The previous syntax (`account assets A`) is
now deprecated.
- journal: account directive: account sort codes like `account 1000`
(introduced in 1.9, deprecated in 1.11) are no longer supported.
- journal: transaction modifiers (auto postings) can affect periodic
transactions (--auto can add postings to transactions generated with
--forecast). (Dmitry Astapov)
- journal: balance assertion errors now show exact amounts with all
decimal digits. Previously it was possible, in case of a commodity
directive limiting the display precision, to have a balance
assertion error with asserted and actual amounts looking the
same. (#941)
- journal: fixed a periodic transaction parsing failure (#942) (Dmitry
Astapov)
# 1.12.1 (2018/12/03)