Docs: Added 'undo' feature

This commit is contained in:
Paul Beckingham 2016-03-13 11:10:31 -04:00
parent fa2c6fa6af
commit 1577243547
3 changed files with 21 additions and 9 deletions

View file

@ -90,5 +90,12 @@ example:
~/.timewarrior/data/2016-02.data
~/.timewarrior/data/2016-03.data
Undo Data
---------
The undo stack will be stored as:
~/.timewarrior/undo.data
---

View file

@ -25,6 +25,8 @@ The CLI shall have a well-defined and unambiguous grammar.
timew define tag <tag> budget <number> <units> total
timew define tag <tag> overlap
timew undo
timew tags
timew gaps [<interval>]

View file

@ -38,7 +38,7 @@ Non-Goals
Tags
----
Tags represent tracking categories. Tags are arbitrary UTF8 strings. A tag may
be a single unquoted word, or a quoted phrase.
be a single unquoted word, or a quoted string if it includes spaces.
A tag may be used without being defined, but if a tag is defined, then it may
have associated metadata, such as a start date representing the first date on
@ -62,23 +62,26 @@ The command set may include:
define Modify configuration
track Record tracked time
report Run a report
undo Undo a change
tags Show all tags
gaps Show untracked gaps in the schedule
import Import JSON data
export Export JSON data
help Show help text
x Run extension 'x'
Undo
----
All commands than change configuration or data need to be logged as-is in the
undo.data file, so that an 'undo' command can later rewind the changes.
All undo will happen at the command level, not the delta level.
Extensions
----------
A simple extension mechanism would require an executable script found in a
defined location with a conformant name, which then is fed exported data on
stdin.
For example, this script clearly defines that it is a 'report' extension named
'abc'.
~/.timewarrior/extensions/report_abc
A simple extension mechanism allows custom reports to be written and shared.
---