From cc2fd1be3c424831d8994af8d3522471699e3265 Mon Sep 17 00:00:00 2001 From: Trong Nhan Mai Date: Tue, 31 Oct 2023 15:31:44 +1000 Subject: [PATCH] chore: add warning docs to analyzing a locally cloned repository use case Signed-off-by: Trong Nhan Mai --- docs/source/pages/using.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/source/pages/using.rst b/docs/source/pages/using.rst index 3f88d2b20..d7a00260e 100644 --- a/docs/source/pages/using.rst +++ b/docs/source/pages/using.rst @@ -292,6 +292,11 @@ An example configuration file for utilising this feature: Analyzing a locally cloned repository ------------------------------------- +.. warning:: + During the analysis, Macaron can check out different commits, which can reset the index and working tree of the repository. + Therefore, any uncommitted changes in the repository need to be backed up to prevent loss (these include unstaged changes, staged changes and untracked files). + However, Macaron will not modify the history of the repository. + If you have a local repository that you want to analyze, Macaron also supports running the analysis against a local repository. Assume that the dir tree at the local repository has the following components: