GothenburgBitFactory/taskwarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/taskwarrior.git synced 2025-06-26 10:54:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Docs: Updated exposition

Browse source
This commit is contained in:
Paul Beckingham 2017-01-25 22:49:22 -05:00
parent 7e09dd9457
commit 5b0c59023b
1 changed files with 11 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

15
EXPOSITION
View file

@ -19,8 +19,8 @@ Startup
Command Line Parsing Command Line Parsing
Command line parsing is difficult because of all the ambiguity. The solution Command line parsing is difficult because of lots ambiguity. The solution is
is to make multiple passes over the command line. For example, the command to make multiple passes over the command line. For example, the command
determines whether subsequent arguments are interpreted as part of a filter or determines whether subsequent arguments are interpreted as part of a filter or
set of modifications. set of modifications.
@ -43,6 +43,8 @@ Command Line Parsing
tagged to indicate what part of the command line іt represents, such as a tagged to indicate what part of the command line іt represents, such as a
filter, operator, or command. filter, operator, or command.
The CLI2 object will be replaced by a generalized parser and grammar.
Dispatch Dispatch
Dispatch is simple: once the command line is parsed, the command is used to Dispatch is simple: once the command line is parsed, the command is used to
@ -73,7 +75,7 @@ TDB2
isolate code from file I/O, locking and parsing details. It is also isolate code from file I/O, locking and parsing details. It is also
responsible for minimizing reads, writes and parsing of data files. responsible for minimizing reads, writes and parsing of data files.
All input is assumed to be UTF8. All stored data is UTF8. All input is assumed to be UTF8. All stored data is treated as UTF8.
GC GC
@ -107,10 +109,15 @@ Files
The completed.data file accumulates data over time, and grows unbounded. The completed.data file accumulates data over time, and grows unbounded.
The undo.data file accumulates changes over time, and grows unbounded. It The undo.data file accumulates changes over time, and grows unbounded. It
provides all the necessary metadata to support the 'undo' command. provides all the necessary metadata to support the 'undo' command. Deleting
this file has two effects which are to remove the undo capability, and remove
the ability for the 'info' command to show a change history. The undo file
can grow quite large, and it can be argued that only the last N transactions
are worth keeping, where N is about 10.
The backlog.data file contains an accumulated set of changes that have not The backlog.data file contains an accumulated set of changes that have not
been transmitted to Taskserver. It grows unbounded between 'sync' commands. been transmitted to Taskserver. It grows unbounded between 'sync' commands.
If you do not use sync, it is fine to just delete this file to sae space.
Filter Filter