Skip to content

Commit

Permalink
Replace "gc" with "rebuild" in man pages. (#3533)
Browse files Browse the repository at this point in the history
Replace "gc" with "rebuild" in man page.

Also, explain IDs in the context of the working set of tasks.
  • Loading branch information
sebastiancarlos committed Jul 5, 2024
1 parent fa5604e commit d1a3573
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
11 changes: 6 additions & 5 deletions doc/man/task.1.in
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions doc/man/taskrc.5.in
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit d1a3573

Please sign in to comment.