chore: add note about origin remote to the Sphinx documentation

oracle · Nov 13, 2023 · 73f3e87 · 73f3e87
1 parent 30665ed
commit 73f3e87
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/docs/source/pages/using.rst b/docs/source/pages/using.rst
@@ -297,6 +297,9 @@ Analyzing a locally cloned 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.
 
+.. note::
+  Macaron will always assume that ``origin`` remote exists in the repository and only checkout commits from ``origin`` remote for the analysis.
+
 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: