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

reformat to one sentence per line

Browse source
This commit is contained in:
Dustin J. Mitchell 2022-04-21 01:15:17 +00:00 • committed by Tomas Babej
parent ade706a72e
commit b1ca5d4cf8
17 changed files with 842 additions and 1052 deletions
Download patch file Download diff file Expand all files Collapse all files

58
docs/contrib/branching.md
View file

@ -2,18 +2,16 @@
title: Branching Model
---
Software development typically requires a standardized branching model, to
manage complexity and parallel efforts. The branching model can be a source of
confusion for developers, so this document describes how branching is used.
Software development typically requires a standardized branching model, to manage complexity and parallel efforts.
The branching model can be a source of confusion for developers, so this document describes how branching is used.
Taskwarrior and Taskserver use the same branching model.
## Git Branching
Git allows arbitrary and low-cost branching, which means that any branching
model can be used. A new Git repository has one branch, the default branch,
named `master`, but even this is not required.
Git allows arbitrary and low-cost branching, which means that any branching model can be used.
A new Git repository has one branch, the default branch, named `master`, but even this is not required.
[![master](/docs/images/master.png)](/docs/images/master.png)
@ -22,9 +20,9 @@ No development occurs on the `master` branch.
## Development Branch
A development branch is created from the `master` branch, and work proceeds on
the development branch. Development branches are pushed to the server. Note that
there are no changes on `master` - all work is done on dev branches.
A development branch is created from the `master` branch, and work proceeds on the development branch.
Development branches are pushed to the server.
Note that there are no changes on `master` - all work is done on dev branches.
[![dev](/docs/images/dev.png)](/docs/images/dev.png)
@ -33,53 +31,47 @@ All work on dev branches is pushed to the server.
## Topic Branch
A topic branch is created from a dev branch. This can be a useful way to manage
parallel efforts on a single development machine. Topic branches are also useful
for merging in submitted patches, because the patch can be merged, tested and
corrected independently of other efforts before being merged and pushed. A topic
branch is ideal for storage of changes before an eventual merge back to the
development branch.
A topic branch is created from a dev branch.
This can be a useful way to manage parallel efforts on a single development machine.
Topic branches are also useful for merging in submitted patches, because the patch can be merged, tested and corrected independently of other efforts before being merged and pushed.
A topic branch is ideal for storage of changes before an eventual merge back to the development branch.
[![topic](/docs/images/topic.png)](/docs/images/topic.png)
No topic branches are pushed to the server, they are kept local to the
development machine. They are private, and therefore hidden from the server.
No topic branches are pushed to the server, they are kept local to the development machine.
They are private, and therefore hidden from the server.
## Release
When a release is made, the development branch is merged back to the `master`
branch, and a tag is applied that indicates which commit represents the release.
When a release is made, the development branch is merged back to the `master` branch, and a tag is applied that indicates which commit represents the release.
[![release](/docs/images/release.png)](/docs/images/release.png)
Because only releases are merged back, the `master` branch always represent the
stable release.
Because only releases are merged back, the `master` branch always represent the stable release.
## New Development Branches
Immediately after a release, one or more new branches are created. Typically
after a major \'1.0.0\' release, there will be two branches created. First the
\'1.0.1\' branch is a patch development branch, intended to be used if an
emergency patch is required. It therefore sits unused until an emergency arises.
Immediately after a release, one or more new branches are created.
Typically after a major \'1.0.0\' release, there will be two branches created.
First the \'1.0.1\' branch is a patch development branch, intended to be used if an emergency patch is required.
It therefore sits unused until an emergency arises.
No work is performed on a patch development branch.
The second branch, with the higher release number is the development branch for
fixes and features. This is where all the work occurs. Any fix made on the
development branch can be cherry-picked onto the patch branch, if necessary.
The second branch, with the higher release number is the development branch for fixes and features.
This is where all the work occurs.
Any fix made on the development branch can be cherry-picked onto the patch branch, if necessary.
[![dev2](/docs/images/dev2.png)](/docs/images/dev2.png)
To address the confusion around branching, namely determining which branch is
active. the answer is that the highest numbered branch is the one that patches
should be applied to.
To address the confusion around branching, namely determining which branch is active.
the answer is that the highest numbered branch is the one that patches should be applied to.
## Old Branches
Old branches are not retained, but there are tags marking the beginning and end
of development on a branch.
Old branches are not retained, but there are tags marking the beginning and end of development on a branch.
## Rebasing

30
docs/contrib/build.md
View file

@ -2,9 +2,9 @@
title: How To Build Taskwarrior
---
This is for developers. Specifically those who know how to use tools, satisfy
dependencies, and want to set up a development environment. It is not
user-friendly.
This is for developers.
Specifically those who know how to use tools, satisfy dependencies, and want to set up a development environment.
It is not user-friendly.
You\'ll need these tools:
@ -55,9 +55,8 @@ Build the debug type if you want symbols in the binary.
# Running the Test Suite
There are scripts to facilitate running the test suite. In particular, the
[vramsteg](https://gothenburgbitfactory.org/projects/vramsteg) utility
provides blinkenlights for test progress.
There are scripts to facilitate running the test suite.
In particular, the [vramsteg](https://gothenburgbitfactory.org/projects/vramsteg) utility provides blinkenlights for test progress.
$ cd taskwarrior.git/test
$ make VERBOSE=1 # Shows details
@ -68,9 +67,10 @@ provides blinkenlights for test progress.
# Submitting a Patch
Talk to us first - make sure you are working on something that is wanted.
Patches will not be applied simply because you did the work. Remember the
various forms of documentation involved, and the test suite. Work on the dev
branch, not `master`. When you are are ready to submit, do this:
Patches will not be applied simply because you did the work.
Remember the various forms of documentation involved, and the test suite.
Work on the dev branch, not `master`.
When you are are ready to submit, do this:
$ git commit
@ -94,11 +94,9 @@ Create the patch using this:
$ git format-patch HEAD^
Mail the patch to <taskwarrior-dev@googlegroups.com> or attach it to the
appropriate ticket in the [bug
tracker](https://github.com/GothenburgBitFactory/taskwarrior/issues). If you do
the latter, make sure someone knows about it, or it could go unnoticed.
Mail the patch to <taskwarrior-dev@googlegroups.com> or attach it to the appropriate ticket in the [bug tracker](https://github.com/GothenburgBitFactory/taskwarrior/issues).
If you do the latter, make sure someone knows about it, or it could go unnoticed.
Expect feedback. It is unlikely your patch will be accepted unmodified. Usually
this is because you violated the coding style, worked in the wrong branch, or
*forgot* about documentation and unit tests.
Expect feedback.
It is unlikely your patch will be accepted unmodified.
Usually this is because you violated the coding style, worked in the wrong branch, or *forgot* about documentation and unit tests.

27
docs/contrib/coding_style.md
View file

@ -2,30 +2,27 @@
title: Coding Style
---
The coding style used for the Taskwarrior, Taskserver, and other codebases is
deliberately kept simple and a little vague. This is because there are many
languages involved (C++, C, Python, sh, bash, HTML, troff and more), and
specіfying those would be a major effort that detracts from the main focus which
is improving the software.
The coding style used for the Taskwarrior, Taskserver, and other codebases is deliberately kept simple and a little vague.
This is because there are many languages involved (C++, C, Python, sh, bash, HTML, troff and more), and specіfying those would be a major effort that detracts from the main focus which is improving the software.
Instead, the general guideline is simply this:
Make all changes and additions such that they blend in perfectly with the
surrounding code, so it looks like only one person worked on the source, and
that person is rigidly consistent.
Make all changes and additions such that they blend in perfectly with the surrounding code, so it looks like only one person worked on the source, and that person is rigidly consistent.
To be a little more explicit, the common elements across the languages are:
- Indent code using two spaces, no tabs
- With Python, follow [PEP8](https://www.python.org/dev/peps/pep-0008/) as
much as possible
- With Python, follow [PEP8](https://www.python.org/dev/peps/pep-0008/) as much as possible
- Surround operators and expression terms with a space
- No cuddled braces
- Class names are capitalized, variable names are not
We target Python 2.7 so that our test suite runs on the broadest set of
platforms. This will likely change in the future and 2.7 will be dropped.
We target Python 2.7 so that our test suite runs on the broadest set of platforms.
This will likely change in the future and 2.7 will be dropped.
We can safely target C++11 because all the default compilers on our supported
platforms are ready. Feel free to use C++14 and C++17 provided that all build
platforms support this.
We can safely target C++11 because all the default compilers on our supported platforms are ready.
Feel free to use C++14 and C++17 provided that all build platforms support thi

85
docs/contrib/contribute.md
View file

@ -2,45 +2,62 @@
title: Contributing to Taskwarrior
---
Help is needed in all areas of Taskwarrior development - design, coding,
testing, support and marketing. Applicants must be friendly. Perhaps you are
looking to help, but don\'t know where to start. You can of course [email
us](mailto:taskwarrior-dev@googlegroups.com) but take a look at this list.
Perhaps you have skills we are looking for, here are ways you may be able to
help:
Help is needed in all areas of Taskwarrior development - design, coding, testing, support and marketing.
Applicants must be friendly.
Perhaps you are looking to help, but don\'t know where to start.
You can of course [email us](mailto:taskwarrior-dev@googlegroups.com) but take a look at this list.
Perhaps you have skills we are looking for, here are ways you may be able to help:
- Use Taskwarrior, become familiar with it, and make suggestions.
We get great feedback from both new users and veteran users.
New users have a fresh approach that we can no longer achieve, while veteran users develop clever and crafty ways to use the product.
- Report bugs and odd behavior when you see it.
We don\'t necessarily know it\'s broken, unless you tell us.
- Suggest enhancements.
We get lots of these, and it\'s great.
Some really good ideas have been suggested and implemented.
Sure, some are out of scope, or plain crazy, but the stream of suggestions is fascinating to think about.
- Participate in the [bug tracking](https://github.com/GothenburgBitFactory/taskwarrior/issues) database, to help others and maybe learn something yourself.
- Use Taskwarrior, become familiar with it, and make suggestions. We get great
feedback from both new users and veteran users. New users have a fresh
approach that we can no longer achieve, while veteran users develop clever
and crafty ways to use the product.
- Report bugs and odd behavior when you see it. We don\'t necessarily know
it\'s broken, unless you tell us.
- Suggest enhancements. We get lots of these, and it\'s great. Some really
good ideas have been suggested and implemented. Sure, some are out of scope,
or plain crazy, but the stream of suggestions is fascinating to think about.
- Participate in the [bug
tracking](https://github.com/GothenburgBitFactory/taskwarrior/issues)
database, to help others and maybe learn something yourself.
- Help [triage](/docs/triage) the issues list.
- Join the IRC channel \#taskwarrior on freenode.net and help answer some
questions.
- Join either the
[developer-mailinglist](https://groups.google.com/forum/#!forum/taskwarrior-dev)
or
[user-mailinglist](https://groups.google.com/forum/#!forum/taskwarrior-user)
(or both) and participate.
- Join the IRC channel \#taskwarrior on freenode.net and help answer some questions.
- Join either the [developer-mailinglist](https://groups.google.com/forum/#!forum/taskwarrior-dev) or [user-mailinglist](https://groups.google.com/forum/#!forum/taskwarrior-user) (or both) and participate.
- Proofread the documentation and man pages.
- Improve the documentation.
- Improve the man pages.
- Help improve the tutorials. Make your own tutorial.
- Confirm a bug. Nothing gets fixed without confirmation.
- Refine a bug. Provide relevant details, elaborate on the behavior.
- Fix a bug. Send a patch. You\'ll need C++ skills for this.
- Write a unit test. Improve an existing unit test.
- Spread the word. Help others become more effective at managing tasks. Share
your methodology, to inspire others.
- Encouragement. Tell us what works for you, and what doesn\'t. It\'s all
good.
- Help improve the tutorials.
Make your own tutorial.
- Confirm a bug.
Nothing gets fixed without confirmation.
- Refine a bug.
Provide relevant details, elaborate on the behavior.
- Fix a bug.
Send a patch.
You\'ll need C++ skills for this.
- Write a unit test.
Improve an existing unit test.
- Spread the word.
Help others become more effective at managing tasks.
Share your methodology, to inspire others.
- Encouragement.
Tell us what works for you, and what doesn\'t.
It\'s all good.
- Donate! Help offset costs.
Please remember that we need contributions from all skillsets, however small.

156
docs/contrib/development.md
View file

@ -28,121 +28,123 @@ title: How to Build Taskwarrior
$ ./problems # Enumerate test failures in all.log
```
Note that any development should be performed using a git clone, and the
current development branch. The source tarballs do not reflect HEAD, and do
not contain the test suite.
Note that any development should be performed using a git clone, and the current development branch.
The source tarballs do not reflect HEAD, and do not contain the test suite.
If you send a patch (support@gothenburgbitfactory.org), make sure that patch is made
against git HEAD on the development branch. We cannot apply patches made
against the tarball source, or master.
If you send a patch (support@gothenburgbitfactory.org), make sure that patch is made against git HEAD on the development branch.
We cannot apply patches made against the tarball source, or master.
# General Statement
This file is intended to convey the current efforts, priorities and needs of
the code base. It is for anyone looking for a way to start contributing.
This file is intended to convey the current efforts, priorities and needs of the code base.
It is for anyone looking for a way to start contributing.
Here are many ways to contribute that may not be obvious:
* Use Taskwarrior, become familiar with it, and make suggestions. There are
always ongoing discussions about new features and changes to existing
features.
* Use Taskwarrior, become familiar with it, and make suggestions.
There are always ongoing discussions about new features and changes to existing features.
* Join us in the #taskwarrior IRC channel on freenode.net or libera.chat.
Many great ideas, suggestions, testing and discussions have taken place
there. It is also the quickest way to get help, or confirm a bug.
Many great ideas, suggestions, testing and discussions have taken place there.
It is also the quickest way to get help, or confirm a bug.
* Review documentation: there are man pages, online articles, tutorials and
so on, and these may contain errors, or they may not convey ideas in the
best way. Perhaps you can help improve it. Contact us - documentation is
a separate effort from the code base, and includes all web sites, and all
are available as git repositories.
* Review documentation: there are man pages, online articles, tutorials and so on, and these may contain errors, or they may not convey ideas in the best way.
Perhaps you can help improve it.
Contact us - documentation is a separate effort from the code base, and includes all web sites, and all are available as git repositories.
* Take a look at the bug database, and help triage the bug list. This is a
review process that involves confirming bugs, providing additional data,
information or analysis. Bug triage is very useful and much needed. You
could check to see that an old bug is still relevant - sometimes they are
not.
* Take a look at the bug database, and help triage the bug list.
This is a review process that involves confirming bugs, providing additional data, information or analysis.
Bug triage is very useful and much needed.
You could check to see that an old bug is still relevant - sometimes they are not.
* Review the source code, and point out inefficiencies, problems, unreadable
functions, bugs and assumptions.
* Review the source code, and point out inefficiencies, problems, unreadable functions, bugs and assumptions.
* Fix a bug. For this you'll need C++ and Git skills. We welcome all bug
fixes, provided the work is done well and doesn't create other problems or
introduce new dependencies. We recommend talking to us before starting.
* Fix a bug.
For this you'll need C++ and Git skills.
We welcome all bug fixes, provided the work is done well and doesn't create other problems or introduce new dependencies.
We recommend talking to us before starting.
Seriously.
* Add unit tests. Unit tests are possibly the most useful contributions of
all, because they not only improve the quality of the code, but prevent
future regressions, therefore maintaining quality of subsequent releases.
* Add unit tests.
Unit tests are possibly the most useful contributions of all, because they not only improve the quality of the code, but prevent future regressions, therefore maintaining quality of subsequent releases.
Plus, broken tests are a great motivator for us to fix the causal defect.
You'll need Python skills.
* Add a feature. Well, let's be very clear about this: adding a feature is
not usually well-received, and if you add a feature and send a patch, it
will most likely be rejected. The reason for this is that there are many
efforts under way, in various code branches. There is a very good chance
that the feature you add is either already in progress, or being done in a
way that is more fitting when considering other work in progress. So if
you want to add a feature, please don't. Start by talking to us, and find
out what is currently under way or planned. You might find that we've
already rejected such a feature for some very good reasons. So please
check first, so we don't duplicate effort or waste anyone's time.
* Add a feature.
Well, let's be very clear about this: adding a feature is not usually well-received, and if you add a feature and send a patch, it will most likely be rejected.
The reason for this is that there are many efforts under way, in various code branches.
There is a very good chance that the feature you add is either already in progress, or being done in a way that is more fitting when considering other work in progress.
So if you want to add a feature, please don't.
Start by talking to us, and find out what is currently under way or planned.
You might find that we've already rejected such a feature for some very good reasons.
So please check first, so we don't duplicate effort or waste anyone's time.
* Spread the word. Help others become more effective at managing tasks.
* Spread the word.
Help others become more effective at managing tasks.
* Encouragement. Tell us what works for you, and what doesn't. Tell us about
your methodology for managing tasks. It's all useful information.
* Encouragement.
Tell us what works for you, and what doesn't.
Tell us about your methodology for managing tasks.
It's all useful information.
* Request a feature. This not only tells us that you think something is
missing from the software, but gives us insights into how you use it.
* Request a feature.
This not only tells us that you think something is missing from the software, but gives us insights into how you use it.
Plus, you might get your feature implemented.
# Unit Tests Needed
There are always more unit tests needed. More specifically, better unit tests
are always needed. The convention is that there are four types of unit test:
There are always more unit tests needed.
More specifically, better unit tests are always needed.
The convention is that there are four types of unit test:
1. High level tests that exercise large features, or combinations of commands.
For example, dependencies.t runs through a long list of commands that test
dependencies, but do so by using 'add', 'modify', 'done' and 'delete'.
1. Regression tests that ensure certain bugs are fixed and stay fixed. These
tests are named tw-NNNN.t where NNNN refers to the bug number. While it is
not worth creating tests for small fixes like typos, it is for logic
changes.
1. Small feature tests. When small features are added, we would like small,
low-level feature tests named feature.t, with a descriptive name and
focused tests.
1. Code tests. These are tests written in C++ that exercise C++ objects, or
function calls. These are the lowest level tests. It is important that
these kind of tests be extensive and thorough, because the software depends
on this code the most.
For example, dependencies.t runs through a long list of commands that test dependencies, but do so by using 'add', 'modify', 'done' and 'delete'.
2. Regression tests that ensure certain bugs are fixed and stay fixed.
These tests are named tw-NNNN.t where NNNN refers to the bug number.
While it is not worth creating tests for small fixes like typos, it is for logic changes.
3. Small feature tests.
When small features are added, we would like small, low-level feature tests named feature.t, with a descriptive name and focused tests.
4. Code tests.
These are tests written in C++ that exercise C++ objects, or function calls.
These are the lowest level tests.
It is important that these kind of tests be extensive and thorough, because the software depends on this code the most.
The tests are written in Python, Bash and C++, and all use TAP.
## Tests needed
* Take a look at the bug database (https://github.com/GothenburgBitFactory/taskwarrior/issues)
and notice that many issues, open and closed, have the "needsTest" label.
These are things that we would like to see in the test suite, as regression
tests.
* Take a look at the bug database (https://github.com/GothenburgBitFactory/taskwarrior/issues) and notice that many issues, open and closed, have the "needsTest" label.
These are things that we would like to see in the test suite, as regression tests.
All new unit tests should follow the test/template.t standard.
# Patches
Patches are encouraged and welcomed. Either send a pull request on Github or
email a patch to support@taskwarrior.org. A good patch:
* Maintains the MIT license, and does not contain code lifted from other
sources. You will have written 100% of the code in the patch, otherwise
we cannot maintain the license.
Patches are encouraged and welcomed.
Either send a pull request on Github or email a patch to support@taskwarrior.org.
A good patch:
* Maintains the MIT license, and does not contain code lifted from other sources.
You will have written 100% of the code in the patch, otherwise we cannot maintain the license.
* Precisely addresses one issue only.
* Doesn't break unit tests. This means yes, run the unit tests.
* Doesn't break unit tests.
This means yes, run the unit tests.
* Doesn't introduce dependencies.
* Is accompanied by new or updated unit tests, where appropriate.
* Is accompanied by documentation changes, where appropriate.
* Conforms to the prevailing coding standards - in other words, it should
fit in with the existing code.
* Conforms to the prevailing coding standards - in other words, it should fit in with the existing code.
A patch may be rejected for violating any of the above rules, and more.
Bad patches may be accepted and modified depending on work load and mood. It
is possible that a patch may be rejected because it conflicts in some way with
plans or upcoming changes. Check with us first, before sinking time and effort
into a patch.
Bad patches may be accepted and modified depending on work load and mood.
It is possible that a patch may be rejected because it conflicts in some way with plans or upcoming changes.
Check with us first, before sinking time and effort into a patch.

135
docs/contrib/first_time.md
View file

@ -2,48 +2,38 @@
title: How to become an Open Source Contributor
---
Welcome, potential new Open Source contributor! This is a guide to show you
exactly how to make a contribution, and will lead you through the entire
process.
Welcome, potential new Open Source contributor! This is a guide to show you exactly how to make a contribution, and will lead you through the entire process.
There are many people who wish to start contributing, but don\'t know how or
where to start. If this might be the case, then please read on, this guide is
for you. Because we want you to join in the fun with Open Source - it can be fun
and rewarding, improve your skills, or just give you a way to contribute back to
a project.
There are many people who wish to start contributing, but don\'t know how or where to start.
If this might be the case, then please read on, this guide is for you.
Because we want you to join in the fun with Open Source - it can be fun and rewarding, improve your skills, or just give you a way to contribute back to a project.
Where else can you combine the thrill of typing in a darkened room with the
kindhearted love of an internet forum? Just kidding!
Where else can you combine the thrill of typing in a darkened room with the kindhearted love of an internet forum? Just kidding!
The goal of this document is to give you the ability to make your first
contribution, and encourage you to make a second, by showing you how simple it
is. Perhaps confidence and a little familiarity with the process are all you
need to get started.
The goal of this document is to give you the ability to make your first contribution, and encourage you to make a second, by showing you how simple it is.
Perhaps confidence and a little familiarity with the process are all you need to get started.
We\'re going to pick the smallest contribution of all - a typo fix. While this
may be a very small improvement, it is nevertheless a wanted improvement, and
will be welcomed. Fixes such as this happen many times a day. Similar work on
new features, new documents, rewriting help, refactoring code, fixing bugs and
improving performance all combine to make a project grow and improve.
We\'re going to pick the smallest contribution of all - a typo fix.
While this may be a very small improvement, it is nevertheless a wanted improvement, and will be welcomed.
Fixes such as this happen many times a day.
Similar work on new features, new documents, rewriting help, refactoring code, fixing bugs and improving performance all combine to make a project grow and improve.
Making a bigger change also is certainly an option, but the focus here is on
going through the procedure, which is somewhat independent from the nature of
the change. The steps are numbered, and it all fits on this one page. Get all
the way to the end, and you will be an open source contributor.
Making a bigger change also is certainly an option, but the focus here is on going through the procedure, which is somewhat independent from the nature of the change.
The steps are numbered, and it all fits on this one page.
Get all the way to the end, and you will be an open source contributor.
## [1] Development Environment Setup
In order to build and test software, you need a development environment. That\'s
just a term that means you need certain tools installed before proceeding. Here
are the tools that Taskwarrior needs:
In order to build and test software, you need a development environment.
That\'s just a term that means you need certain tools installed before proceeding.
Here are the tools that Taskwarrior needs:
- Compiler: GCC 4.7 or newer, or Clang 3.4 or newer.
- Libraries: GnuTLS, and libuuid
- Tools: Git, CMake, make, Python
The procedure for installing this software is OS-dependent, but here are the
commands you would use on Debian:
The procedure for installing this software is OS-dependent, but here are the commands you would use on Debian:
$ sudo apt-get install gcc
$ sudo apt-get install libgnutls28-dev
@ -55,8 +45,8 @@ commands you would use on Debian:
## [2] Get the Code
Now you have the tools, next you need the code. This involves cloning the
repository using git and looking at the development branch:
Now you have the tools, next you need the code.
This involves cloning the repository using git and looking at the development branch:
$ git clone --recursive -b 2.6.0 https://github.com/GothenburgBitFactory/taskwarrior.git taskwarrior.git
Cloning into 'taskwarrior.git'...
@ -68,12 +58,10 @@ repository using git and looking at the development branch:
Checking connectivity... done.
$
The URL for the repository was obtained from looking around on
<https://github.com/GothenburgBitFactory> where several repositories are public,
including the one for this web site.
The URL for the repository was obtained from looking around on <https://github.com/GothenburgBitFactory> where several repositories are public, including the one for this web site.
The clone command above puts you on the right branch, so no need to switch. But
it\'s a good idea to check anyway, so do this:
The clone command above puts you on the right branch, so no need to switch.
But it\'s a good idea to check anyway, so do this:
$ cd taskwarrior.git
$ git branch -a
@ -83,46 +71,41 @@ it\'s a good idea to check anyway, so do this:
remotes/origin/master
$
Here we see that 2.6.0 is the highest-numbered branch, and therefore the current
development branch. If there were a higher numbered branch, you would want to
use that by doing this:
Here we see that 2.6.0 is the highest-numbered branch, and therefore the current development branch.
If there were a higher numbered branch, you would want to use that by doing this:
$ git checkout 2.7.0
Here\'s a thought - if this page does not show the latest branch names, then,
you know, you could fix that\...
Here\'s a thought - if this page does not show the latest branch names, then, you know, you could fix that\...
## [3] Fix Something
Now that you have the code, find something to fix. This may be the hardest step,
but knowing how many typos there are in the source code and docs, it shouldn\'t
take long to find one. Try looking in the files in these directories:
Now that you have the code, find something to fix.
This may be the hardest step, but knowing how many typos there are in the source code and docs, it shouldn\'t take long to find one.
Try looking in the files in these directories:
- `taskwarrior.git/doc/man`
- `taskwarrior.git/scripts`
- `taskwarrior.git/src`
- `taskwarrior.git/test`
It also doesn\'t need to be a typo, it can instead be a poorly-worded sentence,
or one that could be more clear. You\'ll find something, whether it is jargon,
mixed tenses, mistakes, or just plain wrong.
It also doesn\'t need to be a typo, it can instead be a poorly-worded sentence, or one that could be more clear.
You\'ll find something, whether it is jargon, mixed tenses, mistakes, or just plain wrong.
Then fix it, using a text editor. Try to make the smallest possible change to
achieve what you want, because smaller changeѕ are easier to verify and approve,
and no reviewer wants to receive a large change to approve.
Then fix it, using a text editor.
Try to make the smallest possible change to achieve what you want, because smaller changeѕ are easier to verify and approve, and no reviewer wants to receive a large change to approve.
## [4] Run the Test Suite
Taskwarrior has an extensive test suite to prove that things are still working
as expected. You\'ll need to build the program and run this test suite in order
to prove to yourself that your fix is good. It may seem like building the
program is overkill, if you only make a small change, but no, it is not. The
test suite is there to save you from submitting a bad change, and to save
Taskwarrior from any mistakes you make.
Taskwarrior has an extensive test suite to prove that things are still working as expected.
You\'ll need to build the program and run this test suite in order to prove to yourself that your fix is good.
It may seem like building the program is overkill, if you only make a small change, but no, it is not.
The test suite is there to save you from submitting a bad change, and to save Taskwarrior from any mistakes you make.
First you have to build the program. Do this:
First you have to build the program.
Do this:
$ cd taskwarrior.git
$ cmake .
@ -159,7 +142,8 @@ If the above commands worked, there will be a binary, which you can find:
$ ls -l src/task
-rwxr-xr-x 1 user group Mar 25 18:43 src/task
The next step is to build the test suite. Do this:
The next step is to build the test suite.
Do this:
$ cd test
$ make
@ -176,8 +160,7 @@ The next step is to build the test suite. Do this:
[100%] Linking CXX executable view.t
[100%] Built target view.t
Now run the test suite, which can take anywhere from 10 - 500 seconds, depending
on your hardware and OS:
Now run the test suite, which can take anywhere from 10 - 500 seconds, depending on your hardware and OS:
$ ./run_all
Passed: 8300
@ -187,14 +170,16 @@ on your hardware and OS:
Expected failures: 5
Runtime: 32.50 seconds
We are looking for zero failed tests, as shown. This means all is well.
We are looking for zero failed tests, as shown.
This means all is well.
## [5] Commit the Change
Now you\'ve made a change, built and tested the code. The next step is to commit
the change locally. This example assumes you fixed a typo in the man page. Check
to see which file you changed, stage that file, then commit it:
Now you\'ve made a change, built and tested the code.
The next step is to commit the change locally.
This example assumes you fixed a typo in the man page.
Check to see which file you changed, stage that file, then commit it:
$ cd taskwarrior.git
$ git status
@ -213,8 +198,7 @@ to see which file you changed, stage that file, then commit it:
1 file changed, 1 insertion(+)
$
Notice how the commit message looks like this: `Category: Brief description`,
which is how the commit messages should look.
Notice how the commit message looks like this: `Category: Brief description`, which is how the commit messages should look.
## [6] Make a Patch
@ -228,17 +212,14 @@ Once the commit is made, making a patch is simple:
## [7] Submit the Patch
Finally you just need to email that patch file to
`taskwarrior-dev@googlegroups.com`. You will need to attach it to an email, and
not just paste it in, because the mail client will probably mess with the
contents, wrapping lines etc, which can make it unusable.
Finally you just need to email that patch file to `taskwarrior-dev@googlegroups.com`.
You will need to attach it to an email, and not just paste it in, because the mail client will probably mess with the contents, wrapping lines etc, which can make it unusable.
What happens next is that a developer will take your patch and study it, to
ascertain whether it really does fix something that is broken. If there is a
problem, you\'ll hear back with some gentle, constructive criticism. If the
problem is small, it might just get fixed. Then your patch is applied, tested,
and if all looks well, pushed to the public repository, and included in the the
next release. Your name will go into the AUTHORS file, and you will be thanked.
What happens next is that a developer will take your patch and study it, to ascertain whether it really does fix something that is broken.
If there is a problem, you\'ll hear back with some gentle, constructive criticism.
If the problem is small, it might just get fixed.
Then your patch is applied, tested, and if all looks well, pushed to the public repository, and included in the the next release.
Your name will go into the AUTHORS file, and you will be thanked.
Congratulations! Welcome to the wonderful world of open source involvement. Now
do it again\...
Congratulations! Welcome to the wonderful world of open source involvement.
Now do it again\...

140
docs/rfcs/cli.md
View file

@ -4,99 +4,95 @@ title: "Taskwarrior - Command Line Interface"
## Work in Progress
This design document is a work in progress, and subject to change. Once
finalized, the feature will be scheduled for an upcoming release.
This design document is a work in progress, and subject to change. Once finalized, the feature will be scheduled for an upcoming release.
# CLI Syntax Update
The Taskwarrior command line syntax is being updated to allow more consistent
and predictable results, while making room for new features.
The Taskwarrior command line syntax is being updated to allow more consistent and predictable results, while making room for new features.
Adding support for arbitrary expressions on the command line has become
complicated because of the relaxed syntax of Taskwarrior. While the relaxed
syntax allows for a very expressive command line, it also creates ambiguity for
the parser, which needs to be reduced.
Adding support for arbitrary expressions on the command line has become complicated because of the relaxed syntax of Taskwarrior. While the relaxed syntax allows for a very expressive command line, it also creates ambiguity for the parser, which needs to be reduced.
With some limited and careful changes it will be possible to have a clear and
unambiguous command line syntax, which means a predictable and deterministic
experience.
With some limited and careful changes it will be possible to have a clear and unambiguous command line syntax, which means a predictable and deterministic experience.
It should be stated that for straightforward and even current usage patterns,
the command line will likely not change for you. Another goal is to not require
changes to 3rd-party software, where possible. Only the more advanced and as-yet
unintroduced features will require a more strict syntax. This is why now is an
ideal time to tighten the requirements.
It should be stated that for straightforward and even current usage patterns, the command line will likely not change for you. Another goal is to not require changes to 3rd-party software, where possible. Only the more advanced and as-yet unintroduced features will require a more strict syntax. This is why now is an ideal time to tighten the requirements.
## Argument Types
The argument types supported remain the same, adding some new constructs.
--------------------------------------- ---------------------------------------
Config file override `rc:<file>`
* Config file override
* `rc:<file>`
Configuration override `rc:<name>:<value>` Literal value\
`rc:<name>=<value>` Literal value\
`rc:<name>:=<value>` Calculated value
* Configuration override
* `rc:<name>:<value>` Literal value
* `rc:<name>=<value>` Literal value
* `rc:<name>:=<value>` Calculated value
Tag `+<tag>`\
`-<tag>`\
`'+tag one'` Multi-word tag
* Tag
* `+<tag>`
* `-<tag>`
* `'+tag one'` Multi-word tag
Attribute modifier `rc:<name>.<modifier>:<value>`\
Modifier is one of:\
`before`\
`after`\
`under`\
`over`\
`above`\
`below`\
`none`\
`any`\
`is`\
`isnt`\
`equals`\
`not`\
`contains`\
`has`\
`hasnt`\
`left`\
`right`\
`startswith`\
`endswith`\
`word`\
`noword`
* Attribute modifier
* `rc:<name>.<modifier>:<value>`
* Modifier is one of:
* `before`
* `after`
* `under`
* `over`
* `above`
* `below`
* `none`
* `any`
* `is`
* `isnt`
* `equals`
* `not`
* `contains`
* `has`
* `hasnt`
* `left`
* `right`
* `startswith`
* `endswith`
* `word`
* `noword`
Search pattern `/<pattern>/`
* Search pattern
* `/<pattern>/`
Substitution `/<from>/<to>/`\
`/<from>/<to>/g`
* Substitution
* `/<from>/<to>/`
* `/<from>/<to>/g`
Command `add`\
`done`\
`delete`\
`list`\
etc.
* Command
* `add`
* `done`
* `delete`
* `list`
* etc.
Separator `--`
* Separator
* `--`
ID Ranges `<id>[-&ltid>][,<id>[-&ltid>]...]`
* ID Ranges
* `<id>[-&ltid>][,<id>[-&ltid>]...]`
UUID `<uuid>`
* UUID
* `<uuid>`
Everything Else `<word>`\
`'<word> <word> ...'`
--------------------------------------- ---------------------------------------
* Everything Else
* `<word>`
* `'<word> <word> ...'`
## New Command Line Rules
Certain command line constructs will no longer be supported, and this is imposed
by the new rules:
Certain command line constructs will no longer be supported, and this is imposed by the new rules:
1. Each command line argument may contain only one instance of one argument
type, unless that type is `<word>`.
1. Each command line argument may contain only one instance of one argument type, unless that type is `<word>`.
task add project:Home +tag Repair the thing # Good
task add project:Home +tag 'Repair the thing' # Good
@ -118,15 +114,13 @@ by the new rules:
task /one two/ list # Bad
task /'one two'/ list # Bad, unless ' is part of the pattern
3. By default, *no* calculations are made, unless the `:=` eval operator is
used, and if so, the whole argument may need to be quoted or escaped to
satisfy Rule 1.
3. By default, *no* calculations are made, unless the `:=` eval operator is used, and if so, the whole argument may need to be quoted or escaped to satisfy Rule 1.
task add project:3.project+x # Literal
task add project:=3.project+x # DOM reference + concatenation
4. Bare word search terms are no longer supported. Use the pattern type
argument instead.
4. Bare word search terms are no longer supported.
Use the pattern type argument instead.
task /foo/ list # Good
task foo list # Bad
@ -143,8 +137,7 @@ Aside from the command line parser, there are other changes needed:
- Many online documents will need to be modified.
- Filters will be automatically parenthesized, so that every command line will
now looke like:
- Filters will be automatically parenthesized, so that every command line will now looke like:
task [overrides] [(cli-filter)] [(context-filter)] [(report-filter)] command [modifications]
@ -158,5 +151,4 @@ Aside from the command line parser, there are other changes needed:
hhmmss # Bad
hh:mm:ss # Good
- The tutorial videos will be even more out of date, and will be replaced by a
large number of smaller demo \'movies\'.
- The tutorial videos will be even more out of date, and will be replaced by a large number of smaller demo \'movies\'.

254
docs/rfcs/client.md
View file

@ -5,48 +5,36 @@ title: "Taskwarrior - Creating a Taskserver Client"
# Creating a Taskserver Client
A Taskserver client is a todo-list manager. It may be as simple as a program
that captures a single task, as complex as Taskwarrior, or anything in between.
A Taskserver client is a todo-list manager.
It may be as simple as a program that captures a single task, as complex as Taskwarrior, or anything in between.
It can be a mobile client, a web application, or any other type of program.
This document describes how such a client would interact with the server.
A client to the Taskserver is a program that manages a task list, and wishes to
exchange data with the server so that the task list may be shared.
A client to the Taskserver is a program that manages a task list, and wishes to exchange data with the server so that the task list may be shared.
In order to do this, a client must store tasks locally, upload local changes,
download remote changes, and apply remote changes to the local tasks.
In order to do this, a client must store tasks locally, upload local changes, download remote changes, and apply remote changes to the local tasks.
The client must consider that there may be no network connectivity, or no desire
by the user to synchronize.
The client must consider that there may be no network connectivity, or no desire by the user to synchronize.
The client will need proper credentials to talk to the server.
## Requirements
In this document, we adopt the convention discussed in Section 1.3.2 of
[RFC1122](https://tools.ietf.org/html/rfc1122#page-16) of using the capitalized
words MUST, REQUIRED, SHOULD, RECOMMENDED, MAY, and OPTIONAL to define the
significance of each particular requirement specified in this document.
In this document, we adopt the convention discussed in Section 1.3.2 of [RFC1122](https://tools.ietf.org/html/rfc1122#page-16) of using the capitalized words MUST, REQUIRED, SHOULD, RECOMMENDED, MAY, and OPTIONAL to define the significance of each particular requirement specified in this document.
In brief: \"MUST\" (or \"REQUIRED\") means that the item is an absolute
requirement of the specification; \"SHOULD\" (or \"RECOMMENDED\") means there
may exist valid reasons for ignoring this item, but the full implications should
be understood before doing so; and \"MAY\" (or \"OPTIONAL\") means that this
item is optional, and may be omitted without careful consideration.
In brief: \"MUST\" (or \"REQUIRED\") means that the item is an absolute requirement of the specification; \"SHOULD\" (or \"RECOMMENDED\") means there may exist valid reasons for ignoring this item, but the full implications should be understood before doing so; and \"MAY\" (or \"OPTIONAL\") means that this item is optional, and may be omitted without careful consideration.
## Taskserver Account
A Taskserver account must be created. This process creates a storage area, and
generates the necessary credentials.
A Taskserver account must be created.
This process creates a storage area, and generates the necessary credentials.
## Credentials
A Taskserver client needs the following credentials in order to communicate with
a server:
A Taskserver client needs the following credentials in order to communicate with a server:
- Server address and port
- Organization name
@ -55,45 +43,44 @@ a server:
- Certificate
- Key
The server address and port are the network location of the server. An example
of this value is:
The server address and port are the network location of the server.
An example of this value is:
foo.example.com:53589
In addition to a DNS name, this can be an IPv4 or IPv6 address.
The organization name is an arbitrary grouping, and is typically \'PUBLIC\',
reflecting the individual nature of server accounts. Future capabilities will
provide functionality that support groups of users, called an organization.
The organization name is an arbitrary grouping, and is typically \'PUBLIC\', reflecting the individual nature of server accounts.
Future capabilities will provide functionality that support groups of users, called an organization.
The user name is the full name. This will be the name used to identify other
users in an organization, in a future release. Example \'John Doe\'.
The user name is the full name.
This will be the name used to identify other users in an organization, in a future release.
Example \'John Doe\'.
The password is a text string generated by the server at account creation time.
It should be considered a secret.
The certificate is an X.509 PEM file generated by the server at account creation
time. This is used for authentication. It should be considered a secret.
The certificate is an X.509 PEM file generated by the server at account creation time.
This is used for authentication.
It should be considered a secret.
The key is an X.509 PEM file generated by the server at account creation time.
This is used for encryption. It should be considered a secret.
This is used for encryption.
It should be considered a secret.
These credentials need to be stored on the client, and used during the sync
operation.
These credentials need to be stored on the client, and used during the sync operation.
## Description of a Taskserver Client
This section describes how a client might behave in order to facilitate
integration with the Taskserver.
This section describes how a client might behave in order to facilitate integration with the Taskserver.
## Encryption
The Taskserver only communicates using encryption. Therefore all user data is
encrypted while in transit. The Taskserver currently uses
[GnuTLS](https://gnutls.org) to support this encryption, and therefore supports
the following protocols:
The Taskserver only communicates using encryption.
Therefore all user data is encrypted while in transit.
The Taskserver currently uses [GnuTLS](https://gnutls.org) to support this encryption, and therefore supports the following protocols:
- SSL 3.0
- TLS 1.0
@ -105,139 +92,116 @@ The client may use any library that supports the above.
## Configuration
The client needs to store configuration, which matches the credentials needed
for Taskserver communication. See section 2.1 \"Credentials\".
The client needs to store configuration, which matches the credentials needed for Taskserver communication.
See section 2.1 \"Credentials\".
The credentials may not be modified by the user without losing server access.
The server:port data may need to be changed automatically following a redirect
response from the server. See section 5 \"Server Errors\".
The server:port data may need to be changed automatically following a redirect response from the server.
See section 5 \"Server Errors\".
## Local Storage
The client needs to store task data locally. The client will need to be able to
find tasks by their UUID and overwrite them. Uploaded and downloaded task
changes will use the [Taskwarrior Data Interchange
Format](/docs/design/task).
The client needs to store task data locally.
The client will need to be able to find tasks by their UUID and overwrite them.
Uploaded and downloaded task changes will use the [Taskwarrior Data Interchange Format](/docs/design/task).
## Local Changes
Whenever local data is modified, that change MUST be synced with the server. But
this does not have to occur immediately, in fact the client SHOULD NOT assume
connectivity at any time.
Whenever local data is modified, that change MUST be synced with the server.
But this does not have to occur immediately, in fact the client SHOULD NOT assume connectivity at any time.
A client SHOULD NOT also assume that the server is available. If the server is
not available, the local changes should be retained, and the sync operation
repeated later.
A client SHOULD NOT also assume that the server is available.
If the server is not available, the local changes should be retained, and the sync operation repeated later.
Ideally the client will give the user full control over sync operations.
Automatically syncing after all local modifications is not recommended. If a
client performs too many sync operations, the server MAY revoke the certificate.
Automatically syncing after all local modifications is not recommended.
If a client performs too many sync operations, the server MAY revoke the certificate.
Effectively, the client should maintain a separate list of tasks changed since
the last successful sync operation.
Effectively, the client should maintain a separate list of tasks changed since the last successful sync operation.
Note that tasks have a \"modified\" attribute, which should be updated whenever
a change is made. This attribute contributes to conflict resolution on the
server.
Note that tasks have a \"modified\" attribute, which should be updated whenever a change is made.
This attribute contributes to conflict resolution on the server.
## Remote Changes
When a server sends remote changes to a client, in the response to a sync
request, the changes have already been merged by the server, and therefore the
client should simply store them intact.
When a server sends remote changes to a client, in the response to a sync request, the changes have already been merged by the server, and therefore the client should simply store them intact.
Based on the UUID in the task, the client can determine whether a task is new
(and should be added to the local list of tasks), or whether it represents a
modification (and should overwrite it\'s existing entry).
Based on the UUID in the task, the client can determine whether a task is new (and should be added to the local list of tasks), or whether it represents a modification (and should overwrite it\'s existing entry).
The client MUST NOT perform any merges.
## Sync Key
Whenever a sync is performed, the server responds by sending a sync key and any
remote changes. The sync key is important, and should be included in the next
sync request. The client is REQUIRED to store the sync key in every server
response message.
Whenever a sync is performed, the server responds by sending a sync key and any remote changes.
The sync key is important, and should be included in the next sync request.
The client is REQUIRED to store the sync key in every server response message.
If a client omits the sync key in a sync message, the response will be a
complete set of all tasks and modifications.
If a client omits the sync key in a sync message, the response will be a complete set of all tasks and modifications.
## Data Integrity
Although a task is guaranteed to contain at least \'entry\', \'description\' and
\'uuid\' attributes, it may also contain other known fields, and unknown
user-defined fields. An example might be an attribute named \'estimate\'.
Although a task is guaranteed to contain at least \'entry\', \'description\' and \'uuid\' attributes, it may also contain other known fields, and unknown user-defined fields.
An example might be an attribute named \'estimate\'.
If a task is received via sync that contains an attribute named \'estimate\',
then a client has the responsibility of preserving the attribute intact. If that
data is shown, then it is assumed to be of type \'string\', which is the format
used by JSON for all values.
If a task is received via sync that contains an attribute named \'estimate\', then a client has the responsibility of preserving the attribute intact.
If that data is shown, then it is assumed to be of type \'string\', which is the format used by JSON for all values.
Conversely, if a client wishes to add a custom attribute, it is guaranteed that
the server and other clients will preserve that attribute.
Conversely, if a client wishes to add a custom attribute, it is guaranteed that the server and other clients will preserve that attribute.
Using this rule, two clients of differing capabilities can exchange data and
still maintain custom attributes.
Using this rule, two clients of differing capabilities can exchange data and still maintain custom attributes.
This is a requirement. Any client that does not obey this requirement is broken.
This is a requirement.
Any client that does not obey this requirement is broken.
## Synchronizing
Synchronizing with the Taskserver consists of a single transaction. Once an
encrypted connection is made with the server, the client MUST compose a [sync
request message](/docs/design/request). This message includes credentials
and local changes. The response message contains status and remote changes,
which MUST be stored locally.
Synchronizing with the Taskserver consists of a single transaction.
Once an encrypted connection is made with the server, the client MUST compose a [sync request message](/docs/design/request).
This message includes credentials and local changes.
The response message contains status and remote changes, which MUST be stored locally.
## Establishing Encrypted Connection
All communication with the Taskserver is encrypted using the certificate and key
provided to each user. Using the \'server\' configuration setting, establish a
connection.
All communication with the Taskserver is encrypted using the certificate and key provided to each user.
Using the \'server\' configuration setting, establish a connection.
## Sync Request
See [sync request message](/docs/design/request). A sync request MUST
contain a sync key if one was provided by a previous sync. A sync request MUST
contain a list of modified tasks, in JSON format (see [Task
JSON](/docs/design/task)), if local modifications have been made.
See [sync request message](/docs/design/request).
A sync request MUST contain a sync key if one was provided by a previous sync.
A sync request MUST contain a list of modified tasks, in JSON format (see [Task JSON](/docs/design/task)), if local modifications have been made.
## Sync Response
A sync response WILL contain a \'code\' and \'status\' header variable, WILL
contain a sync key in the payload, and MAY contain a list of tasks from the
server in JSON format (see [Task JSON](/docs/design/task)).
A sync response WILL contain a \'code\' and \'status\' header variable, WILL contain a sync key in the payload, and MAY contain a list of tasks from the server in JSON format (see [Task JSON](/docs/design/task)).
## Server Messages
There are cases when the server needs to inform the user of some condition. This
may be anticipated server downtime, for example. The response message is
typically not present, but may be present in the header, containing a string:
There are cases when the server needs to inform the user of some condition.
This may be anticipated server downtime, for example.
The response message is typically not present, but may be present in the header, containing a string:
...
message: Scheduled maintenance 2013-07-14 08:00UTC for 10 minutes.
...
If such a message is returned by the server, it SHOULD be made available to the
user. This is a recommendation, not a requirement.
If such a message is returned by the server, it SHOULD be made available to the user.
This is a recommendation, not a requirement.
## Server Errors
The server may generate many errors (See
[Protocol](/docs/design/protocol)), but the following is a list of the ones
most in need of special handling:
The server may generate many errors (See [Protocol](/docs/design/protocol)), but the following is a list of the ones most in need of special handling:
- 200 Success
- 201 No change
@ -247,11 +211,12 @@ most in need of special handling:
- 432 Account terminated
- 5xx Error
The 200 indicates success, and that a change was recorded. The 201 indicates
success but no changes were necessary. The 301 is a redirect message indicating
that the client MUST re-request from a new server. The 43x series messages are
account-related. Any 5xx series code is a server error of some kind. All errors
consist of a code and a status message:
The 200 indicates success, and that a change was recorded.
The 201 indicates success but no changes were necessary.
The 301 is a redirect message indicating that the client MUST re-request from a new server.
The 43x series messages are account-related.
Any 5xx series code is a server error of some kind.
All errors consist of a code and a status message:
code: 200
status: Success
@ -259,11 +224,10 @@ consist of a code and a status message:
## Examples
Here are examples of properly formatted request and response messages. Note that
the messages are indented for clarity in this document, but is not the case in a
properly formatted message. Also note that newline characters U+000D are not
shown, but are implied by the separate lines. Because some messages have
trailing newline characters, the text is delimited by the \'cut\' markers:
Here are examples of properly formatted request and response messages.
Note that the messages are indented for clarity in this document, but is not the case in a properly formatted message.
Also note that newline characters U+000D are not shown, but are implied by the separate lines.
Because some messages have trailing newline characters, the text is delimited by the \'cut\' markers:
foo
@ -275,8 +239,7 @@ The example above illustrates text consisting of:
U+000D newline
U+000D newline
Note that these values are left unspecified, but should be clear from the
context, and the [message format](/docs/design/request) spec:
Note that these values are left unspecified, but should be clear from the context, and the [message format](/docs/design/request) spec:
<size>
<organization>
@ -286,8 +249,7 @@ context, and the [message format](/docs/design/request) spec:
## First Sync
The first time a client syncs, there is (perhaps) no data to upload, and no sync
key from a previous sync.
The first time a client syncs, there is (perhaps) no data to upload, and no sync key from a previous sync.
<size>type: sync
org: <organization>
@ -296,15 +258,12 @@ key from a previous sync.
client: task 2.3.0
protocol: v1
Note the double newline character separating header from payload, with an empty
payload.
Note the double newline character separating header from payload, with an empty payload.
## Request: Sync No Data
Ordinarily when a client syncs, there is a sync key from the previous sync
response to send. This example shows a sync with no local changes, but a sync
key from a previous sync.
Ordinarily when a client syncs, there is a sync key from the previous sync response to send.
This example shows a sync with no local changes, but a sync key from a previous sync.
<size>type: sync
org: <organization>
@ -318,8 +277,7 @@ key from a previous sync.
## Request: Sync Data
This sync request shows a sync key from the previous sync, and a locally
modified task.
This sync request shows a sync key from the previous sync, and a locally modified task.
<size>type: sync
org: <organization>
@ -334,8 +292,7 @@ modified task.
## Response: No Data
If a sync results in no downloads to the client, the response will look like
this.
If a sync results in no downloads to the client, the response will look like this.
<size>type: response
client: taskd 1.0.0
@ -345,14 +302,12 @@ this.
45da7110-1bcc-4318-d33e-12267a774e0f
Note that there is a sync key which must be stored and used in the next sync
request, but there are no remote changes to store.
Note that there is a sync key which must be stored and used in the next sync request, but there are no remote changes to store.
## Response: Remote Data
This shows a sync response providing a new sync key, and a remote change to two
tasks.
This shows a sync response providing a new sync key, and a remote change to two tasks.
<size>type: response
client: taskd 1.0.0
@ -366,8 +321,7 @@ tasks.
Note that the sync key must be stored for the next sync request.
Note that the two changed tasks must be stored locally, and if the UUID in the
tasks matches local tasks, then the local tasks must be overwritten.
Note that the two changed tasks must be stored locally, and if the UUID in the tasks matches local tasks, then the local tasks must be overwritten.
## Response: Error
@ -378,8 +332,7 @@ tasks matches local tasks, then the local tasks must be overwritten.
code: 431
status: Account suspended
Note the double newline character separating header from payload, with an empty
payload.
Note the double newline character separating header from payload, with an empty payload.
## Response: Relocate
@ -391,22 +344,18 @@ payload.
status: Redirect
info:
Note the \'info\' field will contain a \':\' string that should be used for all
future sync requests. This indicates that a user account was moved to another
server.
Note the \'info\' field will contain a \':\' string that should be used for all future sync requests.
This indicates that a user account was moved to another server.
Note the double newline character separating header from payload, with an empty
payload.
Note the double newline character separating header from payload, with an empty payload.
## Response: Message
Occasionally the server will need to convey a message, and will include an
additional header variable containing that message.
Occasionally the server will need to convey a message, and will include an additional header variable containing that message.
The server [protocol](/docs/design/protocol) states that the message SHOULD
be shown to the user. This message will be used for system event messages, used
rarely, and never used for advertising or promotion.
The server [protocol](/docs/design/protocol) states that the message SHOULD be shown to the user.
This message will be used for system event messages, used rarely, and never used for advertising or promotion.
<size>type: response
client: taskd 1.0.0
@ -422,8 +371,7 @@ Note that the same message will likely be included in consecutive responses.
## Reference Implementation
The Taskserver 1.1.0 codebase contains a reference implementation of an SSL/TLS
client and server program, which communicate text strings.
The Taskserver 1.1.0 codebase contains a reference implementation of an SSL/TLS client and server program, which communicate text strings.
taskd.git/src/tls/Makefile # To build the example
taskd.git/src/tls/README # How to run the example

84
docs/rfcs/dom.md
View file

@ -4,14 +4,14 @@ title: "Taskwarrior - Full DOM Support"
## Work in Progress
This design document is a work in progress, and subject to change. Once
finalized, the feature will be scheduled for an upcoming release.
This design document is a work in progress, and subject to change.
Once finalized, the feature will be scheduled for an upcoming release.
# Full DOM Support
Taskwarrior currently supports DOM references that can access any stored data
item. The general forms supported are:
Taskwarrior currently supports DOM references that can access any stored data item.
The general forms supported are:
[ <id> | <uuid> ] <attribute> [ <part> ]
@ -23,8 +23,7 @@ Examples include:
123.annotations.0.entry.year
a87bc10f-931b-4558-a44a-e901a77db011.description
Additionally there are references for accessing configuration and system/program
level items.
Additionally there are references for accessing configuration and system/program level items.
rc.<name>
context.program
@ -34,10 +33,8 @@ level items.
system.version
system.os
While this is adequate for data retrieval, we have the possibility of extending
it further to include data formats, higher-level constructs, and then to make
use of DOM references in more locations. This contributes to our goal of
simplifying Taskwarrior.
While this is adequate for data retrieval, we have the possibility of extending it further to include data formats, higher-level constructs, and then to make use of DOM references in more locations.
This contributes to our goal of simplifying Taskwarrior.
## Proposed Format Support
@ -50,12 +47,11 @@ This syntax is:
<attribute> [ . <format> ]
If no `format` is specified, then `default` is assumed. The src/columns/ColΧ\*
objects are responsible for supporting and rendering these formats. There is
currently no consistency among these formats based on data type.
If no `format` is specified, then `default` is assumed.
The `src/columns/ColΧ\*` objects are responsible for supporting and rendering these formats.
There is currently no consistency among these formats based on data type.
By incorporating formats into DOM references, we eliminate the need for a
separate syntax for custom reports, and provide this:
By incorporating formats into DOM references, we eliminate the need for a separate syntax for custom reports, and provide this:
123.due.iso
123.due.month.short
@ -161,8 +157,7 @@ json
`"<attribute>":"<value>"`
There will also be a set of attribute-specific formats, similar to the currently
supported set:
There will also be a set of attribute-specific formats, similar to the currently supported set:
depends.list
depends.count
@ -186,21 +181,19 @@ supported set:
uuid.default|long
uuid.short
Custom report sort criteria will also use DOM references. This will be augmented
by the `+`/`-` sort direction and `/` break indicator, which are not part of the
DOM.
Custom report sort criteria will also use DOM references.
This will be augmented by the `+`/`-` sort direction and `/` break indicator, which are not part of the DOM.
## High Level Construct Support
There need to be read-only DOM references that do not correspond directly to
stored attributes. Tasks have emergent properties represented by virtual tags,
which will be accessible, in this case returning a `0` or `1`:
There need to be read-only DOM references that do not correspond directly to stored attributes.
Tasks have emergent properties represented by virtual tags, which will be accessible, in this case returning a `0` or `1`:
123.tags.OVERDUE
Using `rc.due` and the `due` attribute, the `OVERDUE` virtual tag is a
combination of the two. Other examples may include:
Using `rc.due` and the `due` attribute, the `OVERDUE` virtual tag is a combination of the two.
Other examples may include:
task.syncneeded
task.pending.count
@ -209,8 +202,8 @@ combination of the two. Other examples may include:
## Writable References
When a DOM reference refers to an attribute or RC setting, and does not extend
further and reference a component or format, it may be writable. For example:
When a DOM reference refers to an attribute or RC setting, and does not extend further and reference a component or format, it may be writable.
For example:
rc.hooks # writable
123.description # writable
@ -219,8 +212,7 @@ further and reference a component or format, it may be writable. For example:
## Data Interchange
The export command can be used to show a filtered set of tasks in JSON format,
and this will also be available as a DOM format:
The export command can be used to show a filtered set of tasks in JSON format, and this will also be available as a DOM format:
123.json
a87bc10f-931b-4558-a44a-e901a77db011.json
@ -228,32 +220,30 @@ and this will also be available as a DOM format:
## RC File Support
The RC file (`~/.taskrc`) will support DOM references in values. This will form
a late-bound reference, which is evaluated at runtime, every time.
The RC file (`~/.taskrc`) will support DOM references in values.
This will form a late-bound reference, which is evaluated at runtime, every time.
An example is to make two reports share the same description:
$ task config -- report.ls.description rc.report.list.description
This sets the description for the `ls` report to be a reference to the
description of the `list` report. This reference is not evaluated when the entry
is written, but is evaluated every time the value is read, thus providing
late-bound behavior. Then if the description of the `list` report changes, so
does that of the `ls` report automatically.
This sets the description for the `ls` report to be a reference to the description of the `list` report.
This reference is not evaluated when the entry is written, but is evaluated every time the value is read, thus providing late-bound behavior.
Then if the description of the `list` report changes, so does that of the `ls` report automatically.
## Implementation Details
These notes list a series of anticipated changes to the codebase.
- The `src/columns/Col*` objects will implement type-specific and
attribute-specific DOM support. DOM reference lookup will defer to the
column objects first.
- Some DOM references will be writable, permitting a `_set` command to
complement the `_get` command.
- The `Config` object will recognize DOM references in values and perform
lookup at read time. This will require circularity detection.
- `src/DOM.cpp` will provide a memoized function to determine whether a DOM
reference is valid.
- `src/DOM.cpp` will provide a function to obtain a DOM reference value, with
supporting metadata (type, writable).
- The `src/columns/Col*` objects will implement type-specific and attribute-specific DOM support.
DOM reference lookup will defer to the column objects first.
- Some DOM references will be writable, permitting a `_set` command to complement the `_get` command.
- The `Config` object will recognize DOM references in values and perform lookup at read time.
This will require circularity detection.
- `src/DOM.cpp` will provide a memoized function to determine whether a DOM reference is valid.
- `src/DOM.cpp` will provide a function to obtain a DOM reference value, with supporting metadata (type, writable).

12
docs/rfcs/plans.md
View file

@ -2,13 +2,13 @@
title: "Plans"
---
There are many interconnected features and technologies in Taskwarrior,
Taskserver, Tasksh and Timewarrior, each piece having it's own goals.
There are many interconnected features and technologies in Taskwarrior, Taskserver, Tasksh and Timewarrior, each piece having it's own goals.
This matrix allows a simple reading of where things are, and where they are
going. This is a low-resolution time line. It is subject to change. It does not
constitute a concrete plan. This is an all-volunteer effort, and scheduling is
difficult.
This matrix allows a simple reading of where things are, and where they are going.
This is a low-resolution time line.
It is subject to change.
It does not constitute a concrete plan.
This is an all-volunteer effort, and scheduling is difficult.
[Last updated 2016-08-08.]

234
docs/rfcs/protocol.md
View file

@ -8,204 +8,164 @@ title: "Taskwarrior - Sync Protocol"
## Introduction
Taskwarrior data has typically been shared in several ways. Those include SCM
(source code management) systems, directory synchronizing software (such as
DropBox), and by use of the \'push\', \'pull\' and \'merge\' commands introduced
in version 1.9.3.
Taskwarrior data has typically been shared in several ways.
Those include SCM (source code management) systems, directory synchronizing software (such as DropBox), and by use of the \'push\', \'pull\' and \'merge\' commands introduced in version 1.9.3.
While these methods work, they each have problems associated with the merging of
data. In the case of directory synchronizing software, there is no merging at
all - just simple file overwrite, despite many people believing that the data is
somehow combined and preserved.
While these methods work, they each have problems associated with the merging of data.
In the case of directory synchronizing software, there is no merging at all - just simple file overwrite, despite many people believing that the data is somehow combined and preserved.
The Taskserver is a solution. It is an online/cloud storage and sync service for
taskwarrior data. It performs conflict-free data merging, and minimizes
bandwidth use.
The Taskserver is a solution.
It is an online/cloud storage and sync service for taskwarrior data.
It performs conflict-free data merging, and minimizes bandwidth use.
The Taskserver also provides multi-client access, so that a task added using a
web client could be immediately viewed using a mobile client, or modified using
taskwarrior. Choice of clients is important - people have widely varying
behaviors and tastes.
The Taskserver also provides multi-client access, so that a task added using a web client could be immediately viewed using a mobile client, or modified using taskwarrior.
Choice of clients is important - people have widely varying behaviors and tastes.
The Taskserver also provides multi-user access, which introduces new
capabilities, such as list sharing and delegation. These will require later
modification to this protocol.
The Taskserver also provides multi-user access, which introduces new capabilities, such as list sharing and delegation.
These will require later modification to this protocol.
The Taskserver protocol will be implemented by the taskd project and first used
in taskwarrior 2.3.0. Other clients will follow.
The Taskserver protocol will be implemented by the taskd project and first used in taskwarrior 2.3.0.
Other clients will follow.
## Requirements
In this document, we adopt the convention discussed in Section 1.3.2 of
[RFC1122](https://tools.ietf.org/html/rfc1122#page-16) of using the capitalized
words MUST, REQUIRED, SHOULD, RECOMMENDED, MAY, and OPTIONAL to define the
significance of each particular requirement specified in this document.
In this document, we adopt the convention discussed in Section 1.3.2 of [RFC1122](https://tools.ietf.org/html/rfc1122#page-16) of using the capitalized words MUST, REQUIRED, SHOULD, RECOMMENDED, MAY, and OPTIONAL to define the significance of each particular requirement specified in this document.
In brief: \"MUST\" (or \"REQUIRED\") means that the item is an absolute
requirement of the specification; \"SHOULD\" (or \"RECOMMENDED\") means there
may exist valid reasons for ignoring this item, but the full implications should
be understood before doing so; and \"MAY\" (or \"OPTIONAL\") means that this
item is optional, and may be omitted without careful consideration.
In brief: \"MUST\" (or \"REQUIRED\") means that the item is an absolute requirement of the specification; \"SHOULD\" (or \"RECOMMENDED\") means there may exist valid reasons for ignoring this item, but the full implications should be understood before doing so; and \"MAY\" (or \"OPTIONAL\") means that this item is optional, and may be omitted without careful consideration.
## Link Level
The Taskserver protocol assumes a reliable data stream such as provided by TCP.
When TCP is used, a Taskserver listens on a single predetermined port *for the
given client* only. This means the server may be using multiple ports to serve
distinct sets of clients.
When TCP is used, a Taskserver listens on a single predetermined port *for the given client* only.
This means the server may be using multiple ports to serve distinct sets of clients.
This server is only an interface between programs and the task data. It does not
perform any user interaction or presentation-level functions.
This server is only an interface between programs and the task data.
It does not perform any user interaction or presentation-level functions.
## Transactions
Each transaction is a single incoming message, with a single response message.
All communication therefore consists of a single \'send\', followed by a single
\'receive\', then termination. There are no sessions, and no continuously open
connections. The message format is described in the [Taskserver Message
Format](/docs/design/request) document.
All communication therefore consists of a single \'send\', followed by a single \'receive\', then termination.
There are no sessions, and no continuously open connections.
The message format is described in the [Taskserver Message Format](/docs/design/request) document.
## Responsibilities of the Server
The server will maintain a set of transactions, in the original sequence,
punctuated by sync keys which are UUIDs. Each sync key represents a non- trivial
sync operation by a client. Each transaction is a [JSON-formatted
task](/docs/design/task), followed by a newline (\\n) character. The result
is a single file that contains interleaved lines of two types: tasks and sync
keys.
The server will maintain a set of transactions, in the original sequence, punctuated by sync keys which are UUIDs.
Each sync key represents a non- trivial sync operation by a client.
Each transaction is a [JSON-formatted task](/docs/design/task), followed by a newline (\\n) character.
The result is a single file that contains interleaved lines of two types: tasks and sync keys.
This design allows the server to maintain a set of deltas such that multiple
clients may request a minimal set of changes since their last sync.
This design allows the server to maintain a set of deltas such that multiple clients may request a minimal set of changes since their last sync.
## Responsibilities of the Client
This describes how Taskwarrior implements sync.
All modifications to tasks (add, modify, done, delete \...) are recorded in the
form of a fully-composed [JSON-formatted task](/docs/design/task). The
formatted task is added to a local backlog.data file. If a task is modified a
second time, it is added again to the backlog.data file - the lines are not
combined. Each task SHALL have a \'modified\' date attribute that will help
resolve conflicts.
All modifications to tasks (add, modify, done, delete \...) are recorded in the form of a fully-composed [JSON-formatted task](/docs/design/task).
The formatted task is added to a local backlog.data file.
If a task is modified a second time, it is added again to the backlog.data file - the lines are not combined.
Each task SHALL have a \'modified\' date attribute that will help resolve conflicts.
On sync:
- Send a \'sync\' type message with the entire contents of the backlog.data,
unmodified, as the message payload.
- Send a \'sync\' type message with the entire contents of the backlog.data, unmodified, as the message payload.
- Receive one of the following response codes:
- 201: This means \'no change\', and there is no further action to be
taken.
- 200: This means \'success\', and the message payload contains a set of
tasks and a sync key:
- The formatted tasks are to be stored as-is. These tasks will either
be appended to the client data or will overwrite existing client
data, based on the UUID of the task. No merge logic is necessary.
- The sync key will be written to the backlog.data file, overwriting
the previous contents, such that it will now contain only one line.
- 301: Redirect to : found in the \'info\' response header, will force the
client to resubmit the request to the new server.
- 201: This means \'no change\', and there is no further action to be taken.
- 200: This means \'success\', and the message payload contains a set of tasks and a sync key:
- The formatted tasks are to be stored as-is.
These tasks will either be appended to the client data or will overwrite existing client data, based on the UUID of the task.
No merge logic is necessary.
- The sync key will be written to the backlog.data file, overwriting the previous contents, such that it will now contain only one line.
- 301: Redirect to : found in the \'info\' response header, will force the client to resubmit the request to the new server.
- 3xx, 4xx, 5xx: The \'status\' field contains an error message.
- If the response contained any error or warning, the error should be shown to
the user. This provides an opportunity for the server to announce downtime,
or relocation.
If no sync key is sent, the server cannot provide an incremental delta, and so
will send all task data, which should be stored as above. This should be the
case for a client making its first sync call.
- If the response contained any error or warning, the error should be shown to the user.
This provides an opportunity for the server to announce downtime, or relocation.
If an unrecognized attribute is present in the task data, the client MUST
preserve the attribute unmodified, and assume it is of type \'string\'. This
permits individual clients to augment the task data without other clients
stripping it meaningful data. This is how UDAs (user defined attributes) are
handled.
If no sync key is sent, the server cannot provide an incremental delta, and so will send all task data, which should be stored as above.
This should be the case for a client making its first sync call.
If an unrecognized attribute is present in the task data, the client MUST preserve the attribute unmodified, and assume it is of type \'string\'.
This permits individual clients to augment the task data without other clients stripping it meaningful data.
This is how UDAs (user defined attributes) are handled.
## Extensions
This protocol was designed so that extensions to the protocol will take the form
of additional message types and status codes.
This protocol was designed so that extensions to the protocol will take the form of additional message types and status codes.
## Summary of Response Codes
Status responses indicate the server\'s response to the last command received
from the client. The codes consist of a 3 digit numeric code.
Status responses indicate the server\'s response to the last command received from the client.
The codes consist of a 3 digit numeric code.
The first digit of the response broadly indicates the success, failure, or
progress of the previous command (based generally on
[RFC640](https://tools.ietf.org/html/rfc640)
[RFC821](https://tools.ietf.org/html/rfc821)):
The first digit of the response broadly indicates the success, failure, or progress of the previous command (based generally on [RFC640](https://tools.ietf.org/html/rfc640) [RFC821](https://tools.ietf.org/html/rfc821)):
----- -------------------------------------
1yz Positive Preliminary reply
2yz Positive Completion reply
3yz Positive Intermediate reply
4yz Transient Negative Completion reply
5yz Permanent Negative Completion reply
----- -------------------------------------
| 1yz | Positive Preliminary reply |
| 2yz | Positive Completion reply |
| 3yz | Positive Intermediate reply |
| 4yz | Transient Negative Completion reply |
| 5yz | Permanent Negative Completion reply |
The next digit in the code indicates the response category:
----- -------------------------------------------------
x0z Syntax
x1z Information (e.g., help)
x2z Connections
x3z Authentication
x4z Unspecified as yet
x5z Taskd System (\...)
x8z Nonstandard (private implementation) extensions
----- -------------------------------------------------
| x0z | Syntax |
| x1z | Information (e.g., help) |
| x2z | Connections |
| x3z | Authentication |
| x4z | Unspecified as yet |
| x5z | Taskd System (\...) |
| x8z | Nonstandard (private implementation) extensions |
A summary of all status response are:
----- -----------
200 Success
201 No change
----- -----------
----- ----------------------------------------------------------------------------------------------------------------------------------------------
300 Deprecated message type. This message will not be supported in future Taskserver releases.
301 Redirect. Further requests should be made to the specified server/port.
302 Retry. The client is requested to wait and retry the same request. The wait time is not specified, and further retry responses are possible.
----- ----------------------------------------------------------------------------------------------------------------------------------------------
----- ------------------------------------------
400 Malformed data
401 Unsupported encoding
420 Server temporarily unavailable
421 Server shutting down at operator request
430 Access denied
431 Account suspended
432 Account terminated
----- ------------------------------------------
----- -----------------------------------
500 Syntax error in request
501 Syntax error, illegal parameters
502 Not implemented
503 Command parameter not implemented
504 Request too big
----- -----------------------------------
| 200 | Success |
| 201 | No change |
| 300 | Deprecated message type. This message will not be supported in future Taskserver releases. |
| 301 | Redirect. Further requests should be made to the specified server/port. |
| 302 | Retry. The client is requested to wait and retry the same request. The wait time is not specified, and further retry responses are possible. |
| 400 | Malformed data |
| 401 | Unsupported encoding |
| 420 | Server temporarily unavailable |
| 421 | Server shutting down at operator request |
| 430 | Access denied |
| 431 | Account suspended |
| 432 | Account terminated |
| 500 | Syntax error in request |
| 501 | Syntax error, illegal parameters |
| 502 | Not implemented |
| 503 | Command parameter not implemented |
| 504 | Request too big |
## Security Considerations
All communication with the Taskserver uses SSL 3.0 or TLS 1.0, 1.1 or 1.2.
Encryption is mandatory. Data is never transmitted in plain text.
Encryption is mandatory.
Data is never transmitted in plain text.
## Limitations and Guidelines
Some limitations exists to reduce bandwidth and load on the server. They are:
Some limitations exists to reduce bandwidth and load on the server.
They are:
- A client may only connect to a single server. Synchronization among a set of
servers is not supported.
- A client should attempt to minimize data bandwidth usage by maintaining a
local data store, and properly using sync keys.
- A client should minimize data transfers by limiting the frequency of sync
requests.
- A client may only connect to a single server.
Synchronization among a set of servers is not supported.
- A client should attempt to minimize data bandwidth usage by maintaining a local data store, and properly using sync keys.
- A client should minimize data transfers by limiting the frequency of sync requests.

68
docs/rfcs/recurrence.md
View file

@ -4,8 +4,8 @@ title: "Taskwarrior - Recurrence"
# Draft
This is a draft design document. Your
[feedback](mailto:support@taskwarrior.org?Subject=Feedback) is welcomed.
This is a draft design document.
Your [feedback](mailto:support@taskwarrior.org?Subject=Feedback) is welcomed.
Recurrence
----------
@ -15,54 +15,51 @@ Recurrence needs an overhaul to improve weaknesses and add new features.
# Terminology
- The hidden 'parent' task is called the template.
- Synthesis is the name for the generation of new recurring task instances
when necessary.
- Synthesis is the name for the generation of new recurring task instances when necessary.
- The synthesized tasks are called instances.
- The index is the zero-based monotonically increasing number of the instance.
- Drift is the accumulated errors in time that cause a due date to slowly
change for each recurring task.
- Drift is the accumulated errors in time that cause a due date to slowly change for each recurring task.
# Criticism of Current Implementation
- The `mask` attribute grows unbounded.
- Only strict recurrence cycles are supported. The example of mowing the lawn
is that you want to mow the lawn every seven days, but when you are four
days late mowing the lawn, the next mowing should be in seven days, not in
three.
- Intances generated on one machine and then synced, may collide with
equivalent unsynced instances tasks on another device, because the UUIDs are
different.
- You cannot `wait` a recurring task and have that wait period propagate to
all other child tasks.
- Only strict recurrence cycles are supported.
The example of mowing the lawn is that you want to mow the lawn every seven days, but when you are four days late mowing the lawn, the next mowing should be in seven days, not in three.
- Intances generated on one machine and then synced, may collide with equivalent unsynced instances tasks on another device, because the UUIDs are different.
- You cannot `wait` a recurring task and have that wait period propagate to all other child tasks.
- Task instances cannot individually expire.
# Proposals
## Proposal: Eliminate `mask`, `imaѕk` Attributes
The `mask` attribute in the template is replaced by `last`, which indicates the
most recent instance index synthesized. Because instances are never synthesized
out of order, we only need to store the most recent index. The `imask` attribute
in the instance is no longer needed.
The `mask` attribute in the template is replaced by `last`, which indicates the most recent instance index synthesized.
Because instances are never synthesized out of order, we only need to store the most recent index.
The `imask` attribute in the instance is no longer needed.
## Proposal: Rename `parent` to `template`
The name `parent` implies subtasks, and confuses those who inspect the
internals. The value remains the UUID of the template. This frees up the
namespace for future use with subtasks.
The name `parent` implies subtasks, and confuses those who inspect the internals.
The value remains the UUID of the template.
This frees up the namespace for future use with subtasks.
## Proposal: New 'rtype' attribute
To indicate the flavor of recurrence, support the following values:
* `periodic` - Instances are created on a regular schedule. Example: send birthday flowers. It must occur on a regular schedule, and doesn't matter if you were late last year. This is the default value.
* `chained` - Instances are created back to back, so when one instance ends, the next begins, with the same recurrence. Example: mow the lawn. If you mow two days late, the next instance is not two days early to compensate.
* `periodic` - Instances are created on a regular schedule.
Example: send birthday flowers.
It must occur on a regular schedule, and doesn't matter if you were late last year.
This is the default value.
* `chained` - Instances are created back to back, so when one instance ends, the next begins, with the same recurrence.
Example: mow the lawn.
If you mow two days late, the next instance is not two days early to compensate.
## Proposal: Use relative offsets
The delta between `wait` and `due` date in the template should be reflected in
the delta between `wait` and `due` date in the instance. Similarly,
'scheduled' must be handled the same way.
The delta between `wait` and `due` date in the template should be reflected in the delta between `wait` and `due` date in the instance.
Similarly, 'scheduled' must be handled the same way.
## Proposal: On load, auto-upgrade legacy tasks
@ -77,14 +74,12 @@ Upgrade instance:
- Rename `parent` to `template`
- Delete `imask`
- Update `wait` if not set to: `wait:due + (template.due - template.wait)`
- Update `scheduled` if not set to:
`scheduled:due + (template.due - template.scheduled)`
- Update `scheduled` if not set to: `scheduled:due + (template.due - template.scheduled)`
## Proposal: Deleting a chained instance
Deleting a `rtype:chained` instance causes the next chained instance to be
synthesized. This gives the illusion that the due date is simply pushed out to
`(now + template.recur)`.
Deleting a `rtype:chained` instance causes the next chained instance to be synthesized.
This gives the illusion that the due date is simply pushed out to `(now + template.recur)`.
## Proposal: Modification Propagation
@ -189,14 +184,11 @@ Certain recurrence periods are inexact:
- P1Y
- P1D
When the recurrence period is `P1M` the number of days in a month varies and
causes drift.
When the recurrence period is `P1M` the number of days in a month varies and causes drift.
When the recurrence period is `P1Y` the number of days in a year varies and
causes drift.
When the recurrence period is `P1Y` the number of days in a year varies and causes drift.
When the recurrence period is `P1D` the number of hours in a day varies due to
daylight savings, and causes drift.
When the recurrence period is `P1D` the number of hours in a day varies due to daylight savings, and causes drift.
Drift should be avoided by carefully implementing:

103
docs/rfcs/request.md
View file

@ -2,41 +2,29 @@
title: "Taskwarrior - Request"
---
# Taskserver Message Format
The Taskserver accepts and emits only messages. These messages look somewhat
like email, as defined in [RFC821](https://tools.ietf.org/html/rfc821),
[RFC2822](https://tools.ietf.org/html/rfc2822).
The message format allows for data, metadata, and extensibility. This
combination allows the Taskserver to accommodate current and future needs. This
document describes the message format, and the supported message types.
The Taskserver accepts and emits only messages.
These messages look somewhat like email, as defined in [RFC821](https://tools.ietf.org/html/rfc821), [RFC2822](https://tools.ietf.org/html/rfc2822).
The message format allows for data, metadata, and extensibility.
This combination allows the Taskserver to accommodate current and future needs.
This document describes the message format, and the supported message types.
## Requirements
In this document, we adopt the convention discussed in Section 1.3.2 of
[RFC1122](https://tools.ietf.org/html/rfc1122#page-16) of using the capitalized
words MUST, REQUIRED, SHOULD, RECOMMENDED, MAY, and OPTIONAL to define the
significance of each particular requirement specified in this document.
In brief: \"MUST\" (or \"REQUIRED\") means that the item is an absolute
requirement of the specification; \"SHOULD\" (or \"RECOMMENDED\") means there
may exist valid reasons for ignoring this item, but the full implications should
be understood before doing so; and \"MAY\" (or \"OPTIONAL\") means that this
item is optional, and may be omitted without careful consideration.
In this document, we adopt the convention discussed in Section 1.3.2 of [RFC1122](https://tools.ietf.org/html/rfc1122#page-16) of using the capitalized words MUST, REQUIRED, SHOULD, RECOMMENDED, MAY, and OPTIONAL to define the significance of each particular requirement specified in this document.
In brief: \"MUST\" (or \"REQUIRED\") means that the item is an absolute requirement of the specification; \"SHOULD\" (or \"RECOMMENDED\") means there may exist valid reasons for ignoring this item, but the full implications should be understood before doing so; and \"MAY\" (or \"OPTIONAL\") means that this item is optional, and may be omitted without careful consideration.
## Encoding
All messages are UTF8-encoded text.
## Message Format
This format is based on [RFC2822](https://tools.ietf.org/html/rfc2822),
\'Internet Message Format\'. Here is an example of the format:
This format is based on [RFC2822](https://tools.ietf.org/html/rfc2822), \'Internet Message Format\'.
Here is an example of the format:
<SIZE>
name: value
@ -44,22 +32,21 @@ This format is based on [RFC2822](https://tools.ietf.org/html/rfc2822),
payload
There are three sections. The first is the size, which is a 4-byte, big- Endian,
binary byte count of the length of the message, including the 4 bytes for the
size.
There are three sections.
The first is the size, which is a 4-byte, big- Endian, binary byte count of the length of the message, including the 4 bytes for the size.
The header section is a set of name/value pairs separated by newline characters
(U+000D). The name is separated from the value by \': \' (colon U+003A, space
U+0020) The header section is terminated by two consecutive newline (U+000D)
characters. All text is UTF8-encoded.
The header section is a set of name/value pairs separated by newline characters (U+000D).
The name is separated from the value by \': \' (colon U+003A, space U+0020) The header section is terminated by two consecutive newline (U+000D) characters.
All text is UTF8-encoded.
The payload section is arbitrary, and message type-specific. However, it is
still UTF8-encoded text.
The payload section is arbitrary, and message type-specific.
However, it is still UTF8-encoded text.
## Message Requirements
Messages SHALL contain particular headers. Those are:
Messages SHALL contain particular headers.
Those are:
- type
- protocol
@ -67,13 +54,11 @@ Messages SHALL contain particular headers. Those are:
The \'type\' value is what determines the interpretation of the payload.
The \'protocol\' value should be \'v1\', or any subsequently published protocol
version.
The \'protocol\' value should be \'v1\', or any subsequently published protocol version.
The \'client\' represent the client identifier, so that any special cases can be
handled. For example, an emergency fix that is client version-specific could be
released, to support users that have not updated their client, or perhaps the
client has not released a fix. The form of the \'version\' value is:
The \'client\' represent the client identifier, so that any special cases can be handled.
For example, an emergency fix that is client version-specific could be released, to support users that have not updated their client, or perhaps the client has not released a fix.
The form of the \'version\' value is:
<product identifier> <version number>
@ -81,14 +66,13 @@ As an example:
taskwarrior 2.3.0
DO NOT spoof any other software using this client value. If another client is
spoofed, then patches addressing protocol errors may break working software.
DO NOT spoof any other software using this client value.
If another client is spoofed, then patches addressing protocol errors may break working software.
## Auth Data
Every request from the client SHALL contain \"auth\" information, which involves
these header entries:
Every request from the client SHALL contain \"auth\" information, which involves these header entries:
org: <organization>
user: <user>
@ -96,8 +80,8 @@ these header entries:
The user and org fields uniquely identify a user.
The key field is generated when a new server account is set up. It is a shared
secret, equivalent to a password, and should be protected.
The key field is generated when a new server account is set up.
It is a shared secret, equivalent to a password, and should be protected.
Authentication failure can result in these errors:
@ -112,30 +96,26 @@ Every response from the Taskserver SHALL contain status data:
code: <code>
status: <status text>
The code is a numeric status indicator defined in the [Sync
Protocol](/docs/design/protocol).
The code is a numeric status indicator defined in the [Sync Protocol](/docs/design/protocol).
## Payload Data
Payload data is optional, arbitrary and message type dependent. It is always
UTF8-encoded text.
Payload data is optional, arbitrary and message type dependent.
It is always UTF8-encoded text.
## Message Types
The Taskserver supports several message types, thus providing a set of
primitives for use by clients.
The Taskserver supports several message types, thus providing a set of primitives for use by clients.
It is expected that the number of supported ticket types will increase over
time.
It is expected that the number of supported ticket types will increase over time.
## Sync Message
The \"sync\" message always originates from the client, but the response will
contain data from the server. A sync is therefore a single request with a single
response.
The \"sync\" message always originates from the client, but the response will contain data from the server.
A sync is therefore a single request with a single response.
The \"sync\" message type MUST contain the following headers:
@ -166,9 +146,7 @@ Here is an example of a sync message:
2e4685f8-34bc-4f9b-b7ed-399388e182e1
{"description":"Test data","entry":"20130602T002341Z","status":"pending"}
The request contains the proper auth section, and the body contains the current
sync key followed by a newline characters (U+000D), then a list of
JSON-formatted tasks \[2\] each separated by a newline character (U+000D).
The request contains the proper auth section, and the body contains the current sync key followed by a newline characters (U+000D), then a list of JSON-formatted tasks \[2\] each separated by a newline character (U+000D).
An example response message might be:
@ -180,8 +158,7 @@ An example response message might be:
45da7110-1bcc-4318-d33e-12267a774e0f
The status indicates success, and the payload contains zero remote task
modifications, followed by a sync key.
The status indicates success, and the payload contains zero remote task modifications, followed by a sync key.
## Statistics Message
@ -195,7 +172,8 @@ The message format іs simply:
client: taskd 1.0.0
protocol: v1
There is no payload. An example response message might be:
There is no payload.
An example response message might be:
<size>type: response
client: taskd 1.0.0
@ -216,6 +194,5 @@ There is no payload. An example response message might be:
There is no payload, and the results are in the header variables.
Note that the statistics gathered by the server are growing, which means new
values are occasionally added to the response message. Existing values will not
be removed.
Note that the statistics gathered by the server are growing, which means new values are occasionally added to the response message.
Existing values will not be removed.

99
docs/rfcs/rules.md
View file

@ -4,16 +4,14 @@ title: "Taskwarrior - Rule System"
## Work in Progress
This design document is a work in progress, and subject to change. Once
finalized, the feature will be scheduled for an upcoming release.
This design document is a work in progress, and subject to change.
Once finalized, the feature will be scheduled for an upcoming release.
# Rule System
The rule system is a framework that supports highly configurable features, with
runtime evaluation, DOM access and an internal API. Implementing a rule system
meets the goal of shrinking and stabilizing the product core, while adding new
features, and enabling many more.
The rule system is a framework that supports highly configurable features, with runtime evaluation, DOM access and an internal API.
Implementing a rule system meets the goal of shrinking and stabilizing the product core, while adding new features, and enabling many more.
## Required Enhancements
@ -60,16 +58,14 @@ To prepare for a Rules System, various subsystems must first be enhanced:
- The RC file will support environment variable expansion, where `${NAME}`
will be replaced by its corresponding value at launch time
At that point, the rules system can be implemented in `libshared`, and will use
a pluggable architecture to allow its integration into several projects.
At that point, the rules system can be implemented in `libshared`, and will use a pluggable architecture to allow its integration into several projects.
## DOM Enhancements
DOM references will be enhanced, with many more references supported. All DOM
references will begin with `dom.`, yielding unambiguous references. References
will have a type. Types will support sub-references (`<date>.<month>`,
`<tags>.<N>`, `<annotation>.<description>`), and display formats included.
DOM references will be enhanced, with many more references supported.
All DOM references will begin with `dom.`, yielding unambiguous references.
References will have a type.
Types will support sub-references (`<date>.<month>`, `<tags>.<N>`, `<annotation>.<description>`), and display formats included.
dom . [<id> .] <attribute> [. <sub-reference>] . <format>
@ -79,18 +75,15 @@ will have a type. Types will support sub-references (`<date>.<month>`,
dom . 123 . tags . count
dom . 123 . tags . 1
In addition to direct attribute access, DOM references will also support tw
references beyond the current set:
In addition to direct attribute access, DOM references will also support tw references beyond the current set: dom.rc.<name>
dom.rc.<name>
dom.cli.args
dom.terminal.width
dom.terminal.height
dom.system.version
dom.system.oѕ
And will also support higher-level constructs that do not directly correlate to
attributes, for example:
And will also support higher-level constructs that do not directly correlate to attributes, for example:
dom.active Boolean indicator of any active tasks
dom.synced Boolean indicator of the need to sync
@ -115,34 +108,26 @@ The current configuration system supports only two different forms of syntax:
include <file>
A rule is a new form of syntax that consists of the rule keyword, a name,
optional trigger, followed by indented actions in the form of API calls and flow
control. For example:
A rule is a new form of syntax that consists of the rule keyword, a name, optional trigger, followed by indented actions in the form of API calls and flow control.
For example:
rule myRule() on_launch:
# Some code here
A rule definition will appear in the RC file, alongside all the existing
settings. The rule syntax will require a blank line to terminate the rule
definition, the result being that the RC file should be quite readable, although
it will look like Python.
A rule definition will appear in the RC file, alongside all the existing settings.
The rule syntax will require a blank line to terminate the rule definition, the result being that the RC file should be quite readable, although it will look like Python.
## Hook Scripts
While this functionality can also be implemented using hook scripts, rules will
run in-process, and therefore do not require external interpreters to be
launched every time. This creates the potential to run faster than a hook
script.
While this functionality can also be implemented using hook scripts, rules will run in-process, and therefore do not require external interpreters to be launched every time.
This creates the potential to run faster than a hook script.
For complex processing, hook scripts will be the preferred mechanism, but as the
rules system matures, rules will be made to run more quickly. With adequate
performance, a rule will be the preferred implementation over a hook script.
For complex processing, hook scripts will be the preferred mechanism, but as the rules system matures, rules will be made to run more quickly.
With adequate performance, a rule will be the preferred implementation over a hook script.
This is not expected to be the case at first.
Hook scripts are not likely to be extended beyond their current form, and with
greater DOM access and a growing API, rules should be able to supplant most hook
script use cases.
Hook scripts are not likely to be extended beyond their current form, and with greater DOM access and a growing API, rules should be able to supplant most hook script use cases.
## Rule Triggers
@ -150,11 +135,21 @@ script use cases.
The set of supported rule types will include:
* `on_launch` - Triggered on program launch.
* `on_add` - Triggered when a task is added. A context task will be provided. The rule can modify the task, and approve or reject it.
* `on_modify` - Triggered when a task is modified. A before and after context task will be provided. The rule can modify the task, and approve or reject it.
* `on_add` - Triggered when a task is added.
A context task will be provided.
The rule can modify the task, and approve or reject it.
* `on_modify` - Triggered when a task is modified.
A before and after context task will be provided.
The rule can modify the task, and approve or reject it.
* `on_exit` - Triggered on program exit.
* `color` - Triggered when colors are being determined.
* `virtual tag` - Defines a new virtual tag.
* `format` - Triggered when an attribute needs formatting, defines are new format.
More rules types will be added for more capabilities in future releases.
@ -165,23 +160,37 @@ More rules types will be added for more capabilities in future releases.
The API is a simple set of actions that may be taken by a rule.
* `debug(<string>)` - Displays the string in debug mode only and continues processing.
* `warn(<string>)` - Displays the string as a warning continues processing.
* `error(<string>)` - Displays the string as an error and terminates processing.
* `exec(<binary> [ <args> ... ])` - Executes the external program and passes arguments to it. If the program exits with non-zero status, it is treated as an error.
* `exec(<binary> [ <args> ... ])` - Executes the external program and passes arguments to it.
If the program exits with non-zero status, it is treated as an error.
* `return <value>` - Provides a result value for the rule, when necessary.
This is a very limited set at first, and more API calls will be added to support
capabilities in future releases.
This is a very limited set at first, and more API calls will be added to support capabilities in future releases.
## Grammar
The grammar closely tracks that of Python. Blocks are indented consistently.
The grammar closely tracks that of Python.
Blocks are indented consistently.
* `if <condition>: ... else: ... ` - The condition is a full Algebraic expression, and supports none of the command line conveniences. Terms must be combined with logical operators. The condition is an expression that is evaluated and converted to a Boolean value.
* `for <name> in <collection>: ` - There is no native type for a collection, but there are DOM references (`tags` \...) that reference collections. This provides a way to iterate.
* `set <name> = <expression> ` - Writes to a named type. The name may be a writable DOM object (`dom...`) or temporary variable storage (`tmp...`). Writing to a read-only DOM reference is an error.
* `<function>([<args>]) ` - A function is either a rule or an API call. Calling an undefined function is an error.
* `if <condition>: ... else: ...` - The condition is a full Algebraic expression, and supports none of the command line conveniences.
Terms must be combined with logical operators.
The condition is an expression that is evaluated and converted to a Boolean value.
* `for <name> in <collection>:` - There is no native type for a collection, but there are DOM references (`tags` \...) that reference collections.
This provides a way to iterate.
* `set <name> = <expression>` - Writes to a named type.
The name may be a writable DOM object (`dom...`) or temporary variable storage (`tmp...`).
Writing to a read-only DOM reference is an error.
* `<function>([<args>])` - A function is either a rule or an API call.
Calling an undefined function is an error.
## Examples

87
docs/rfcs/sync.md
View file

@ -5,36 +5,28 @@ title: "Taskwarrior - Taskserver Sync Algorithm"
# Taskserver Sync Algorithm
This document describes how task changes are merged by the Taskserver. It does
not describe [the protocol](/docs/design/protocol) used by the Taskserver.
This document describes how task changes are merged by the Taskserver.
It does not describe [the protocol](/docs/design/protocol) used by the Taskserver.
The Taskserver merges tasks from multiple sources, resulting in conflict- free
syncing of data. The algorithm used to achieve this is simple and effective,
paralleling what SCM systems do to perform a rebase.
The Taskserver merges tasks from multiple sources, resulting in conflict- free syncing of data.
The algorithm used to achieve this is simple and effective, paralleling what SCM systems do to perform a rebase.
## Requirements
In this document, we adopt the convention discussed in Section 1.3.2 of
[RFC1122](https://tools.ietf.org/html/rfc1122#page-16) of using the capitalized
words MUST, REQUIRED, SHOULD, RECOMMENDED, MAY, and OPTIONAL to define the
significance of each particular requirement specified in this document.
[RFC1122](https://tools.ietf.org/html/rfc1122#page-16) of using the capitalized words MUST, REQUIRED, SHOULD, RECOMMENDED, MAY, and OPTIONAL to define the significance of each particular requirement specified in this document.
In brief: \"MUST\" (or \"REQUIRED\") means that the item is an absolute
requirement of the specification; \"SHOULD\" (or \"RECOMMENDED\") means there
may exist valid reasons for ignoring this item, but the full implications should
be understood before doing so; and \"MAY\" (or \"OPTIONAL\") means that this
item is optional, and may be omitted without careful consideration.
In brief: \"MUST\" (or \"REQUIRED\") means that the item is an absolute requirement of the specification; \"SHOULD\" (or \"RECOMMENDED\") means there may exist valid reasons for ignoring this item, but the full implications should be understood before doing so; and \"MAY\" (or \"OPTIONAL\") means that this item is optional, and may be omitted without careful consideration.
## Problem Definition
The sync algorithm considers a single task, with multiple changes occurring in
two separate locations that must be resolved. The two locations are the local
machine and the server. This results in two parallel change sequences.
The sync algorithm considers a single task, with multiple changes occurring in two separate locations that must be resolved.
The two locations are the local machine and the server.
This results in two parallel change sequences.
Examples using multiple clients collapse down to the simple two-branch case
because the clients are merged serially.
Examples using multiple clients collapse down to the simple two-branch case because the clients are merged serially.
## Change Sequence
@ -43,9 +35,9 @@ A sequence of changes to the same task is represented as:
T0 --> T1 --> T2
Although all examples are of the two-branch variety, some involve trivial
branches. Going through these examples will illustrate the algorithm. First the
legend:
Although all examples are of the two-branch variety, some involve trivial branches.
Going through these examples will illustrate the algorithm.
First the legend:
T0 Represents the original task, the base.
T1 Represents the task with a non-trivial set of changes.
@ -54,9 +46,8 @@ legend:
## Deltas
The transition from T0 \--\> T1 can be seen as a transform applied to T0,
resulting in T1. That transform is the delta (d1) between T0 and T1, which is a
subtractive term:
The transition from T0 \--\> T1 can be seen as a transform applied to T0, resulting in T1.
That transform is the delta (d1) between T0 and T1, which is a subtractive term:
d1 = (T1 - T0)
@ -65,9 +56,8 @@ Therefore:
T0 --> T1 = T0 + d1
= T0 + (T1 - T0)
This states that the transition from T0 to T1 is the application of a delta to
the original, T0, which results in T1. Applying this to the whole change
sequence yields:
This states that the transition from T0 to T1 is the application of a delta to the original, T0, which results in T1.
Applying this to the whole change sequence yields:
T0 --> T1 --> T2 = T0 + d1 + d2
= T0 + (T1 - T0) + (T2 - T1)
@ -75,34 +65,30 @@ sequence yields:
## Use Case Classification
Because clients sync requests are processed serially, there is no need to
consider the multiple client cases. This means there is only ever the case with
two parallel change sequences = the two branch case.
Because clients sync requests are processed serially, there is no need to consider the multiple client cases.
This means there is only ever the case with two parallel change sequences = the two branch case.
## Two Branch Case
The two branch case represents changes made to the same task in two locations,
resulting in two deltas that must be applied to the same base.
The two branch case represents changes made to the same task in two locations, resulting in two deltas that must be applied to the same base.
T0 --> T1
T0 --> T2
This reduces to a base with two deltas, but the order in which the deltas are
applied is important. For example:
This reduces to a base with two deltas, but the order in which the deltas are applied is important.
For example:
T0 + d1 + d2 =/= T0 + d2 + d1
The application of deltas is not commutative, except in the trivial case where
the two deltas are identical, or the deltas do not overlap. The deltas therefore
need to be applied in the correct sequence. Tasks have metadata that indicates
the last modified time, which dictates the sequence. Assuming d1 occurred before
d2, this neatly collapses down to a single branch sequence:
The application of deltas is not commutative, except in the trivial case where the two deltas are identical, or the deltas do not overlap.
The deltas therefore need to be applied in the correct sequence.
Tasks have metadata that indicates the last modified time, which dictates the sequence.
Assuming d1 occurred before d2, this neatly collapses down to a single branch sequence:
T0 + d1 + d2 = T3
Note that the result in this case is T3, because it will be neither T1 nor T2,
unless the deltas are identical.
Note that the result in this case is T3, because it will be neither T1 nor T2, unless the deltas are identical.
## Two Branch, Multiple Changes Case
@ -112,8 +98,8 @@ The two branch case can be complicated by multiple changes per branch:
T0 --> T1 --> T3 --> T5
T0 --> T2 --> T4
Note that the numbers were chosen to represent the order in which the changes
were made. First a list of deltas is generated:
Note that the numbers were chosen to represent the order in which the changes were made.
First a list of deltas is generated:
T0 --> T1 = d1
T1 --> T3 = d3
@ -170,8 +156,7 @@ If d1 occurred before d2, the result is:
## Use Cases
A range of illustrated use cases, from the trivial to the complex will show the
algorithm in use.
A range of illustrated use cases, from the trivial to the complex will show the algorithm in use.
## Use Case 1: New Local Task
@ -181,7 +166,8 @@ Initial state:
Server: -
Client: T0
The server has no data, and so T0 is stored. The result is now:
The server has no data, and so T0 is stored.
The result is now:
Server: T0
Client: T0
@ -199,7 +185,8 @@ The server resolves the change:
T0 --> T1 = T0 + d1
= T1
T1 is stored. The result is now:
T1 is stored.
The result is now:
Server: T0 --> T1
Client: T1
@ -221,7 +208,8 @@ The order of change is determine to be d1, d2, yielding T3:
T3 = T0 + d1 + d2
T3 is stored on the server, and returned to the client. The result is now:
T3 is stored on the server, and returned to the client.
The result is now:
Server: T0 --> T1 --> T2 --> T3
Client: T3
@ -247,7 +235,8 @@ The order of change is determine to be d1, d2, d3, d4, yielding T5:
T5 = T0 + d1 + d2 + d3 + d4
T5 is stored on the server, and returned to the client. The result is now:
T5 is stored on the server, and returned to the client.
The result is now:
Server: T0 --> T1 --> T2 --> T3 --> T4 --> T5
Client: T5

256
docs/rfcs/task.md
View file

@ -5,48 +5,37 @@ title: "Taskwarrior - Taskwarrior JSON Format"
# Taskwarrior JSON Format
When Taskwarrior exchanges data, it uses [JSON](https://www.json.org/). This
document describes the structure and semantics for tasks exported from
Taskwarrior, imported to Taskwarrior, or synced with the Taskserver.
When Taskwarrior exchanges data, it uses [JSON](https://www.json.org/).
This document describes the structure and semantics for tasks exported from Taskwarrior, imported to Taskwarrior, or synced with the Taskserver.
Any client of the Taskserver will need to communicate task information. This
document describes the format of a single task. It does not describe the
communication and sync protocol between client and server.
Any client of the Taskserver will need to communicate task information.
This document describes the format of a single task.
It does not describe the communication and sync protocol between client and server.
This document is subject to change. The data attributes are also subject to
change.
This document is subject to change.
The data attributes are also subject to change.
## Requirements
In this document, we adopt the convention discussed in Section 1.3.2 of
[RFC1122](https://tools.ietf.org/html/rfc1122#page-16) of using the capitalized
words MUST, REQUIRED, SHOULD, RECOMMENDED, MAY, and OPTIONAL to define the
significance of each particular requirement specified in this document.
In this document, we adopt the convention discussed in Section 1.3.2 of [RFC1122](https://tools.ietf.org/html/rfc1122#page-16) of using the capitalized words MUST, REQUIRED, SHOULD, RECOMMENDED, MAY, and OPTIONAL to define the significance of each particular requirement specified in this document.
In brief: \"MUST\" (or \"REQUIRED\") means that the item is an absolute
requirement of the specification; \"SHOULD\" (or \"RECOMMENDED\") means there
may exist valid reasons for ignoring this item, but the full implications should
be understood before doing so; and \"MAY\" (or \"OPTIONAL\") means that this
item is optional, and may be omitted without careful consideration.
In brief: \"MUST\" (or \"REQUIRED\") means that the item is an absolute requirement of the specification; \"SHOULD\" (or \"RECOMMENDED\") means there may exist valid reasons for ignoring this item, but the full implications should be understood before doing so; and \"MAY\" (or \"OPTIONAL\") means that this item is optional, and may be omitted without careful consideration.
## General Format
The format is JSON, specifically a JSON object as a single line of text,
terminated by a newline (U+000D).
The format is JSON, specifically a JSON object as a single line of text, terminated by a newline (U+000D).
The JSON looks like this:
{"description":"One two three","status":"pending", ... }
While this is not a valid task (there are missing fields), the format is
illustrated.
While this is not a valid task (there are missing fields), the format is illustrated.
All attribute names are quoted with \" (U+0022). A name will always have a
corresponding value, and if a value is blank, then the name/value pair is
omitted from the line. Newline characters are not permitted within the value,
meaning that a task consists of a single line of text.
All attribute names are quoted with \" (U+0022).
A name will always have a corresponding value, and if a value is blank, then the name/value pair is omitted from the line.
Newline characters are not permitted within the value, meaning that a task consists of a single line of text.
All data is UTF8.
@ -63,8 +52,7 @@ Strings may consist of any UTF8 encoded characters.
## Data Type: Fixed String
A fixed string is one value from a set of acceptable values, such as a priority
level, where the values may only be \"\", \"L\", \"M\" or \"H\".
A fixed string is one value from a set of acceptable values, such as a priority level, where the values may only be \"\", \"L\", \"M\" or \"H\".
## Data Type: UUID
@ -87,8 +75,7 @@ Integers are rendered in a simple fashion:
## Data Type: Date
Dates are rendered in ISO 8601 combined date and time in UTC format using the
template:
Dates are rendered in ISO 8601 combined date and time in UTC format using the template:
YYYYMMDDTHHMMSSZ
@ -101,7 +88,8 @@ No other formats are supported.
## Data Type: Duration
Duration values represent a time period. They take the form:
Duration values represent a time period.
They take the form:
[[<sign>] <number>] <unit>
@ -165,11 +153,9 @@ The supported units are:
- yr
- y
Note that some values lack precision, for example \"2q\" means two quarters, or
half a year.
Note that some values lack precision, for example \"2q\" means two quarters, or half a year.
Note that not all combinations of and make sense, for example \"3annual\" makes
no sense, but evaluates to \"3years\".
Note that not all combinations of and make sense, for example \"3annual\" makes no sense, but evaluates to \"3years\".
## The Attributes
@ -232,59 +218,49 @@ There are other forms, which are conditional upon the state of a task:
(Legend: Reqd = required, Opt = optional, Intrn = Internally generated)
All tasks have four required fields. There are other states in which a task may
exist, and the requirements change. At a minimum, a valid task contains:
All tasks have four required fields.
There are other states in which a task may exist, and the requirements change.
At a minimum, a valid task contains:
- uuid
- status
- entry
- description
*Deleted*\
A deleted task MUST also have \"status\":\"deleted\", an \"end\" date and a
\"modified\" date.
*Deleted* - A deleted task MUST also have \"status\":\"deleted\", an \"end\" date and a \"modified\" date.
*Completed*\
A completed task MUST also have \"status\":\"completed\", an \"end\" date and a
\"modified\" date.
*Completed* - A completed task MUST also have \"status\":\"completed\", an \"end\" date and a \"modified\" date.
*Waiting*\
A waiting task MUST also have \"status\":\"waiting\" and a \"wait\" date. The
task is hidden from the user, until that \"wait\" date has passed, whereupon the
status reverts to \"pending\", and the \"wait\" date is removed.
*Waiting* - A waiting task MUST also have \"status\":\"waiting\" and a \"wait\" date.
The task is hidden from the user, until that \"wait\" date has passed, whereupon the status reverts to \"pending\", and the \"wait\" date is removed.
*Recurring Parent*\
When a recurring task is entered, it MUST have \"status\":\"recurring\", a
\"recur\" period and a \"due\" date. It MAY also have an \"until\" date.
*Recurring Parent* - When a recurring task is entered, it MUST have \"status\":\"recurring\", a \"recur\" period and a \"due\" date.
It MAY also have an \"until\" date.
Recurring parent tasks are hidden from the user.
*Recurring Child*\
A recurring child task is not created by the user, but is cloned from the
recurring parent task by the Taskserver. It may be modified by the user. On
completion, there is special handling to be done. See section 3.11.
*Recurring Child* - A recurring child task is not created by the user, but is cloned from the recurring parent task by the Taskserver.
It may be modified by the user.
On completion, there is special handling to be done.
See section 3.11.
## Additional Attributes
There MAY be other fields than those listed above in a task definition. Such
fields MUST be preserved intact by any client, which means that if a task is
downloaded that contains an unrecognized field, that field MUST not be modified,
and MUST continue to exist in the task..
There MAY be other fields than those listed above in a task definition.
Such fields MUST be preserved intact by any client, which means that if a task is downloaded that contains an unrecognized field, that field MUST not be modified, and MUST continue to exist in the task..
User Defined Attributes (UDAs) are additional fields.
## Attribute Details
The individual fields convey important information about a task, and in some
cases work only in collusion with other fields. All such details are listed
here.
The individual fields convey important information about a task, and in some cases work only in collusion with other fields.
All such details are listed here.
## Attribute: status
The status field describes the state of the task, which may ONLY be one of these
literal strings:
The status field describes the state of the task, which may ONLY be one of these literal strings:
"status":"pending"
"status":"deleted"
@ -292,35 +268,28 @@ literal strings:
"status":"waiting"
"status":"recurring"
A pending task is a task that has not yet been completed or deleted. This is the
typical state for a task.
A pending task is a task that has not yet been completed or deleted.
This is the typical state for a task.
A deleted task is one that has been removed from the pending state, and MUST
have an \"end\" field specified. Given the required \"entry\" and \"end\" field,
it can be determined how long the task was pending.
A deleted task is one that has been removed from the pending state, and MUST have an \"end\" field specified.
Given the required \"entry\" and \"end\" field, it can be determined how long the task was pending.
A completed task is one that has been removed from the pending state by
completion, and MUST have an \"end\" field specified. Given the required
\"entry\" and \"end\" fields, it can be determine how long the task was pending.
A completed task is one that has been removed from the pending state by completion, and MUST have an \"end\" field specified.
Given the required \"entry\" and \"end\" fields, it can be determine how long the task was pending.
A waiting task is ostensibly a pending task that has been hidden from typical
view, and MUST have a \"wait\" field containing the date when the task is
automatically returned to the pending state. If a client sees a task that is in
the waiting state, and the \"wait\" field is earlier than the current date and
time, the client MUST remove the \"wait\" field and set the \"status\" field to
\"pending\".
A waiting task is ostensibly a pending task that has been hidden from typical view, and MUST have a \"wait\" field containing the date when the task is automatically returned to the pending state.
If a client sees a task that is in the waiting state, and the \"wait\" field is earlier than the current date and time, the client MUST remove the \"wait\" field and set the \"status\" field to \"pending\".
A recurring task is essentially a parent template task from which child tasks
are cloned. The parent remains hidden from view, and contains a \"mask\" field
that represents the recurrences. Each cloned child task has an \"imask\" field
that indexes into the parent \"mask\" field, as well as a \"parent\" field that
lists the UUID of the parent.
A recurring task is essentially a parent template task from which child tasks are cloned.
The parent remains hidden from view, and contains a \"mask\" field that represents the recurrences.
Each cloned child task has an \"imask\" field that indexes into the parent \"mask\" field, as well as a \"parent\" field that lists the UUID of the parent.
## Attribute: uuid
When a task is created, it MUST be assigned a new UUID by the client. Once
assigned, a UUID field MUST NOT be modified. UUID fields are permanent.
When a task is created, it MUST be assigned a new UUID by the client.
Once assigned, a UUID field MUST NOT be modified.
UUID fields are permanent.
## Attribute: entry
@ -331,70 +300,61 @@ This is the creation date of the task.
## Attribute: description
When a task is created, it MUST have a \"description\" field value, which
contains UTF8 characters. A \"description\" field may not contain newline
characters, but may contain other characters, properly escaped. See
<https://json.org> for details.
When a task is created, it MUST have a \"description\" field value, which contains UTF8 characters.
A \"description\" field may not contain newline characters, but may contain other characters, properly escaped.
See <https://json.org> for details.
## Attribute: start
To indicate that a task is being worked on, it MAY be assigned a \"start\"
field. Such a task is then considered Active.
To indicate that a task is being worked on, it MAY be assigned a \"start\" field.
Such a task is then considered Active.
## Attribute: end
When a task is deleted or completed, is MUST be assigned an \"end\" field. It is
not valid for a task to have an \"end\" field unless the status is also
\"completed\" or \"deleted\". If a completed task is restored to the \"pending\"
state, the \"end\" field is removed.
When a task is deleted or completed, is MUST be assigned an \"end\" field.
It is not valid for a task to have an \"end\" field unless the status is also \"completed\" or \"deleted\".
If a completed task is restored to the \"pending\" state, the \"end\" field is removed.
## Attribute: due
A task MAY have a \"due\" field, which indicates when the task should be
completed.
A task MAY have a \"due\" field, which indicates when the task should be completed.
## Attribute: until
A recurring task MAY have an \"until\" field, which is the date after which no
more recurring tasks should be generated. At that time, the parent recurring
task is set to \"completed\".
A recurring task MAY have an \"until\" field, which is the date after which no more recurring tasks should be generated.
At that time, the parent recurring task is set to \"completed\".
## Attribute: wait
A task MAY have a \"wait\" field date, in conjunction with a \"status\" of
\"waiting\". A waiting task is one that is not typically shown on reports until
it is past the wait date.
A task MAY have a \"wait\" field date, in conjunction with a \"status\" of \"waiting\".
A waiting task is one that is not typically shown on reports until it is past the wait date.
An example of this is a birthday reminder. A task may be entered for a birthday
reminder in 10 months time, but can have a \"wait\" date 9 months from now,
which means the task remains hidden until 1 month before the due date. This
prevents long-term tasks from cluttering reports until they become relevant.
An example of this is a birthday reminder.
A task may be entered for a birthday reminder in 10 months time, but can have a \"wait\" date 9 months from now, which means the task remains hidden until 1 month before the due date.
This prevents long-term tasks from cluttering reports until they become relevant.
## Attribute: recur
The \"recur\" field is for recurring tasks, and specifies the period between
child tasks, in the form of a duration value. The value is kept in the raw state
(such as \"3wks\") as a string, so that it may be evaluated each time it is
needed.
The \"recur\" field is for recurring tasks, and specifies the period between child tasks, in the form of a duration value.
The value is kept in the raw state (such as \"3wks\") as a string, so that it may be evaluated each time it is needed.
## Attribute: mask
A parent recurring task has a \"mask\" field that is an array of child status
indicators. Suppose a task is created that is due every week for a month. The
\"mask\" field will look like:
A parent recurring task has a \"mask\" field that is an array of child status indicators.
Suppose a task is created that is due every week for a month.
The \"mask\" field will look like:
"----"
This mask has four slots, indicating that there are four child tasks, and each
slot indicates, in this case, that the child tasks are pending (\"-\"). The
possible slot indicators are:
This mask has four slots, indicating that there are four child tasks, and each slot indicates, in this case, that the child tasks are pending (\"-\").
The possible slot indicators are:
* `-` - Pending
* `+` - Completed
@ -409,34 +369,30 @@ If there were only three indicators in the mask:
"+-+"
This would indicate that the second task is pending, the first and third are
complete, and the fourth has not yet been generated.
This would indicate that the second task is pending, the first and third are complete, and the fourth has not yet been generated.
## Attribute: imask
Child recurring tasks have an \"imask\" field instead of a \"mask\" field like
their parent. The \"imask\" field is a zero-based integer offset into the
\"mask\" field of the parent.
Child recurring tasks have an \"imask\" field instead of a \"mask\" field like their parent.
The \"imask\" field is a zero-based integer offset into the \"mask\" field of the parent.
If a child task is completed, one of the changes that MUST occur is to look up
the parent task, and using \"imask\" set the \"mask\" of the parent to the
correct indicator. This prevents recurring tasks from being generated twice.
If a child task is completed, one of the changes that MUST occur is to look up the parent task, and using \"imask\" set the \"mask\" of the parent to the correct indicator.
This prevents recurring tasks from being generated twice.
## Attribute: parent
A recurring task instance MUST have a \"parent\" field, which is the UUID of the
task that has \"status\" of \"recurring\". This linkage between tasks,
established using \"parent\", \"mask\" and \"imask\" is used to track the need
to generate more recurring tasks.
A recurring task instance MUST have a \"parent\" field, which is the UUID of the task that has \"status\" of \"recurring\".
This linkage between tasks, established using \"parent\", \"mask\" and \"imask\" is used to track the need to generate more recurring tasks.
## Attribute: annotation\_\...
Annotations are strings with timestamps. Each annotation itself has an \"entry\"
field and a \"description\" field, similar to the task itself. Annotations form
an array named \"annotations\". For example (lines broken for clarity):
Annotations are strings with timestamps.
Each annotation itself has an \"entry\" field and a \"description\" field, similar to the task itself.
Annotations form an array named \"annotations\".
For example (lines broken for clarity):
"annotations":[
{"entry":"20120110T234212Z","description":"Remember to get the mail"},
@ -446,12 +402,12 @@ an array named \"annotations\". For example (lines broken for clarity):
## Attribute: project
A project is a single string. For example:
A project is a single string.
For example:
"project":"Personal Taxes"
Note that projects receive special handling, so that when a \".\" (U+002E) is
used, it implies a hierarchy, which means the following two projects:
Note that projects receive special handling, so that when a \".\" (U+002E) is used, it implies a hierarchy, which means the following two projects:
"Home.Kitchen"
"Home.Garden"
@ -461,8 +417,8 @@ are both considered part of the \"Home\" project.
## Attribute: tags
The \"tags\" field is an array of string, where each string is a single word
containing no spaces. For example:
The \"tags\" field is an array of string, where each string is a single word containing no spaces.
For example:
"tags":["home","garden"]
@ -475,43 +431,39 @@ The \"priority\" field, if present, MAY contain one of the following strings:
"priority":"M"
"priority":"L"
These represent High, Medium and Low priorities. An absent priority field
indicates no priority.
These represent High, Medium and Low priorities.
An absent priority field indicates no priority.
## Attribute: depends
The \"depends\" field is a string containing a comma-separated unique set of
UUIDs. If task 2 depends on task 1, then it is task 1 that must be completed
first. Task 1 is considered a \"blocking\" tasks, and task 2 is considered a
\"blocked\" task. For example:
The \"depends\" field is a string containing a comma-separated unique set of UUIDs.
If task 2 depends on task 1, then it is task 1 that must be completed first.
Task 1 is considered a \"blocking\" tasks, and task 2 is considered a \"blocked\" task.
For example:
"depends":",, ..."
Note that in a future version of this specification, this will be changed to a
JSON array of strings, like the \"tags\" field.
Note that in a future version of this specification, this will be changed to a JSON array of strings, like the \"tags\" field.
## Attribute: modified
A task MUST have a \"modified\" field set if it is modified. This field is of
type \"date\", and is used as a reference when merging tasks.
A task MUST have a \"modified\" field set if it is modified.
This field is of type \"date\", and is used as a reference when merging tasks.
## Attribute: scheduled
A task MAY have a \"scheduled\" field, which indicates when the task should be
available to start. A task that has passed its \"scheduled\" data is said to be
\"ready\".
A task MAY have a \"scheduled\" field, which indicates when the task should be available to start.
A task that has passed its \"scheduled\" data is said to be \"ready\".
## User Defined Attributes
A User Defined Attribute (UDA) is a field that is defined via configuration.
Given that the configuration is not present in the JSON format of a task, any
fields that are not recognized are to be treated as UDAs. This means that if a
task contains a UDA, unless the meaning of it is understood, it MUST be
preserved.
Given that the configuration is not present in the JSON format of a task, any fields that are not recognized are to be treated as UDAs.
This means that if a task contains a UDA, unless the meaning of it is understood, it MUST be preserved.
UDAs may have one of four types: string, numeric, date and duration.

28
docs/rfcs/workweek.md
View file

@ -4,32 +4,26 @@ title: "Taskwarrior - Work Week Support"
## Work in Progress
This design document is a work in progress, and subject to change. Once
finalized, the feature will be scheduled for an upcoming release.
This design document is a work in progress, and subject to change.
Once finalized, the feature will be scheduled for an upcoming release.
# Work Week Support
Taskwarrior supports the idea that a week starts on either a Sunday or a Monday,
as determined by configuration. This was added eight years ago, simply for
display purposes in the `calendar` report. Since then its use has propagated and
it influences the `sow` date reference.0
Taskwarrior supports the idea that a week starts on either a Sunday or a Monday, as determined by configuration.
This was added eight years ago, simply for display purposes in the `calendar` report.
Since then its use has propagated and it influences the `sow` date reference.0
Further requests have been made to make this more flexible, so that the notion
of \'weekend\' can be defined. Furthermore, the idea that every week has a
weekend has also been questioned.
It has become clear that a `weekstart` setting, and the notion of a weekend are
no longer useful.
Further requests have been made to make this more flexible, so that the notion of \'weekend\' can be defined.
Furthermore, the idea that every week has a weekend has also been questioned.
It has become clear that a `weekstart` setting, and the notion of a weekend are no longer useful.
## Proposed Support
One option is to allow the user to completely define a work week in the
following way:
One option is to allow the user to completely define a work week in the following way:
workweek=1,2,3,4,5
With Sunday as day zero, this states that the work week is the typical Monday -
Friday. From this setting, the meaning of `soww` and `eoww` can be determined,
as well as `recur:weekday`.
With Sunday as day zero, this states that the work week is the typical Monday - Friday.
From this setting, the meaning of `soww` and `eoww` can be determined, as well as `recur:weekday`.