checkdates: docs

2017-09-12 18:24:22 -07:00 · 2017-09-12 18:24:22 -07:00 · b4d70731e8
commit b4d70731e8
parent 3dc8dc428a
7 changed files with 220 additions and 203 deletions
--- a/hledger/Hledger/Cli/Commands/Checkdates.hs
+++ b/hledger/Hledger/Cli/Commands/Checkdates.hs
@ -23,7 +23,7 @@ import Text.Printf
 -- checkdatesmode :: Mode RawOpts
 checkdatesmode = hledgerCommandMode
  [here| check-dates
-Check that transactions' dates are monotonically increasing.
+Check that transactions are sorted by increasing date.
 With --date2, checks secondary dates instead.
 With --strict, dates must also be unique.
 With a query, only matched transactions' dates are checked.
--- a/hledger/doc/addons.m4.md
+++ b/hledger/doc/addons.m4.md
@ -89,11 +89,6 @@ is an old pie chart generator, in need of some love.
 [hledger-check.hs](https://github.com/simonmichael/hledger/blob/master/bin/hledger-check.hs)
 checks more powerful account balance assertions.

-### check-dates
-
-[hledger-check-dates.hs](https://github.com/simonmichael/hledger/blob/master/bin/hledger-check-dates.hs#L15)
-checks that journal entries are ordered by date.
-
 ### check-dupes

 [hledger-check-dupes.hs](https://github.com/simonmichael/hledger/blob/master/bin/hledger-check-dupes.hs#L21)
--- a/hledger/doc/commands.m4.md
+++ b/hledger/doc/commands.m4.md
@ -12,6 +12,10 @@ incomestatement`). You can also write any unambiguous prefix of a
 command name (`hledger inc`), or one of the standard short aliases
 displayed in the command list (`hledger is`).

+Here are all the builtin commands in alphabetical order.
+See also `hledger` for a more organised command list,
+and `hledger CMD -h` for detailed command help.  
+
 <!--
 ---
 comment:
@ -337,6 +341,10 @@ Normally cashflow shows changes in assets per period, though
 as with [multicolumn balance reports](#multicolumn-balance-reports)
 you can alter the report mode with `--change`/`--cumulative`/`--historical`.

+## check-dates
+Check that transactions are sorted by increasing date.
+With a query, only matched transactions' dates are checked.
+
 ## help
 Show any of the hledger manuals.

--- a/hledger/doc/hledger.1
+++ b/hledger/doc/hledger.1
@ -1089,6 +1089,10 @@ Run a subcommand by writing its name as first argument (eg
 You can also write any unambiguous prefix of a command name
 (\f[C]hledger\ inc\f[]), or one of the standard short aliases displayed
 in the command list (\f[C]hledger\ is\f[]).
+.PP
+Here are all the builtin commands in alphabetical order.
+See also \f[C]hledger\f[] for a more organised command list, and
+\f[C]hledger\ CMD\ \-h\f[] for detailed command help.
 .SS accounts
 .PP
 Show account names.
@ -1891,6 +1895,10 @@ report period.
 Normally cashflow shows changes in assets per period, though as with
 multicolumn balance reports you can alter the report mode with
 \f[C]\-\-change\f[]/\f[C]\-\-cumulative\f[]/\f[C]\-\-historical\f[].
+.SS check\-dates
+.PP
+Check that transactions are sorted by increasing date.
+With a query, only matched transactions\[aq] dates are checked.
 .SS help
 .PP
 Show any of the hledger manuals.
@ -2452,10 +2460,6 @@ hledger\-chart.hs is an old pie chart generator, in need of some love.
 .SS check
 .PP
 hledger\-check.hs checks more powerful account balance assertions.
-.SS check\-dates
-.PP
-hledger\-check\-dates.hs checks that journal entries are ordered by
-date.
 .SS check\-dupes
 .PP
 hledger\-check\-dupes.hs checks for account names sharing the same leaf
--- a/hledger/doc/hledger.1.info
+++ b/hledger/doc/hledger.1.info
@ -783,6 +783,10 @@ be listed as subcommands.
 incomestatement').  You can also write any unambiguous prefix of a
 command name ('hledger inc'), or one of the standard short aliases
 displayed in the command list ('hledger is').
+
+   Here are all the builtin commands in alphabetical order.  See also
+'hledger' for a more organised command list, and 'hledger CMD -h' for
+detailed command help.
 * Menu:

 * accounts::
@ -792,6 +796,7 @@ displayed in the command list ('hledger is').
 * balancesheet::
 * balancesheetequity::
 * cashflow::
+* check-dates::
 * help::
 * incomestatement::
 * print::
@ -1410,7 +1415,7 @@ Total:
                   0


-File: hledger.1.info,  Node: cashflow,  Next: help,  Prev: balancesheetequity,  Up: COMMANDS
+File: hledger.1.info,  Node: cashflow,  Next: check-dates,  Prev: balancesheetequity,  Up: COMMANDS

 4.7 cashflow
 ============
@ -1480,9 +1485,18 @@ period, though as with multicolumn balance reports you can alter the
 report mode with '--change'/'--cumulative'/'--historical'.


-File: hledger.1.info,  Node: help,  Next: incomestatement,  Prev: cashflow,  Up: COMMANDS
+File: hledger.1.info,  Node: check-dates,  Next: help,  Prev: cashflow,  Up: COMMANDS

-4.8 help
+4.8 check-dates
+===============
+
+Check that transactions are sorted by increasing date.  With a query,
+only matched transactions' dates are checked.
+
+
+File: hledger.1.info,  Node: help,  Next: incomestatement,  Prev: check-dates,  Up: COMMANDS
+
+4.9 help
 ========

 Show any of the hledger manuals.
@ -1519,8 +1533,8 @@ DESCRIPTION

 File: hledger.1.info,  Node: incomestatement,  Next: print,  Prev: help,  Up: COMMANDS

-4.9 incomestatement
-===================
+4.10 incomestatement
+====================

 Show an income statement.  Alias: is.

@ -1595,7 +1609,7 @@ report mode with '--change'/'--cumulative'/'--historical'.

 File: hledger.1.info,  Node: print,  Next: register,  Prev: incomestatement,  Up: COMMANDS

-4.10 print
+4.11 print
 ==========

 Show transactions from the journal.
@ -1689,7 +1703,7 @@ $ hledger print -Ocsv

 File: hledger.1.info,  Node: register,  Next: stats,  Prev: print,  Up: COMMANDS

-4.11 register
+4.12 register
 =============

 Show postings and their running total.  Alias: reg.
@ -1794,7 +1808,7 @@ length and comparable to the others in the report.

 File: hledger.1.info,  Node: Custom register output,  Up: register

-4.11.1 Custom register output
+4.12.1 Custom register output
 -----------------------------

 register uses the full terminal width by default, except on windows.
@ -1826,7 +1840,7 @@ output.

 File: hledger.1.info,  Node: stats,  Next: test,  Prev: register,  Up: COMMANDS

-4.12 stats
+4.13 stats
 ==========

 Show some journal statistics.
@ -1858,7 +1872,7 @@ output destination.

 File: hledger.1.info,  Node: test,  Prev: stats,  Up: COMMANDS

-4.13 test
+4.14 test
 =========

 Run built-in unit tests.
@ -2013,7 +2027,6 @@ start making your own!
 * budget::
 * chart::
 * check::
-* check-dates::
 * check-dupes::
 * equity::
 * prices::
@ -2050,7 +2063,7 @@ File: hledger.1.info,  Node: chart,  Next: check,  Prev: budget,  Up: Experiment
 hledger-chart.hs is an old pie chart generator, in need of some love.


-File: hledger.1.info,  Node: check,  Next: check-dates,  Prev: chart,  Up: Experimental add-ons
+File: hledger.1.info,  Node: check,  Next: check-dupes,  Prev: chart,  Up: Experimental add-ons

 5.3.4 check
 -----------
@ -2058,17 +2071,9 @@ File: hledger.1.info,  Node: check,  Next: check-dates,  Prev: chart,  Up: Exper
 hledger-check.hs checks more powerful account balance assertions.


-File: hledger.1.info,  Node: check-dates,  Next: check-dupes,  Prev: check,  Up: Experimental add-ons
+File: hledger.1.info,  Node: check-dupes,  Next: equity,  Prev: check,  Up: Experimental add-ons

-5.3.5 check-dates
-----------------
-
-hledger-check-dates.hs checks that journal entries are ordered by date.
-
-
-File: hledger.1.info,  Node: check-dupes,  Next: equity,  Prev: check-dates,  Up: Experimental add-ons
-
-5.3.6 check-dupes
+5.3.5 check-dupes
 -----------------

 hledger-check-dupes.hs checks for account names sharing the same leaf
@ -2077,7 +2082,7 @@ name.

 File: hledger.1.info,  Node: equity,  Next: prices,  Prev: check-dupes,  Up: Experimental add-ons

-5.3.7 equity
+5.3.6 equity
 ------------

 hledger-equity.hs prints balance-resetting transactions, useful for
@ -2086,7 +2091,7 @@ bringing account balances across file boundaries.

 File: hledger.1.info,  Node: prices,  Next: print-unique,  Prev: equity,  Up: Experimental add-ons

-5.3.8 prices
+5.3.7 prices
 ------------

 hledger-prices.hs prints all prices from the journal.
@ -2094,7 +2099,7 @@ hledger-prices.hs prints all prices from the journal.

 File: hledger.1.info,  Node: print-unique,  Next: register-match,  Prev: prices,  Up: Experimental add-ons

-5.3.9 print-unique
+5.3.8 print-unique
 ------------------

 hledger-print-unique.hs prints transactions which do not reuse an
@ -2103,8 +2108,8 @@ already-seen description.

 File: hledger.1.info,  Node: register-match,  Next: rewrite,  Prev: print-unique,  Up: Experimental add-ons

-5.3.10 register-match
---------------------
+5.3.9 register-match
+--------------------

 hledger-register-match.hs helps ledger-autosync detect already-seen
 transactions when importing.
@ -2112,7 +2117,7 @@ transactions when importing.

 File: hledger.1.info,  Node: rewrite,  Next: tags,  Prev: register-match,  Up: Experimental add-ons

-5.3.11 rewrite
+5.3.10 rewrite
 --------------

 hledger-rewrite.hs Adds one or more custom postings to matched
@ -2121,7 +2126,7 @@ transactions.

 File: hledger.1.info,  Node: tags,  Prev: rewrite,  Up: Experimental add-ons

-5.3.12 tags
+5.3.11 tags
 -----------

 hledger-tags.hs Lists tag names in use.
@ -2165,93 +2170,93 @@ Node: QUERIES21498
 Ref: #queries21602
 Node: COMMANDS25569
 Ref: #commands25683
-Node: accounts26362
-Ref: #accounts26462
-Node: activity27444
-Ref: #activity27556
-Node: add27915
-Ref: #add28016
-Node: balance30674
-Ref: #balance30787
-Node: Flat mode33802
-Ref: #flat-mode33929
-Node: Depth limited balance reports34349
-Ref: #depth-limited-balance-reports34552
-Node: Multicolumn balance reports34972
-Ref: #multicolumn-balance-reports35183
-Node: Custom balance output39831
-Ref: #custom-balance-output40015
-Node: Colour support42108
-Ref: #colour-support42269
-Node: Output destination42442
-Ref: #output-destination42600
-Node: CSV output42870
-Ref: #csv-output42989
-Node: balancesheet43386
-Ref: #balancesheet43524
-Node: balancesheetequity45431
-Ref: #balancesheetequity45582
-Node: cashflow46371
-Ref: #cashflow46494
-Node: help48345
-Ref: #help48457
-Node: incomestatement49531
-Ref: #incomestatement49662
-Node: print51554
-Ref: #print51671
-Node: register55427
-Ref: #register55540
-Node: Custom register output60036
-Ref: #custom-register-output60167
-Node: stats61464
-Ref: #stats61570
-Node: test62451
-Ref: #test62538
-Node: ADD-ON COMMANDS62906
-Ref: #add-on-commands63018
-Node: Official add-ons64305
-Ref: #official-add-ons64447
-Node: api64534
-Ref: #api64625
-Node: ui64677
-Ref: #ui64778
-Node: web64836
-Ref: #web64927
-Node: Third party add-ons64973
-Ref: #third-party-add-ons65150
-Node: diff65285
-Ref: #diff65384
-Node: iadd65483
-Ref: #iadd65599
-Node: interest65682
-Ref: #interest65805
-Node: irr65900
-Ref: #irr66000
-Node: Experimental add-ons66078
-Ref: #experimental-add-ons66232
-Node: autosync66634
-Ref: #autosync66748
-Node: budget66987
-Ref: #budget67111
-Node: chart67177
-Ref: #chart67296
-Node: check67367
-Ref: #check67491
-Node: check-dates67558
-Ref: #check-dates67700
-Node: check-dupes67773
-Ref: #check-dupes67916
-Node: equity67993
-Ref: #equity68121
-Node: prices68240
-Ref: #prices68369
-Node: print-unique68424
-Ref: #print-unique68573
-Node: register-match68666
-Ref: #register-match68822
-Node: rewrite68920
-Ref: #rewrite69054
-Node: tags69132
-Ref: #tags69237
+Node: accounts26542
+Ref: #accounts26642
+Node: activity27624
+Ref: #activity27736
+Node: add28095
+Ref: #add28196
+Node: balance30854
+Ref: #balance30967
+Node: Flat mode33982
+Ref: #flat-mode34109
+Node: Depth limited balance reports34529
+Ref: #depth-limited-balance-reports34732
+Node: Multicolumn balance reports35152
+Ref: #multicolumn-balance-reports35363
+Node: Custom balance output40011
+Ref: #custom-balance-output40195
+Node: Colour support42288
+Ref: #colour-support42449
+Node: Output destination42622
+Ref: #output-destination42780
+Node: CSV output43050
+Ref: #csv-output43169
+Node: balancesheet43566
+Ref: #balancesheet43704
+Node: balancesheetequity45611
+Ref: #balancesheetequity45762
+Node: cashflow46551
+Ref: #cashflow46681
+Node: check-dates48532
+Ref: #check-dates48654
+Node: help48771
+Ref: #help48886
+Node: incomestatement49960
+Ref: #incomestatement50093
+Node: print51985
+Ref: #print52102
+Node: register55858
+Ref: #register55971
+Node: Custom register output60467
+Ref: #custom-register-output60598
+Node: stats61895
+Ref: #stats62001
+Node: test62882
+Ref: #test62969
+Node: ADD-ON COMMANDS63337
+Ref: #add-on-commands63449
+Node: Official add-ons64736
+Ref: #official-add-ons64878
+Node: api64965
+Ref: #api65056
+Node: ui65108
+Ref: #ui65209
+Node: web65267
+Ref: #web65358
+Node: Third party add-ons65404
+Ref: #third-party-add-ons65581
+Node: diff65716
+Ref: #diff65815
+Node: iadd65914
+Ref: #iadd66030
+Node: interest66113
+Ref: #interest66236
+Node: irr66331
+Ref: #irr66431
+Node: Experimental add-ons66509
+Ref: #experimental-add-ons66663
+Node: autosync67049
+Ref: #autosync67163
+Node: budget67402
+Ref: #budget67526
+Node: chart67592
+Ref: #chart67711
+Node: check67782
+Ref: #check67906
+Node: check-dupes67973
+Ref: #check-dupes68110
+Node: equity68187
+Ref: #equity68315
+Node: prices68434
+Ref: #prices68563
+Node: print-unique68618
+Ref: #print-unique68767
+Node: register-match68860
+Ref: #register-match69014
+Node: rewrite69112
+Ref: #rewrite69246
+Node: tags69324
+Ref: #tags69429

 End Tag Table
--- a/hledger/doc/hledger.1.m4.md
+++ b/hledger/doc/hledger.1.m4.md
@ -2,7 +2,7 @@
 % _author_
 % _monthyear_

-m4_dnl This man page is currently broken into smaller files as follows:
+m4_dnl This man page is composed from multiple files as follows:
 m4_dnl
 m4_dnl hledger.1.m4.md
 m4_dnl  examples.m4.md
--- a/hledger/doc/hledger.1.txt
+++ b/hledger/doc/hledger.1.txt
@ -721,6 +721,10 @@ COMMANDS
       a command name (hledger inc), or one of the standard short aliases dis-
       played in the command list (hledger is).

+       Here are all the builtin commands  in  alphabetical  order.   See  also
+       hledger  for  a  more  organised  command  list, and hledger CMD -h for
+       detailed command help.
+
   accounts
       Show account names.

@ -1325,6 +1329,10 @@ COMMANDS
       though  as  with  multicolumn  balance reports you can alter the report
       mode with --change/--cumulative/--historical.

+   check-dates
+       Check that transactions are sorted by increasing date.  With  a  query,
+       only matched transactions' dates are checked.
+
   help
       Show any of the hledger manuals.

@ -1754,9 +1762,6 @@ ADD-ON COMMANDS
   check
       hledger-check.hs checks more powerful account balance assertions.

-   check-dates
-       hledger-check-dates.hs checks that journal entries are ordered by date.
-
   check-dupes
       hledger-check-dupes.hs checks for account names sharing the  same  leaf
       name.