Commit graph

289 commits

Author SHA1 Message Date
Alexis Hildebrandt
49080919e1 [doc] Add documentation for command-line options 2015-02-18 21:53:34 +01:00
Alexis Hildebrandt
82cdeff471 [doc] Whitespace edit
to end each sentence with two spaces.
2015-02-18 21:50:34 +01:00
Alexis Hildebrandt
bd427a9d32 [doc] Add documentation for several options 2015-02-18 21:50:34 +01:00
Alexis Hildebrandt
d5e1308d07 [ledger] Remove --cache option
and all boost serialisation related code.
2015-02-18 21:50:34 +01:00
Alexis Hildebrandt
bc487be14b [doc] Improve example for environment variable options
[ci skip]
2015-01-29 16:23:48 +01:00
thdox
7c9750edca Remove back-link from option to section "balance assertions".
Add forward-link from section to option.
Add option to @findex
2015-01-28 23:13:05 +01:00
Alexis Hildebrandt
11a01f1b5a [doc] Report undocumented value expression functions
in the manpage and texinfo manual.
2015-01-27 22:02:59 +01:00
Alexis Hildebrandt
217193608a [doc] Use specific example to explain environment vars
[ci skip]
2015-01-27 22:02:33 +01:00
Alexis Hildebrandt
185656e191 [doc] Add tests to value and format expressions
and change formatting for value expressions using @defun, @defvar.
2015-01-27 22:01:57 +01:00
Alexis Hildebrandt
3b74b20edd [doc] Add texinfo reference for permissive option
to related balance assertions section.

[ci skip]
2015-01-27 21:58:41 +01:00
Alexis Hildebrandt
c637bdded0 Merge pull request #382 from thdox/add-to-doc
Add documentation for --no-pager option.
2015-01-27 21:53:01 +01:00
thdox
97a6761ca7 Add documentation for option --permissive. 2015-01-22 01:35:14 +01:00
thdox
6b5ff2aebf Add documentation for --no-pager option.
Minor updates to --pager documentation.
[ci skip]
2015-01-22 00:57:20 +01:00
Alexis Hildebrandt
ba46240921 [tests] Improve option parsing in CheckTexinfo.py
* Replace @ftable @code argument with @option of @command depending
  on the documented items

* Remove @c option comment from @items documenting options
2015-01-21 08:03:53 +01:00
Alexis Hildebrandt
4ec3c93829 [doc] Remove unsupported value expressions
The following value expressions result in an error: A, B, g, G, I, v, V

Tested using:
% for o in A B g G I v V; do
  ledger -f test/input/sample.dat -F "%(${o}(amount))\n" reg
done
While handling posting from "test/input/sample.dat", line 17:
>     Assets:Bank:Checking                           $1,000.00
Error: The A value expression variable is no longer supported
...

[ci skip]
2015-01-20 17:20:14 +01:00
Alexis Hildebrandt
197fb6d9b6 [doc] Add more tests 2015-01-20 17:18:29 +01:00
Alexis Hildebrandt
d7f4d94c88 [doc] Improve spelling and wording
[ci skip]
2015-01-20 17:17:56 +01:00
Alexis Hildebrandt
a36a7873f7 Merge pull request #378 from kain88-de/manual-install-instructions
Manual install instructions

[ci skip]
2015-01-20 16:27:09 +01:00
Max Linke
5f9d4f5bf1 Refer to INSTALL.md rather then README.md
[ci skip]
2015-01-20 15:16:59 +01:00
Alexis Hildebrandt
7dd834f843 Merge pull request #376 from thdox/add-to-index4
Add single letter directive to index

[ci skip]
2015-01-20 15:09:00 +01:00
Alexis Hildebrandt
8452fa4266 Merge pull request #377 from thdox/command-line
Make consistent the syntax of "command-line"

[ci skip]
2015-01-20 14:51:05 +01:00
Alexis Hildebrandt
35a4fa5978 [doc] Fix broken cross reference to test types
[ci skip]
2015-01-20 14:45:02 +01:00
Max Linke
fd69705917 Add hint to check README.md for build instructions
I also removed some sentences that were useful for older build systems.
[ci skip]
2015-01-20 13:50:56 +01:00
Max Linke
a21d78e60c Update install instruction in manual
[ci skip]
2015-01-20 13:45:58 +01:00
thdox
27da696c55 Make consistent the syntax of "command-line"
And other typos fixes
2015-01-20 13:44:17 +01:00
thdox
c066156f09 Add cross-ref for bucket and year.
On top of @node, @xref{} can also be linked to @anchor.
[ci skip]
2015-01-20 13:35:08 +01:00
Alexis Hildebrandt
97ee2d23d0 [doc] Use Ledger_VERSION_* make variables for version
[ci skip]
2015-01-20 11:02:56 +01:00
thdox
dbf1574ab7 Add those single letter directives to index. 2015-01-19 20:50:24 +01:00
Alexis Hildebrandt
012ce5ef10 [doc] Add documentation on running and writing tests
Minor wording edit
[ci skip]

Signed-off-by: Alexis Hildebrandt <afh@surryhill.net>
2015-01-15 14:53:17 +01:00
Alexis Hildebrandt
01252035cd [doc] Add CheckTests to ctest
to check whether all available ledger options documented
and are being tested.

Signed-off-by: Alexis Hildebrandt <afh@surryhill.net>
2015-01-15 14:53:16 +01:00
Steve Purcell
d5c1e05a59 Merge remote-tracking branch 'refs/remotes/ledger/master' into next 2015-01-14 18:37:45 +00:00
aleksejrs
b7190a69a8 Typo in the manual: "legder" 2015-01-14 20:42:16 +03:00
Alexis Hildebrandt
3a1ab67092 [tests] Fix new DocTest A9349E4 2015-01-10 15:27:24 +01:00
Alexis Hildebrandt
793e295a92 [tests] Validate another example in the manual 2015-01-10 14:06:32 +01:00
Alexis Hildebrandt
ca8eded48e [doc] Minor typographical and error corrections
[ci skip]
2015-01-05 14:14:25 +01:00
Alexis Hildebrandt
8946454b61 [doc] Bump Ledger version to 3.1
It would be great to use texinfo variables to set the current Ledger
version, e.g. @value{Ledger_VERSION_MAJOR} and pass the CMake variables
to texi2pdf via --command='@set Ledger_VERSION_MAJOR ${Ledger_VERSION_MAJOR}'.

Unfortunately texi2pdf will err with:
Argument of @parseargline has an extra }.
<inserted text> 
                @par 
<to be read again> 
                   }
@\subtitle ...epage {@subtitlefont @rightline {#1}
                                                  }
l.153 @subtitle For Version @value{Ledger_VERSION_MAJOR} of Ledger


[ci skip]
2015-01-05 14:13:38 +01:00
Alexis Hildebrandt
0669ca9b40 [doc] Update explanation for validating doc examples 2015-01-05 14:13:37 +01:00
Alexis Hildebrandt
6bd2c0e3f6 [doc] Bump copyright notice to 2015
[ci skip]
2015-01-05 14:13:37 +01:00
Alexis Hildebrandt
bf4dc7c8f4 [doc] Add whitespace to separate debug options
better from one another in the item list

[ci skip]
2015-01-05 14:13:37 +01:00
Alexis Hildebrandt
642ca8d9d6 [doc] Update list of debug codes
using ag --nogroup '^[        ]*debug\(' | cut -d '"' -f2 | sort -u | column

[ci skip]
2015-01-05 14:13:37 +01:00
thdox
77b5d0aee0 Indented with Emacs: M-x fill-paragraph 2014-12-22 10:01:57 +01:00
thdox
9b76c22f44 Document that buffer names should use @file{} keyword 2014-12-22 10:01:57 +01:00
thdox
66265e76d5 M-x delete-trailing-whitespace 2014-12-22 10:01:57 +01:00
thdox
c0a8ff7160 Fixes for consistency 2014-12-22 10:01:57 +01:00
thdox
0af31f6d6a pxref already contains "see" 2014-12-22 10:01:57 +01:00
thdox
20471cf74b query is a command 2014-12-22 10:01:57 +01:00
thdox
9651f78c37 Minor fix: double spaces 2014-12-22 10:01:57 +01:00
thdox
81ac9b27fd fix minor typo 2014-12-22 10:01:47 +01:00
Steve Purcell
9ecf0cbadb Fix typo in docs 2014-12-15 18:43:32 +00:00
Alexis Hildebrandt
31ccb6d368 Fix and re-enable DocTests 2014-11-29 09:06:14 +01:00