From 630f8069d0d782abdd7dda293ba871a59f6ebf2a Mon Sep 17 00:00:00 2001 From: Martin von Zweigbergk Date: Sat, 5 Mar 2022 08:42:35 -0800 Subject: [PATCH] docs: explain that the there's no reason to use the native backend A few people in different forums asked if there's any reason to use the native backend and what the reason for its existance is, so let's document that. --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 21d71b06c..ac2e0de55 100644 --- a/README.md +++ b/README.md @@ -32,10 +32,14 @@ to replace (rare in English). The project is called "Jujutsu" because it matches ### Compatible with Git Jujutsu has two backends. One of them is a Git backend (the other is a native -one). This lets you use Jujutsu as an alternative interface to Git. The commits +one [^native-backend]). This lets you use Jujutsu as an alternative interface to Git. The commits you create will look like regular Git commits. You can always switch back to Git. The Git support uses the [libgit2](https://libgit2.org/) C library. +[^native-backend]: There's currently practically no reason to use the native +backend. It exists to make sure that it's possible to eventually add +functionality that cannot easily be added the Git backend. +