mirror of
https://github.com/GothenburgBitFactory/timewarrior.git
synced 2025-07-07 20:06:39 +02:00
Docs: Removed log references
This commit is contained in:
parent
aa8179654f
commit
d42639f30a
6 changed files with 6 additions and 43 deletions
|
@ -10,7 +10,6 @@
|
||||||
- Added 'export' command.
|
- Added 'export' command.
|
||||||
- Added 'extensions' command.
|
- Added 'extensions' command.
|
||||||
- Added 'help' command.
|
- Added 'help' command.
|
||||||
- Added 'log' command.
|
|
||||||
- Added 'start' command.
|
- Added 'start' command.
|
||||||
- Added 'stop' command.
|
- Added 'stop' command.
|
||||||
- Added 'tags' command.
|
- Added 'tags' command.
|
||||||
|
|
27
doc/data.txt
27
doc/data.txt
|
@ -99,32 +99,5 @@ The undo stack will be stored as:
|
||||||
~/.timewarrior/undo.data
|
~/.timewarrior/undo.data
|
||||||
|
|
||||||
|
|
||||||
Logging
|
|
||||||
-------
|
|
||||||
Timewarrior will log many messages, but the logging will be configurable. The
|
|
||||||
configuration will be:
|
|
||||||
|
|
||||||
define configuration:
|
|
||||||
logging:
|
|
||||||
file /path/to/log/file
|
|
||||||
categories a,b,c,!d
|
|
||||||
|
|
||||||
This indicates that categories 'a', 'b', and 'c' are desired, and 'd' is
|
|
||||||
explicitly not desired. The categories are:
|
|
||||||
|
|
||||||
command (distinguishes tty and non-tty commands)
|
|
||||||
performance
|
|
||||||
rules
|
|
||||||
io
|
|
||||||
parsing
|
|
||||||
warnings
|
|
||||||
errors
|
|
||||||
info
|
|
||||||
debug
|
|
||||||
|
|
||||||
A log entry will have this form:
|
|
||||||
|
|
||||||
YYYY-MM-DDTHH:MM:SS <version> <category> <message...>
|
|
||||||
|
|
||||||
--- Raw Notes ---
|
--- Raw Notes ---
|
||||||
|
|
||||||
|
|
|
@ -31,7 +31,6 @@ The CLI shall have a well-defined and unambiguous grammar.
|
||||||
|
|
||||||
timew help [<command>|<keyword>|examples]
|
timew help [<command>|<keyword>|examples]
|
||||||
timew diagnostics
|
timew diagnostics
|
||||||
timew log mark|<string>
|
|
||||||
|
|
||||||
|
|
||||||
CLI Grammar
|
CLI Grammar
|
||||||
|
|
|
@ -115,8 +115,8 @@ There is also a rules system that can impose constraints on the data, such as
|
||||||
automatically shutting off tracking after 40 hours is tracked per week, warnings
|
automatically shutting off tracking after 40 hours is tracked per week, warnings
|
||||||
about overtime, and more.
|
about overtime, and more.
|
||||||
|
|
||||||
There is built-in configuration support, logging, and assorted tools to help
|
There is built-in configuration support and assorted tools to help you enact
|
||||||
you enact policy.
|
policy.
|
||||||
|
|
||||||
The data will be stored as plain text, and there will a way to merge data from
|
The data will be stored as plain text, and there will a way to merge data from
|
||||||
multiple sources.
|
multiple sources.
|
||||||
|
|
|
@ -97,7 +97,7 @@ to be added as extensions, while being handled as though they were built-ins.
|
||||||
|
|
||||||
Undo
|
Undo
|
||||||
----
|
----
|
||||||
All commands that change configuration or data need to be logged as-is in the
|
All commands that change configuration or data need to be recorded as-is in the
|
||||||
undo.data file, so that an 'undo' command can later rewind the changes properly.
|
undo.data file, so that an 'undo' command can later rewind the changes properly.
|
||||||
|
|
||||||
All undo will happen at the command level, not the delta level. That means if
|
All undo will happen at the command level, not the delta level. That means if
|
||||||
|
|
|
@ -158,13 +158,6 @@ hierarchy for grouping:
|
||||||
In the example, value2 can be referred to by it's normalized name
|
In the example, value2 can be referred to by it's normalized name
|
||||||
'group1.group2.name2'.
|
'group1.group2.name2'.
|
||||||
|
|
||||||
An example is logging:
|
|
||||||
|
|
||||||
define configuration:
|
|
||||||
logging:
|
|
||||||
file = /path/to/log/file
|
|
||||||
categories = a b c !d
|
|
||||||
|
|
||||||
Initially, all settings are stored as simple name/value pairs at the top level
|
Initially, all settings are stored as simple name/value pairs at the top level
|
||||||
of the configuration files:
|
of the configuration files:
|
||||||
|
|
||||||
|
@ -227,10 +220,9 @@ Built-in Functions
|
||||||
------------------
|
------------------
|
||||||
There are several built-in functions, which may be used by rules:
|
There are several built-in functions, which may be used by rules:
|
||||||
|
|
||||||
error("...") Logs, emits and terminates
|
error("...") Emits and terminates
|
||||||
warning("...") Logs, emits and continues
|
warning("...") Emits and continues
|
||||||
info("...") Logs, emits and continues
|
info("...") Emits and continues
|
||||||
log("...") Logs and continues
|
|
||||||
sum_week("tag1") Sums minutes in the current week for "tag1"
|
sum_week("tag1") Sums minutes in the current week for "tag1"
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue