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
taskwarrior/doc
History
Dustin J. Mitchell 4ff63a7960
Use TaskChampion 0.7.0, now via cxx instead of hand-rolled FFI (#3588) 
TC 0.7.0 introduces a new `TaskData` type that maps to Taskwarrior's
`Task` type more cleanly. It also introduces the idea of gathering lists
of operations and "committing" them to a replica.

A consequence of this change is that TaskChampion no longer
automatically maintains dependency information, so Taskwarrior must do
so, with its `TDB2::dependency_sync` method. This method does a very
similar thing to what TaskChampion had been doing, so this is a shift of
responsibility but not a major performance difference.

Cxx is .. not great. It is missing a lot of useful things that make a
general-purpose bridge impractical:

 - no support for trait objects
 - no support for `Option<T>` (https://github.com/dtolnay/cxx/issues/87)
 - no support for `Vec<Box<..>>`

As a result, some creativity is required in writing the bridge, for
example returning a `Vec<OptionTaskData>` from `all_task_data` to allow
individual `TaskData` values to be "taken" from the vector.

That said, Cxx is the current state-of-the-art, and does a good job of
ensuring memory safety, at the cost of some slightly awkward APIs.

Subsequent work can remove the "TDB2" layer and allow commands and other
parts of Taskwarrior to interface directly with the `Replica`.
2024-08-11 02:06:00 +00:00
..
devel Use TaskChampion 0.7.0, now via cxx instead of hand-rolled FFI (#3588) 2024-08-11 02:06:00 +00:00
man add initial bulk run from pre-commit over all files 2024-07-29 22:34:51 +02:00
rc add initial bulk run from pre-commit over all files 2024-07-29 22:34:51 +02:00
ref Update copyright to 2020 2020-11-21 12:27:05 -05:00
CMakeLists.txt Use corrosion instead of CMakeRust (#3273) 2024-03-02 16:21:34 -05:00
README.md Better links from TW devel docs to TaskChampion (#3253) 2024-01-21 18:03:11 -05:00

README.md

Documentation

This directory contains Taskwarrior documentation that is built and installed along with the executable:

  • man contains the source for the Taskwarrior manual pages.
  • rc contains rcfiles that will be installed in /usr/share/doc/task/rc or equivalent.
  • ref contains reference documentation that will be installed in /usr/share/doc/task or equivalent.

It also contains developer documentation with a high-level view of how Taskwarrior development is done and how the pieces of the system fit together.