svn commit: r1869745 - /subversion/trunk/subversion/bindings/swig/INSTALL

[ha...@apache.org]

Author: hartmannathan
Date: Wed Nov 13 15:32:10 2019
New Revision: 1869745

URL: http://svn.apache.org/viewvc?rev=1869745&view=rev
Log:
Improve SWIG 'INSTALL' documentation

* subversion/bindings/swig/INSTALL
  (BUILDING SWIG BINDINGS FOR SVN ON UNIX, Step 1 and Step 1a):
  - Attempt to make the explanation more clear, especially regarding
    which versions of SWIG we support for the Python, Perl, and Ruby
    bindings.  Also fix a few minor grammar and spelling errors.

Suggested by: danielsh
              brane
              julianfoad

Modified:
    subversion/trunk/subversion/bindings/swig/INSTALL

Modified: subversion/trunk/subversion/bindings/swig/INSTALL
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/bindings/swig/INSTALL?rev=1869745&r1=1869744&r2=1869745&view=diff
==============================================================================
--- subversion/trunk/subversion/bindings/swig/INSTALL (original)
+++ subversion/trunk/subversion/bindings/swig/INSTALL Wed Nov 13 15:32:10 2019
@@ -66,32 +66,33 @@ BUILDING SWIG BINDINGS FOR SVN ON UNIX
 
 Step 1: [Optional] Install a suitable version of SWIG
 
-    * SWIG installation is optional if you are using distribution tarball,
-      because it contains source fils generated by SWIG. If you are using
-      a source working copy checked out from Subversion source repository,
-      or you want to regenerate SWIG language bindings source files from 
-      SWIG source files for some reason, you need suitable version of 
-      SWIG installation.
-
-    * Currently supported SWIG version is 2.0.0 and later, however,
-      - SWIG 1.3.24 and later in 1.3.x may work, but we didn't test on
-        latest our source code.
-      - Python bindings for Python 2 doesn't supported SWIG 4.0.0 and later.
-      - Python 3 support for Python bindings requires SWIG 3.0.10 and later,
-        but SWIG 4.0.0 and later is not supported (yet). 
-      - Ruby bindings doesn't support SWIG 3.0.8.
-      - Make sure language specific supported version of SWIG itself, e.g.
-        - Perl 5.16 and later requires SWIG 2.0.8 and later.
-        - SWIG 3.0.9 has some trouble with Python support.
-         (see https://sourceforge.net/p/swig/news/2016/06/swig-3010-released/)
-
-    * Perhaps your distribution packages a suitable version - if it does
-      install it, and skip to the last bullet point in this section.
+    * SWIG installation is optional.  You do not need to install SWIG
+      if you are using a Subversion distribution tarball because it
+      already contains the source files generated by SWIG.  You will
+      need a suitable version of SWIG if you are using a working copy
+      of Subversion's sources checked out from the repository, or if
+      you want to regenerate the SWIG language bindings.
+
+    * We currently support SWIG versions 2.0.0 and later, with the
+      following notes:
+      - SWIG 1.3.24 and later 1.3.x may work, but we do not test these
+        versions on our latest source code.
+      - For Python 2 bindings, SWIG 4.0.0 or later is not supported.
+      - For Python 3 bindings, SWIG 3.0.10 or later is required, but
+        SWIG 4.0.0 and later is not supported (yet).
+      - Note that SWIG 3.0.9 has some trouble with Python support.
+        (See https://sourceforge.net/p/swig/news/2016/06/swig-3010-released/)
+      - For Perl 5.16 and later, SWIG 2.0.8 or later is required.
+      - For Ruby bindings, SWIG 3.0.8 is not supported.
+
+    * Perhaps your distribution packages a suitable version of SWIG.
+      If so, install it and skip to the last bullet point of this
+      section.
 
     * Go to http://www.swig.org/, download the source tarball, and unpack.
 
     * In the swig-x.y.z, directory, run ./configure (where x.y.z is
-      SWIG version, e.g. 3.0.12).
+      SWIG version, e.g., 3.0.12).
 
         If you plan to build the Python bindings, and have a system
         with more than one version of Python installed, you may need
@@ -114,8 +115,9 @@ Step 1: [Optional] Install a suitable ve
         Run 'make && make install'
 
     * To verify you have SWIG installed correctly, run "swig -version"
-      from the command line. SWIG should report that it is suitable version
-      mentioned above.
+      from the command line.  SWIG should report that it is one of the
+      suitable versions mentioned above.
+
 
 Step 1a: Install py3c library if building Python SWIG bindings.
 
@@ -128,6 +130,7 @@ Step 1a: Install py3c library if buildin
     * This is a header-only library, so no configuring or compiling is
       necessary, simply 'make install'.
       
+
 Step 2:  Build and Install Subversion.
 
   See Subversion's own INSTALL file for details.