From 71becf018560c8860ea22e04fa2743ac2918708a Mon Sep 17 00:00:00 2001 From: Sebastian Carlos <88276600+sebastiancarlos@users.noreply.github.com> Date: Mon, 24 Jun 2024 14:59:00 -0300 Subject: [PATCH] Remove mentions of legacy data files in the man pages (#3516) Co-authored-by: Sebastian Carlos --- doc/man/task.1.in | 30 ++++++++++-------------------- doc/man/taskrc.5.in | 14 +++++++------- 2 files changed, 17 insertions(+), 27 deletions(-) diff --git a/doc/man/task.1.in b/doc/man/task.1.in index e8835b1f0..7b3b57c90 100644 --- a/doc/man/task.1.in +++ b/doc/man/task.1.in @@ -497,11 +497,10 @@ are important. Running this command generates a summary of similar information that should accompany a bug report. It includes compiler, library and software information. It does not include -any personal information, other than the location and size of your task data -files. +any personal information, other than the location of your task data. -This command also performs a diagnostic scan of your data files looking for -common problems, such as duplicate UUIDs. +This command also performs a diagnostic scan of your data looking for common +problems, such as duplicate UUIDs. .TP .B task execute @@ -692,7 +691,7 @@ the online documentation at: .TP .B ID Tasks can be specified uniquely by IDs, which are simply the indexes of the -tasks in the data file. The ID of a task may therefore change, but only when +tasks in the database. The ID of a task may therefore change, but only when a command is run that displays IDs. When modifying tasks, it is safe to rely on the last displayed ID. Always run a report to check you have the right ID for a task. IDs can be given to task as a sequence, for example, @@ -1395,8 +1394,7 @@ intact, so you can use: $ task add project:\\'Three Word Project\\' description .RE -Taskwarrior supports Unicode using only the UTF8 encoding, with no Byte Order -Marks in the data files. +Taskwarrior supports Unicode using only the UTF8 encoding. .SH CONFIGURATION FILE AND OVERRIDE OPTIONS Taskwarrior stores its configuration in a file in the user's home directory: @@ -1447,21 +1445,13 @@ will check if $XDG_CONFIG_HOME/task/taskrc exists and attempt to read it .TP ~/.task -The default directory where task stores its data files. The location -can be configured in the configuration variable 'data.location', or -overridden with the TASKDATA environment variable.. +The default directory where task stores its data. The location can be +configured in the configuration variable 'data.location', or overridden with +the TASKDATA environment variable. .TP -~/.task/pending.data -The file that contains the tasks that are not yet done. - -.TP -~/.task/completed.data -The file that contains the completed ("done") tasks. - -.TP -~/.task/undo.data -The file that contains information needed by the "undo" command. +~/.task/taskchampion.sqlite3 +The database file. .SH "CREDITS & COPYRIGHTS" Copyright (C) 2006 \- 2021 T. Babej, P. Beckingham, F. Hernandez. diff --git a/doc/man/taskrc.5.in b/doc/man/taskrc.5.in index e1d4fbb3d..53d2ac515 100644 --- a/doc/man/taskrc.5.in +++ b/doc/man/taskrc.5.in @@ -173,7 +173,7 @@ These environment variables override defaults, but not command-line arguments. .TP .B TASKDATA=~/.task -This overrides the default path for the Taskwarrior data files. +This overrides the default path for the Taskwarrior data. .TP .B TASKRC=~/.taskrc @@ -197,7 +197,7 @@ Valid variable names and their default values are: .TP .B data.location=$HOME/.task -This is a path to the directory containing all the Taskwarrior files. By +This is a path to the directory containing all the Taskwarrior data. By default, it is set up to be ~/.task, for example: /home/paul/.task Note that you can use the @@ -212,11 +212,11 @@ This is a path to the hook scripts directory. By default it is ~/.task/hooks. .TP .B locking=1 -Determines whether to use file locking when accessing the pending.data and -completed.data files. Defaults to "1". Solaris users who store the data -files on an NFS mount may need to set locking to "0". Note that there is -danger in setting this value to "0" - another program (or another instance of -task) may write to the task.pending file at the same time. +Determines whether to use file locking when accessing the database. Defaults to +"1". Solaris users who store the database on an NFS mount may need to set +locking to "0". Note that there is danger in setting this value to "0" - +another program (or another instance of task) may write to the database at the +same time. .TP .B gc=1