From e2781b60a1c6fb4909eed82c3cead780241c9364 Mon Sep 17 00:00:00 2001 From: Nathaniel Kenschaft Date: Tue, 16 Jun 2020 23:31:57 -0400 Subject: [PATCH] documented the background service --- docs/source/background_service.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/source/background_service.rst b/docs/source/background_service.rst index a54992f..c17a079 100644 --- a/docs/source/background_service.rst +++ b/docs/source/background_service.rst @@ -2,4 +2,15 @@ Background Service ================= This requires no user input. The proper events are -called by the main application to log events in the student's work directory. +called by the main application to log events in the +student's work directory. The service records file +accesses, editions, deletions, files moved from an +outside directory, and file to an outside directory. +Additionally, it records any git commands discovered +in the student's .bash_history or .histfile (zsh +equivalent), as git commands can interfere with the +service. It also checks for files that do not have +extensions that are whitelisted. The whitelist +includes common file extensions such as text files, +presentations, and programming file extensions (e.g. +.py for python and .class for java).