From d1a3573c5f65d91181e61a394f8a9bab2c3a890b Mon Sep 17 00:00:00 2001 From: Sebastian Carlos <88276600+sebastiancarlos@users.noreply.github.com> Date: Thu, 4 Jul 2024 23:32:22 -0300 Subject: [PATCH] Replace "gc" with "rebuild" in man pages. (#3533) Replace "gc" with "rebuild" in man page. Also, explain IDs in the context of the working set of tasks. --- doc/man/task.1.in | 11 ++++++----- doc/man/taskrc.5.in | 8 ++++---- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/doc/man/task.1.in b/doc/man/task.1.in index ae982b53b..9a0444cc3 100644 --- a/doc/man/task.1.in +++ b/doc/man/task.1.in @@ -744,11 +744,12 @@ the online documentation at: .TP .B ID -Tasks can be specified uniquely by IDs, which are simply the indexes of the -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: +Tasks can be specified uniquely by IDs, which are the indexes of the "working +set" of tasks (mostly pending and recurrent tasks). The ID of a task may +therefore change, but only when a report that displays IDs is run. 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: .nf task 1,4-10,19 delete diff --git a/doc/man/taskrc.5.in b/doc/man/taskrc.5.in index 266d276bb..1a764af43 100644 --- a/doc/man/taskrc.5.in +++ b/doc/man/taskrc.5.in @@ -211,10 +211,10 @@ This is a path to the hook scripts directory. By default it is ~/.task/hooks. .TP .B gc=1 -Can be used to temporarily suspend garbage collection (gc), so that task IDs -don't change. Note that this should be used in the form of a command line -override (task rc.gc=0 ...), and not permanently used in the .taskrc file, -as this significantly affects performance in the long term. +Can be used to temporarily suspend rebuilding, so that task IDs don't change. +Note that this should be used in the form of a command line override (task +rc.gc=0 ...), and not permanently used in the .taskrc file, as this +significantly affects performance in the long term. .TP .B hooks=1