From b80a8333239a02cd708123c44e39348537374d5c Mon Sep 17 00:00:00 2001
From: Sebastian Qvarfordt <s.qvarfordt@gmail.com>
Date: Mon, 21 Sep 2020 16:51:46 +0200
Subject: [PATCH] comment to explain option

---
 plugins/techdocs-backend/src/helpers.ts | 1 +
 1 file changed, 1 insertion(+)

diff --git a/plugins/techdocs-backend/src/helpers.ts b/plugins/techdocs-backend/src/helpers.ts
index 670c9f0970..8acd836cad 100644
--- a/plugins/techdocs-backend/src/helpers.ts
+++ b/plugins/techdocs-backend/src/helpers.ts
@@ -26,6 +26,7 @@ import { InputError } from '@backstage/backend-common';
 import { RemoteProtocol } from './techdocs/stages/prepare/types';
 import { Logger } from 'winston';
 
+// Enables core.longpaths on windows to prevent crashing when checking out repos with long foldernames and/or deep nesting
 // @ts-ignore
 NodeGit.Libgit2.opts(28, 1);