diff src/po/README_mvc.txt @ 34178:c5a10c03afb8 v9.1.0044

patch 9.1.0044: po Makefiles can be improved Commit: https://github.com/vim/vim/commit/76ba724e1d56b00e72834a9203855f0656dcbb58 Author: RestorerZ <restorer@mail2k.ru> Date: Mon Jan 22 20:28:12 2024 +0100 patch 9.1.0044: po Makefiles can be improved Problem: po Makefiles can be improved Solution: Improve the style of the Makefiles, update Makefile variables, update documentation (RestorerZ) closes: #13858 closes: #13857 Signed-off-by: RestorerZ <restorer@mail2k.ru> Signed-off-by: Christian Brabandt <cb@256bit.org>
author Christian Brabandt <cb@256bit.org>
date Mon, 22 Jan 2024 20:45:03 +0100
parents 45c0a5330758
children
line wrap: on
line diff
--- a/src/po/README_mvc.txt
+++ b/src/po/README_mvc.txt
@@ -2,18 +2,19 @@ TRANSLATING VIM MESSAGES
 
 This file explains how to create and maintain po files using a number of
 GnuWin packages.  You will need gettext, libiconv and libexpat.  As of
-August 2010 the versions known to work are gettext 0.14.4, libiconv 1.9.2-1
-and expat 2.0.1.  gettext and libiconv can be found at:
+January 2024 the versions known to work are gettext 0.14.4, libiconv 1.9.2-1
+and expat 2.5.0.  Gettext and libiconv can be found at:
 
 	http://gnuwin32.sourceforge.net/
 
 expat can be found at:
 
 	http://sourceforge.net/projects/expat/
+or
+	https://github.com/libexpat/libexpat
 
 expat will install into its own directory.  You should copy libexpat.dll into
 the bin directory created from the gettext/libiconv packages.
-
 Or Michele Locati kindly provides precompiled binaries gettext 0.21 and
 iconv 1.16 for Windows on his site: 
 
@@ -29,11 +30,13 @@ Set the environment variable LANGUAGE to
 you are translating Vim messages to.  Language codes are typically two
 characters and you can find a list of them at:
 
-	http://www.geocities.com/click2speak/languages.html
+	https://www.loc.gov/standards/iso639-2/php/code_list.php
+	https://www.science.co.il/language/Codes.php
+	https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes
 
-Another possibility is to use the GnuWin32 port of gettext. This is
-recommended especially if you use already gnuwin32 tools to gunzip, bunzip,
-patch etc. these files. You find the GnuWin32 version of gettext here:
+Another possibility is to use the GnuWin32 port of gettext.  This is
+recommended especially if you use already GnuWin32 tools to gunzip, bunzip,
+patch etc. these files.  You find the GnuWin32 version of gettext here:
 
         http://gnuwin32.sourceforge.net/packages/gettext.htm
 
@@ -41,13 +44,16 @@ Yet another very strait forward way is t
 
         http://www.gnu.org/software/gettext/gettext.html
 
-and build your own version of these tools. The documentation states that this
+and build your own version of these tools.  The documentation states that this
 should be possible with MSVC4.0, MSVC5.0, MSVC6.0 or MSVC7.0, but you can
 build it even successfully with MSVC8.0.
 
 The LANGUAGE environment variable can be set from the command line, by adding
 a line to your autoexec.bat file, or by defining a user variable from the
-Advanced tab in the System control panel.
+Advanced tab in the System control panel.  If the LANGUAGE environment
+variable has not been set in any of the above ways, the value of this variable
+will be set automatically according to the language used in the OS.  This
+value will be valid until the "nmake.exe" program terminates.
 
 Next, edit Make_mvc.mak so that GETTEXT_PATH points the binary directory of
 the installation.
@@ -56,10 +62,13 @@ the installation.
 CREATING A NEW TRANSLATION
 
 When creating a new translation you must add your language code to the
-Make_all.mak file in the lines defining LANGUAGES and MOFILES.  To create the
-initial .po file for your language you must use the command:
+Make_all.mak file in the lines defining LANGUAGES and MOFILES, POFILES and
+CHECKFILES.  If the encoding of the translation text differs from the default
+UTF-8, add a corresponding entry in MOCONVERTED, specifying the required
+encoding.
+To create the initial .po file for your language you must use the command:
 
-	make -f make_mvc.mak first_time
+	nmake.exe -f Make_mvc.mak first_time
 
 Note: You need to be in the po directory when using this makefile.
 
@@ -82,7 +91,7 @@ If there are new or changed messages in 
 first thing to do is merge them into the existing translations.  This is done
 with the following command:
 
-	nmake -f Make_mvc.mak xx.po
+	nmake.exe -f Make_mvc.mak xx
 
 where xx is the language code for the language needing translations.  The
 original .po file is copied to xx.po.orig.
@@ -102,23 +111,30 @@ CHECKING THE TRANSLATION
 
 Check the translation with the following command:
 
-	nmake -f make_mvc.mak xx.mo
+	nmake.exe -f Make_mvc.mak xx.ck
 
-Correct any syntax errors reported.  When there are no more errors, the
-translation is ready to be installed.
+Correct any errors reported.  When there are no more errors, the translation
+is ready to be installed.
 
 
 INSTALLING THE TRANSLATION
 
 Install your translation with the following command:
 
-	nmake -f make_mvc.mak install
+	nmake.exe -f Make_mvc.mak install
 
 This will create the xx\LC_MESSAGES directory in runtime\lang if it does not
 already exist.
 You can also use the following command to install all languages:
 
-	nmake -f make_mvc.mak install-all
+	nmake.exe -f Make_mvc.mak install-all
 
 
+AFTER ALL OF THESE STEPS
+
+Clean the "po" directory of all temporary and unnecessary files.  Execute the
+command:
+
+	nmake.exe -f Make_mvc.mak clean
+
 vim:tw=78: