Ticket #3617: vim.patch

trunk/BOOK/chapter06/vim.xml

@@ -83 +83 @@
 
     <para>Install the package:</para>
 
-<screen><userinput remap="install">make install</userinput></screen>
+<screen><userinput remap="install">make HELPSUBLOC=/usr/share/doc/vim-&vim-version; install</userinput></screen>
 
+    <variablelist>
+      <title>The meaning of the make option:</title>
+
+      <varlistentry>
+        <term><parameter>HELPSUBLOC=/usr/share/doc/vim-&vim-version;</parameter></term>
+        <listitem>
+          <para>Tells Vim to install its documentation into
+          <filename class="directory">/usr/share/doc/vim-&vim-version;</filename>
+          instead of 
+          <filename class="directory">/usr/share/&vim-docdir;/doc</filename>,
+          for better consistency with the documentation location for other
+          packages.</para>
+        </listitem>
+      </varlistentry>
+
+    </variablelist>
+
     <para>Many users are used to using <command>vi</command> instead of
     <command>vim</command>. To allow execution of <command>vim</command>
     when users habitually enter <command>vi</command>, create a
@@ -96 +113 @@
     ln -sv vim.1 $(dirname $L)/vi.1
 done</userinput></screen>
 
-    <para>By default, Vim's documentation is installed in <filename
-    class="directory">/usr/share/vim</filename>. The following symlink
-    allows the documentation to be accessed via <filename
-    class="directory">/usr/share/doc/vim-&vim-version;</filename>, making
-    it consistent with the location of documentation for other packages:</para>
-
-<screen><userinput remap="install">ln -sv ../&vim-docdir;/doc /usr/share/doc/vim-&vim-version;</userinput></screen>
-
     <para>If an X Window System is going to be installed on the LFS
     system, it may be necessary to recompile Vim after installing X. Vim
     comes with a GUI version of the editor that requires X and some