From a310b6fa2df47b03f2cb227c74d3c3211f83c51b Mon Sep 17 00:00:00 2001 From: "Kyle J. McKay" Date: Tue, 13 Feb 2018 13:46:26 -0800 Subject: [PATCH] docs: move garbage collection docs into docs/technical Begin the population of a new "docs/" subdirectory with the "technical/gc.txt" and "technical/gc-mini.txt" files relocated from the "jobd/" subdirectory. Signed-off-by: Kyle J. McKay --- jobd/README-GC-MINI => docs/technical/gc-mini.txt | 0 jobd/README-GC => docs/technical/gc.txt | 0 jobd/README | 11 +++++++---- jobd/gc.sh | 3 +++ 4 files changed, 10 insertions(+), 4 deletions(-) rename jobd/README-GC-MINI => docs/technical/gc-mini.txt (100%) rename jobd/README-GC => docs/technical/gc.txt (100%) diff --git a/jobd/README-GC-MINI b/docs/technical/gc-mini.txt similarity index 100% rename from jobd/README-GC-MINI rename to docs/technical/gc-mini.txt diff --git a/jobd/README-GC b/docs/technical/gc.txt similarity index 100% rename from jobd/README-GC rename to docs/technical/gc.txt diff --git a/jobd/README b/jobd/README index e315849..9f9629c 100644 --- a/jobd/README +++ b/jobd/README @@ -1,5 +1,8 @@ Girocco "job daemon" - it can either be periodically ran from crontab -(see jobs/README, fine for smaller sites) or running standalone; it -does not communicate with the outer word and simply periodically -performs various house-keeping tasks - repacking any repositories and -updating mirrored repositories. +(see jobs/README, fine for smaller sites) or running standalone; +it does not communicate with the outer world and simply periodically +performs various house-keeping tasks - repacking any repositories +and updating mirrored repositories. + +See the docs/technical/gc.txt and docs/technical/gc-mini.txt files +for more information on how garbage collection is performed. diff --git a/jobd/gc.sh b/jobd/gc.sh index 352ff3d..ae049d8 100755 --- a/jobd/gc.sh +++ b/jobd/gc.sh @@ -660,6 +660,9 @@ remove_crud() { ## to run it often. If the file .needsgc exists, a "mini" gc will occur at ## the next opportunity. ## +## See the docs/technical/gc.txt and docs/technical/gc-mini.txt files for more +## of the gory details of how garbage collection is performed. +## ## Note, however, that the .nogc file suppresses ALL gc activity (normal or mini). # -- 2.11.4.GIT