From 8b817e76b6399634f3f49e682d6e409844241858 Mon Sep 17 00:00:00 2001
From: Andrew Ferrier <andrewferrier@users.noreply.github.com>
Date: Mon, 25 Jul 2022 10:10:07 +0100
Subject: [PATCH] doc: document max_file_length fully (#597)

Co-authored-by: Lewis Russell <me@lewisr.dev>
---
 README.md               | 2 +-
 doc/gitsigns.txt        | 4 ++--
 lua/gitsigns/config.lua | 2 +-
 teal/gitsigns/config.tl | 2 +-
 4 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 4281b9ea..94b7abfb 100644
--- a/README.md
+++ b/README.md
@@ -102,7 +102,7 @@ require('gitsigns').setup {
   sign_priority = 6,
   update_debounce = 100,
   status_formatter = nil, -- Use default
-  max_file_length = 40000,
+  max_file_length = 40000, -- Disable if file is longer than this (in lines)
   preview_config = {
     -- Options passed to nvim_open_win
     border = 'single',
diff --git a/doc/gitsigns.txt b/doc/gitsigns.txt
index 6f4c6b09..80d3a2e8 100644
--- a/doc/gitsigns.txt
+++ b/doc/gitsigns.txt
@@ -61,7 +61,7 @@ of the default settings:
       sign_priority = 6,
       update_debounce = 100,
       status_formatter = nil, -- Use default
-      max_file_length = 40000,
+      max_file_length = 40000, -- Disable if file is longer than this (in lines)
       preview_config = {
         -- Options passed to nvim_open_win
         border = 'single',
@@ -668,7 +668,7 @@ status_formatter                            *gitsigns-config-status_formatter*
 max_file_length                              *gitsigns-config-max_file_length*
       Type: `number`, Default: `40000`
 
-      Max file length to attach to.
+      Max file length (in lines) to attach to.
 
 preview_config                                *gitsigns-config-preview_config*
       Type: `table[extended]`
diff --git a/lua/gitsigns/config.lua b/lua/gitsigns/config.lua
index 4125d683..c4009053 100644
--- a/lua/gitsigns/config.lua
+++ b/lua/gitsigns/config.lua
@@ -388,7 +388,7 @@ M.schema = {
       type = 'number',
       default = 40000,
       description = [[
-      Max file length to attach to.
+      Max file length (in lines) to attach to.
     ]],
    },
 
diff --git a/teal/gitsigns/config.tl b/teal/gitsigns/config.tl
index 5f5898db..1dd6ff76 100644
--- a/teal/gitsigns/config.tl
+++ b/teal/gitsigns/config.tl
@@ -388,7 +388,7 @@ M.schema = {
     type = 'number',
     default = 40000,
     description = [[
-      Max file length to attach to.
+      Max file length (in lines) to attach to.
     ]]
   },