Merge pull request #1267 from justinmk/version

version refactor

CMakeLists.txt

@@ -12,9 +12,17 @@ set(DEPS_BIN_DIR "${DEPS_INSTALL_DIR}/bin")
 
 list(APPEND CMAKE_PREFIX_PATH ${DEPS_INSTALL_DIR})
 
-set(NEOVIM_VERSION_MAJOR 0)
+# Version tokens
-set(NEOVIM_VERSION_MINOR 0)
+include(GetGitRevisionDescription)
-set(NEOVIM_VERSION_PATCH 0)
+get_git_head_revision(GIT_REFSPEC NVIM_VERSION_COMMIT)
+set(NVIM_VERSION_MAJOR 0)
+set(NVIM_VERSION_MINOR 0)
+set(NVIM_VERSION_PATCH 0)
+set(NVIM_VERSION_PRERELEASE "-alpha")
+# TODO(justinmk): UTC time would be nice here #1071
+git_timestamp(GIT_TIMESTAMP)
+# TODO(justinmk): do not set this for "release" builds #1071
+set(NVIM_VERSION_BUILD "+${GIT_TIMESTAMP}")
 
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 

cmake/GetGitRevisionDescription.cmake

@@ -0,0 +1,161 @@
+# https://github.com/rpavlik/cmake-modules
+#
+# - Returns a version string from Git
+#
+# These functions force a re-configure on each git commit so that you can
+# trust the values of the variables in your build system.
+#
+#  get_git_head_revision(<refspecvar> <hashvar> [<additional arguments to git describe> ...])
+#
+# Returns the refspec and sha hash of the current head revision
+#
+#  git_describe(<var> [<additional arguments to git describe> ...])
+#
+# Returns the results of git describe on the source tree, and adjusting
+# the output so that it tests false if an error occurs.
+#
+#  git_get_exact_tag(<var> [<additional arguments to git describe> ...])
+#
+# Returns the results of git describe --exact-match on the source tree,
+# and adjusting the output so that it tests false if there was no exact
+# matching tag.
+#
+# Requires CMake 2.6 or newer (uses the 'function' command)
+#
+# Original Author:
+# 2009-2010 Ryan Pavlik <rpavlik@iastate.edu> <abiryan@ryand.net>
+# http://academic.cleardefinition.com
+# Iowa State University HCI Graduate Program/VRAC
+#
+# Copyright Iowa State University 2009-2010.
+# Distributed under the Boost Software License, Version 1.0.
+# (See accompanying file LICENSE_1_0.txt or copy at
+# http://www.boost.org/LICENSE_1_0.txt)
+
+if(__get_git_revision_description)
+  return()
+endif()
+set(__get_git_revision_description YES)
+
+# We must run the following at "include" time, not at function call time,
+# to find the path to this module rather than the path to a calling list file
+get_filename_component(_gitdescmoddir ${CMAKE_CURRENT_LIST_FILE} PATH)
+
+function(get_git_head_revision _refspecvar _hashvar)
+  set(GIT_PARENT_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
+  set(GIT_DIR "${GIT_PARENT_DIR}/.git")
+  while(NOT EXISTS "${GIT_DIR}")	# .git dir not found, search parent directories
+    set(GIT_PREVIOUS_PARENT "${GIT_PARENT_DIR}")
+    get_filename_component(GIT_PARENT_DIR ${GIT_PARENT_DIR} PATH)
+    if(GIT_PARENT_DIR STREQUAL GIT_PREVIOUS_PARENT)
+      # We have reached the root directory, we are not in git
+      set(${_refspecvar} "GITDIR-NOTFOUND" PARENT_SCOPE)
+      set(${_hashvar} "GITDIR-NOTFOUND" PARENT_SCOPE)
+      return()
+    endif()
+    set(GIT_DIR "${GIT_PARENT_DIR}/.git")
+  endwhile()
+  # check if this is a submodule
+  if(NOT IS_DIRECTORY ${GIT_DIR})
+    file(READ ${GIT_DIR} submodule)
+    string(REGEX REPLACE "gitdir: (.*)\n$" "\\1" GIT_DIR_RELATIVE ${submodule})
+    get_filename_component(SUBMODULE_DIR ${GIT_DIR} PATH)
+    get_filename_component(GIT_DIR ${SUBMODULE_DIR}/${GIT_DIR_RELATIVE} ABSOLUTE)
+  endif()
+  set(GIT_DATA "${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/git-data")
+  if(NOT EXISTS "${GIT_DATA}")
+    file(MAKE_DIRECTORY "${GIT_DATA}")
+  endif()
+
+  if(NOT EXISTS "${GIT_DIR}/HEAD")
+    return()
+  endif()
+  set(HEAD_FILE "${GIT_DATA}/HEAD")
+  configure_file("${GIT_DIR}/HEAD" "${HEAD_FILE}" COPYONLY)
+
+  configure_file("${_gitdescmoddir}/GetGitRevisionDescription.cmake.in"
+    "${GIT_DATA}/grabRef.cmake"
+    @ONLY)
+  include("${GIT_DATA}/grabRef.cmake")
+
+  set(${_refspecvar} "${HEAD_REF}" PARENT_SCOPE)
+  set(${_hashvar} "${HEAD_HASH}" PARENT_SCOPE)
+endfunction()
+
+function(git_describe _var)
+  if(NOT GIT_FOUND)
+    find_package(Git QUIET)
+  endif()
+  get_git_head_revision(refspec hash)
+  if(NOT GIT_FOUND)
+    set(${_var} "GIT-NOTFOUND" PARENT_SCOPE)
+    return()
+  endif()
+  if(NOT hash)
+    set(${_var} "HEAD-HASH-NOTFOUND" PARENT_SCOPE)
+    return()
+  endif()
+
+  # TODO sanitize
+  #if((${ARGN}" MATCHES "&&") OR
+  #	(ARGN MATCHES "||") OR
+  #	(ARGN MATCHES "\\;"))
+  #	message("Please report the following error to the project!")
+  #	message(FATAL_ERROR "Looks like someone's doing something nefarious with git_describe! Passed arguments ${ARGN}")
+  #endif()
+
+  #message(STATUS "Arguments to execute_process: ${ARGN}")
+
+  execute_process(COMMAND
+    "${GIT_EXECUTABLE}"
+    describe
+    ${hash}
+    ${ARGN}
+    WORKING_DIRECTORY
+    "${CMAKE_SOURCE_DIR}"
+    RESULT_VARIABLE
+    res
+    OUTPUT_VARIABLE
+    out
+    ERROR_QUIET
+    OUTPUT_STRIP_TRAILING_WHITESPACE)
+  if(NOT res EQUAL 0)
+    set(out "${out}-${res}-NOTFOUND")
+  endif()
+
+  set(${_var} "${out}" PARENT_SCOPE)
+endfunction()
+
+function(git_timestamp _var)
+  if(NOT GIT_FOUND)
+    find_package(Git QUIET)
+  endif()
+  get_git_head_revision(refspec hash)
+  if(NOT GIT_FOUND)
+    set(${_var} "GIT-NOTFOUND" PARENT_SCOPE)
+    return()
+  endif()
+  if(NOT hash)
+    set(${_var} "HEAD-HASH-NOTFOUND" PARENT_SCOPE)
+    return()
+  endif()
+
+  execute_process(COMMAND "${GIT_EXECUTABLE}" log -1 --format="%ci" ${hash} ${ARGN}
+    WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
+    RESULT_VARIABLE res
+    OUTPUT_VARIABLE out
+    ERROR_QUIET
+    OUTPUT_STRIP_TRAILING_WHITESPACE)
+  if(NOT res EQUAL 0)
+    set(out "${out}-${res}-NOTFOUND")
+  endif()
+  string(REGEX REPLACE "[-\" :]" "" out ${out})
+  string(SUBSTRING ${out} 0 12 out)
+
+  set(${_var} ${out} PARENT_SCOPE)
+endfunction()
+
+function(git_get_exact_tag _var)
+  git_describe(out --exact-match ${ARGN})
+  set(${_var} "${out}" PARENT_SCOPE)
+endfunction()

cmake/GetGitRevisionDescription.cmake.in

@@ -0,0 +1,38 @@
+# 
+# Internal file for GetGitRevisionDescription.cmake
+#
+# Requires CMake 2.6 or newer (uses the 'function' command)
+#
+# Original Author:
+# 2009-2010 Ryan Pavlik <rpavlik@iastate.edu> <abiryan@ryand.net>
+# http://academic.cleardefinition.com
+# Iowa State University HCI Graduate Program/VRAC
+#
+# Copyright Iowa State University 2009-2010.
+# Distributed under the Boost Software License, Version 1.0.
+# (See accompanying file LICENSE_1_0.txt or copy at
+# http://www.boost.org/LICENSE_1_0.txt)
+
+set(HEAD_HASH)
+
+file(READ "@HEAD_FILE@" HEAD_CONTENTS LIMIT 1024)
+
+string(STRIP "${HEAD_CONTENTS}" HEAD_CONTENTS)
+if(HEAD_CONTENTS MATCHES "ref")
+  # named branch
+  string(REPLACE "ref: " "" HEAD_REF "${HEAD_CONTENTS}")
+  if(EXISTS "@GIT_DIR@/${HEAD_REF}")
+    configure_file("@GIT_DIR@/${HEAD_REF}" "@GIT_DATA@/head-ref" COPYONLY)
+  elseif(EXISTS "@GIT_DIR@/logs/${HEAD_REF}")
+    configure_file("@GIT_DIR@/logs/${HEAD_REF}" "@GIT_DATA@/head-ref" COPYONLY)
+    set(HEAD_HASH "${HEAD_REF}")
+  endif()
+else()
+  # detached HEAD
+  configure_file("@GIT_DIR@/HEAD" "@GIT_DATA@/head-ref" COPYONLY)
+endif()
+
+if(NOT HEAD_HASH)
+  file(READ "@GIT_DATA@/head-ref" HEAD_HASH LIMIT 1024)
+  string(STRIP "${HEAD_HASH}" HEAD_HASH)
+endif()

config/config.h.in

@@ -1,6 +1,9 @@
-#define NEOVIM_VERSION_MAJOR @NEOVIM_VERSION_MAJOR@
+#define NVIM_VERSION_MAJOR @NVIM_VERSION_MAJOR@
-#define NEOVIM_VERSION_MINOR @NEOVIM_VERSION_MINOR@
+#define NVIM_VERSION_MINOR @NVIM_VERSION_MINOR@
-#define NEOVIM_VERSION_PATCH @NEOVIM_VERSION_PATCH@
+#define NVIM_VERSION_PATCH @NVIM_VERSION_PATCH@
+#define NVIM_VERSION_PRERELEASE "@NVIM_VERSION_PRERELEASE@"
+#define NVIM_VERSION_BUILD "@NVIM_VERSION_BUILD@"
+#define NVIM_VERSION_COMMIT "@NVIM_VERSION_COMMIT@"
 
 #cmakedefine DEBUG
 

config/pathdef.c.in

@@ -1,7 +1,5 @@
 #include "${PROJECT_SOURCE_DIR}/src/nvim/vim.h"
 char_u *default_vim_dir = (char_u *)"${CMAKE_INSTALL_PREFIX}/share/nvim";
 char_u *default_vimruntime_dir = (char_u *)"";
-char_u *all_cflags = (char_u *)"${COMPILER_FLAGS}";
-char_u *all_lflags = (char_u *)"${LINKER_FLAGS}";
 char_u *compiled_user = (char_u *)"${USERNAME}";
 char_u *compiled_sys = (char_u *)"${HOSTNAME}";

runtime/doc/uganda.txt

@@ -123,10 +123,6 @@ Note:
 - Once a change is included that goes under the GNU GPL, this forces all
   further changes to also be made under the GNU GPL or a compatible license.
 
-- If you distribute a modified version of Vim, you can include your name and
-  contact information with the "--with-modified-by" configure argument or the
-  MODIFIED_BY define.
-
 ==============================================================================
 Kibaale Children's Centre		*kcc* *Kibaale*  *charity*
 

src/nvim/ex_cmds.c

@@ -1724,8 +1724,8 @@ static void do_viminfo(FILE *fp_in, FILE *fp_out, int flags)
   }
   if (fp_out != NULL) {
     /* Write the info: */
-    fprintf(fp_out, _("# This viminfo file was generated by Vim %s.\n"),
+    fprintf(fp_out, _("# This viminfo file was generated by Nvim %s.\n"),
-        VIM_VERSION_MEDIUM);
+        NVIM_VERSION_MEDIUM);
     fputs(_("# You may edit it if you're careful!\n\n"), fp_out);
     fputs(_("# Value of 'encoding' when this file was written\n"), fp_out);
     fprintf(fp_out, "*encoding=%s\n\n", p_enc);

src/nvim/globals.h

@@ -996,8 +996,6 @@ extern char *longVersion;
 #ifdef HAVE_PATHDEF
 extern char_u *default_vim_dir;
 extern char_u *default_vimruntime_dir;
-extern char_u *all_cflags;
-extern char_u *all_lflags;
 extern char_u *compiled_user;
 extern char_u *compiled_sys;
 #endif

src/nvim/hardcopy.c

@@ -2457,7 +2457,7 @@ int mch_print_begin(prt_settings_T *psettings)
     STRCPY(buffer, "Unknown");
   }
   prt_dsc_textline("For", buffer);
-  prt_dsc_textline("Creator", VIM_VERSION_LONG);
+  prt_dsc_textline("Creator", NVIM_VERSION_LONG);
   /* Note: to ensure Clean8bit I don't think we can use LC_TIME */
   now = time(NULL);
   p_time = ctime(&now);

src/nvim/version.c

@@ -1,14 +1,7 @@
 /// @file version.c
 ///
-/// Vim originated from Stevie version 3.6 (Fish disk 217) by GRWalter (Fred)
+/// Nvim was forked from Vim 7.4.160.
-/// It has been changed beyond recognition since then.
+/// Vim originated from Stevie version 3.6 (Fish disk 217) by GRWalter (Fred).
-///
-/// Differences between version 6.x and 7.x can be found with ":help version7".
-/// Differences between version 5.x and 6.x can be found with ":help version6".
-/// Differences between version 4.x and 5.x can be found with ":help version5".
-/// Differences between version 3.0 and 4.x can be found with ":help version4".
-/// All the remarks about older versions have been removed, they are not very
-/// interesting.
 
 #include <inttypes.h>
 
@@ -25,10 +18,8 @@
 #include "nvim/version_defs.h"
 
 char *Version = VIM_VERSION_SHORT;
-static char *mediumVersion = VIM_VERSION_MEDIUM;
+char *longVersion = NVIM_VERSION_LONG " (compiled " __DATE__ " " __TIME__ ")";
-
+char *version_commit = "Commit: " NVIM_VERSION_COMMIT;
-char *longVersion = VIM_VERSION_LONG_DATE __DATE__ " " __TIME__ ")";
-
 
 #ifdef INCLUDE_GENERATED_DECLARATIONS
 # include "version.c.generated.h"
@@ -752,60 +743,24 @@ static void list_features(void)
 
 void list_version(void)
 {
-  int i;
-  int first;
-  char *s = "";
-
   // When adding features here, don't forget to update the list of
   // internal variables in eval.c!
   MSG(longVersion);
-
+  MSG(version_commit);
-  // Print the list of patch numbers if there is at least one.
-  // Print a range when patches are consecutive: "1-10, 12, 15-40, 42-45"
-  if (included_patches[0] != 0) {
-    MSG_PUTS(_("\nIncluded patches: "));
-    first = -1;
-
-    // find last one
-    for (i = 0; included_patches[i] != 0; ++i) {}
-
-    while (--i >= 0) {
-      if (first < 0) {
-        first = included_patches[i];
-      }
-
-      if ((i == 0) || (included_patches[i - 1] != included_patches[i] + 1)) {
-        MSG_PUTS(s);
-        s = ", ";
-        msg_outnum((long)first);
-
-        if (first != included_patches[i]) {
-          MSG_PUTS("-");
-          msg_outnum((long)included_patches[i]);
-        }
-        first = -1;
-      }
-    }
-  }
 
   // Print the list of extra patch descriptions if there is at least one.
+  char *s = "";
   if (extra_patches[0] != NULL) {
     MSG_PUTS(_("\nExtra patches: "));
     s = "";
 
-    for (i = 0; extra_patches[i] != NULL; ++i) {
+    for (int i = 0; extra_patches[i] != NULL; ++i) {
       MSG_PUTS(s);
       s = ", ";
       MSG_PUTS(extra_patches[i]);
     }
   }
 
-#ifdef MODIFIED_BY
-  MSG_PUTS("\n");
-  MSG_PUTS(_("Modified by "));
-  MSG_PUTS(MODIFIED_BY);
-#endif  // ifdef MODIFIED_BY
-
 #ifdef HAVE_PATHDEF
 
   if ((*compiled_user != NUL) || (*compiled_sys != NUL)) {
@@ -823,8 +778,6 @@ void list_version(void)
   }
 #endif  // ifdef HAVE_PATHDEF
 
-  MSG_PUTS(_("\nHuge version "));
-  MSG_PUTS(_("without GUI."));
   version_msg(_("  Features included (+) or not (-):\n"));
 
   list_features();
@@ -872,11 +825,6 @@ void list_version(void)
     version_msg((char *)default_vimruntime_dir);
     version_msg("\"\n");
   }
-  version_msg(_("Compilation: "));
-  version_msg((char *)all_cflags);
-  version_msg("\n");
-  version_msg(_("Linking: "));
-  version_msg((char *)all_lflags);
 #endif  // ifdef HAVE_PATHDEF
 #ifdef DEBUG
   version_msg("\n");
@@ -929,13 +877,9 @@ void intro_message(int colon)
   int sponsor;
   char *p;
   static char *(lines[]) = {
-    N_("VIM - Vi IMproved"),
+    N_(NVIM_VERSION_LONG),
     "",
-    N_("version "),
     N_("by Bram Moolenaar et al."),
-#ifdef MODIFIED_BY
-    " ",
-#endif  // ifdef MODIFIED_BY
     N_("Vim is open source and freely distributable"),
     "",
     N_("Help poor children in Uganda!"),
@@ -943,7 +887,6 @@ void intro_message(int colon)
     "",
     N_("type  :q<Enter>               to exit         "),
     N_("type  :help<Enter>  or  <F1>  for on-line help"),
-    N_("type  :help version7<Enter>   for version info"),
     NULL,
     "",
     N_("Running in Vi compatible mode"),
@@ -1001,7 +944,7 @@ void intro_message(int colon)
       }
 
       if (*p != NUL) {
-        do_intro_line(row, (char_u *)_(p), i == 2, 0);
+        do_intro_line(row, (char_u *)_(p), 0);
       }
       row++;
     }
@@ -1013,45 +956,16 @@ void intro_message(int colon)
   }
 }
 
-static void do_intro_line(int row, char_u *mesg, int add_version, int attr)
+static void do_intro_line(int row, char_u *mesg, int attr)
 {
-  char_u vers[20];
   int col;
   char_u *p;
   int l;
   int clen;
 
-#ifdef MODIFIED_BY
-# define MODBY_LEN 150
-  char_u modby[MODBY_LEN];
-
-  if (*mesg == ' ') {
-    l = STRLCPY(modby, _("Modified by "), MODBY_LEN);
-    if (l < MODBY_LEN - 1) {
-      STRLCPY(modby + l, MODIFIED_BY, MODBY_LEN - l);
-    }
-    mesg = modby;
-  }
-#endif  // ifdef MODIFIED_BY
-
   // Center the message horizontally.
   col = vim_strsize(mesg);
 
-  if (add_version) {
-    STRCPY(vers, mediumVersion);
-
-    if (highest_patch()) {
-      // Check for 9.9x or 9.9xx, alpha/beta version
-      if (isalpha((int)vers[3])) {
-        int len = (isalpha((int)vers[4])) ? 5 : 4;
-        sprintf((char *)vers + len, ".%d%s", highest_patch(),
-                mediumVersion + len);
-      } else {
-        sprintf((char *)vers + 3,   ".%d",   highest_patch());
-      }
-    }
-    col += (int)STRLEN(vers);
-  }
   col = (Columns - col) / 2;
 
   if (col < 0) {
@@ -1074,11 +988,6 @@ static void do_intro_line(int row, char_u *mesg, int add_version, int attr)
     screen_puts_len(p, l, row, col, *p == '<' ? hl_attr(HLF_8) : attr);
     col += clen;
   }
-
-  // Add the version number to the version line.
-  if (add_version) {
-    screen_puts(vers, row, col, 0);
-  }
 }
 
 /// ":intro": clear screen, display intro screen and wait for return.

src/nvim/version_defs.h

@@ -1,47 +1,50 @@
 #ifndef NVIM_VERSION_DEFS_H
 #define NVIM_VERSION_DEFS_H
 
-/*
+// VIM - Vi IMproved    by Bram Moolenaar
- * VIM - Vi IMproved		by Bram Moolenaar
+//
- *
+// Do ":help uganda"  in Vim to read copying and usage conditions.
- * Do ":help uganda"  in Vim to read copying and usage conditions.
+// Do ":help credits" in Vim to see a list of people who contributed.
- * Do ":help credits" in Vim to see a list of people who contributed.
- */
 
-/*
+#define STR_(x) #x
- * Define the version number, name, etc.
+#define STR(x) STR_(x)
- * The patchlevel is in included_patches[], in version.c.
- *
- * This doesn't use string concatenation, some compilers don't support it.
- */
 
+//
+// Nvim version identifiers
+//
+#ifndef NVIM_VERSION_MAJOR
+#define NVIM_VERSION_MAJOR 0
+#endif
+#ifndef NVIM_VERSION_MINOR
+#define NVIM_VERSION_MINOR 0
+#endif
+#ifndef NVIM_VERSION_PATCH
+#define NVIM_VERSION_PATCH 0
+#endif
+#ifndef NVIM_VERSION_PRERELEASE
+#define NVIM_VERSION_PRERELEASE
+#endif
+#ifndef NVIM_VERSION_BUILD
+#define NVIM_VERSION_BUILD
+#endif
+#ifndef NVIM_VERSION_COMMIT
+#define NVIM_VERSION_COMMIT
+#endif
+// for the startup-screen
+#define NVIM_VERSION_MEDIUM STR(NVIM_VERSION_MAJOR) "." STR(NVIM_VERSION_MINOR)
+// for the ":version" command and "nvim -h"
+#define NVIM_VERSION_LONG "NVIM " NVIM_VERSION_MEDIUM "." STR(NVIM_VERSION_PATCH) NVIM_VERSION_PRERELEASE NVIM_VERSION_BUILD
+
+//
+// Vim version number, name, etc. Patchlevel is defined in version.c.
+//
 #define VIM_VERSION_MAJOR                7
-#define VIM_VERSION_MAJOR_STR           "7"
 #define VIM_VERSION_MINOR                4
-#define VIM_VERSION_MINOR_STR           "4"
 #define VIM_VERSION_100     (VIM_VERSION_MAJOR * 100 + VIM_VERSION_MINOR)
 
-#define VIM_VERSION_BUILD                280
+// used for the runtime directory name
-#define VIM_VERSION_BUILD_BCD           0x118
-#define VIM_VERSION_BUILD_STR           "280"
-#define VIM_VERSION_PATCHLEVEL           0
-#define VIM_VERSION_PATCHLEVEL_STR      "0"
-/* Used by MacOS port should be one of: development, alpha, beta, final */
-#define VIM_VERSION_RELEASE             development
-
-/*
- * VIM_VERSION_NODOT is used for the runtime directory name.
- * VIM_VERSION_SHORT is copied into the swap file (max. length is 6 chars).
- * VIM_VERSION_MEDIUM is used for the startup-screen.
- * VIM_VERSION_LONG is used for the ":version" command and "Vim -h".
- */
 #define VIM_VERSION_NODOT       "vim74"
+// swap file compatibility (max. length is 6 chars)
 #define VIM_VERSION_SHORT       "7.4"
-#define VIM_VERSION_MEDIUM      "7.4"
-#define VIM_VERSION_LONG        "VIM - Vi IMproved 7.4 (2014)"
-#define VIM_VERSION_LONG_DATE   "VIM - Vi IMproved 7.4 (2014, compiled "
-
-/* Displayed on splash screen. */
-#define MODIFIED_BY "the Neovim contributors."
 
 #endif  // NVIM_VERSION_DEFS_H