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

Remove mentions of legacy data files in the man pages (#3516)

Browse source 
Co-authored-by: Sebastian Carlos <sebastiancarlos@gmail.com>
This commit is contained in:
Sebastian Carlos 2024-06-24 14:59:00 -03:00 • committed by GitHub
parent 572268606f
commit 71becf0185
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 17 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

30
doc/man/task.1.in
View file

@ -497,11 +497,10 @@ are important. Running this command generates a summary of similar information
that should accompany a bug report. that should accompany a bug report.
It includes compiler, library and software information. It does not include It includes compiler, library and software information. It does not include
any personal information, other than the location and size of your task data any personal information, other than the location of your task data.
files.
This command also performs a diagnostic scan of your data files looking for This command also performs a diagnostic scan of your data looking for common
common problems, such as duplicate UUIDs. problems, such as duplicate UUIDs.
.TP .TP
.B task execute <external command> .B task execute <external command>
@ -692,7 +691,7 @@ the online documentation at:
.TP .TP
.B ID .B ID
Tasks can be specified uniquely by IDs, which are simply the indexes of the 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 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 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, 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 $ task add project:\\'Three Word Project\\' description
.RE .RE
Taskwarrior supports Unicode using only the UTF8 encoding, with no Byte Order Taskwarrior supports Unicode using only the UTF8 encoding.
Marks in the data files.
.SH CONFIGURATION FILE AND OVERRIDE OPTIONS .SH CONFIGURATION FILE AND OVERRIDE OPTIONS
Taskwarrior stores its configuration in a file in the user's home directory: 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 .TP
~/.task ~/.task
The default directory where task stores its data files. The location The default directory where task stores its data. The location can be
can be configured in the configuration variable 'data.location', or configured in the configuration variable 'data.location', or overridden with
overridden with the TASKDATA environment variable.. the TASKDATA environment variable.
.TP .TP
~/.task/pending.data ~/.task/taskchampion.sqlite3
The file that contains the tasks that are not yet done. The database file.
.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.
.SH "CREDITS & COPYRIGHTS" .SH "CREDITS & COPYRIGHTS"
Copyright (C) 2006 \- 2021 T. Babej, P. Beckingham, F. Hernandez. Copyright (C) 2006 \- 2021 T. Babej, P. Beckingham, F. Hernandez.

14
doc/man/taskrc.5.in
View file

@ -173,7 +173,7 @@ These environment variables override defaults, but not command-line arguments.
.TP .TP
.B TASKDATA=~/.task .B TASKDATA=~/.task
This overrides the default path for the Taskwarrior data files. This overrides the default path for the Taskwarrior data.
.TP .TP
.B TASKRC=~/.taskrc .B TASKRC=~/.taskrc
@ -197,7 +197,7 @@ Valid variable names and their default values are:
.TP .TP
.B data.location=$HOME/.task .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 default, it is set up to be ~/.task, for example: /home/paul/.task
Note that you can use the 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 .TP
.B locking=1 .B locking=1
Determines whether to use file locking when accessing the pending.data and Determines whether to use file locking when accessing the database. Defaults to
completed.data files. Defaults to "1". Solaris users who store the data "1". Solaris users who store the database on an NFS mount may need to set
files on an NFS mount may need to set locking to "0". Note that there is locking to "0". Note that there is danger in setting this value to "0" -
danger in setting this value to "0" - another program (or another instance of another program (or another instance of task) may write to the database at the
task) may write to the task.pending file at the same time. same time.
.TP .TP
.B gc=1 .B gc=1