gen_declarations: Do not generate line numbers by default

1 files changed, 38 insertions, 5 deletions

diff --git a/src/nvim/generators/gen_declarations.lua b/src/nvim/generators/gen_declarations.lua
index e999e53e4a..0c73376ba0 100755
--- a/src/nvim/generators/gen_declarations.lua
+++ b/src/nvim/generators/gen_declarations.lua
@@ -164,9 +164,40 @@ local pattern = concat(
 )
 
 if fname == '--help' then
-  print'Usage:'
-  print()
-  print'  gendeclarations.lua definitions.c static.h non-static.h preprocessor.i'
+  print([[
+Usage:
+
+    gendeclarations.lua definitions.c static.h non-static.h definitions.i
+
+Generates declarations for a C file defitions.c, putting declarations for
+static functions into static.h and declarations for non-static functions into
+non-static.h. File `definitions.i' should contain an already preprocessed
+version of defintions.c and it is the only one which is actually parsed,
+definitions.c is needed only to determine functions from which file out of all
+functions found in definitions.i are needed.
+
+Additionally uses the following environment variables:
+
+    NVIM_GEN_DECLARATIONS_LINE_NUMBERS:
+        If set to 1 then all generated declarations receive a comment with file
+        name and line number after the declaration. This may be useful for
+        debugging gen_declarations script, but not much beyound that with 
+        configured development environment (i.e. with ctags/cscope/finding
+        definitions with clang/etc).
+
+        WARNING: setting this to 1 will cause extensive rebuilds: declarations
+                 generator script will not regenerate non-static.h file if its
+                 contents did not change, but including line numbers will make
+                 contents actually change.
+
+                 With contents changed timestamp of the file is regenerated even
+                 when no real changes were made (e.g. a few lines were added to
+                 a function which is not at the bottom of the file).
+
+                 With changed timestamp build system will assume that header
+                 changed, triggering rebuilds of all C files which depend on the
+                 "changed" header.
+]])
   os.exit()
 end
 
@@ -249,8 +280,10 @@ while init ~= nil do
       declaration = declaration:gsub(' $', '')
       declaration = declaration:gsub('^ ', '')
       declaration = declaration .. ';'
-      declaration = declaration .. ('  // %s/%s:%u'):format(
-          curdir, curfile, declline)
+      if os.getenv('NVIM_GEN_DECLARATIONS_LINE_NUMBERS') == '1' then
+        declaration = declaration .. ('  // %s/%s:%u'):format(
+            curdir, curfile, declline)
+      end
       declaration = declaration .. '\n'
       if declaration:sub(1, 6) == 'static' then
         static = static .. declaration