zsh: Clean up documentation build and install instruction

The so-called "optional documentation" actually contains nothing more
than the HTML documentations generated by makeinfo --html.  So just stop
downloading it.

A change in texinfo-7.0 has actually break makeinfo --html of zsh, but
the issue was hidden due to the inclusion of the "optional
documentation".  Use a sed to correct it.

Do not put zsh.txt and zsh.html info the Doc directory, or they'll be
installed to /usr/share/doc/zsh-5.9/html by make install.html.

Also install the FAQ of zsh.
This commit is contained in:
Xi Ruoyao 2024-01-07 04:32:17 +08:00
parent 2cec8a051a
commit 7299d5ef26
No known key found for this signature in database
GPG Key ID: ACAAD20E19E710E3

View File

@ -72,26 +72,6 @@
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">Additional Downloads</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Optional Documentation: <ulink
url="https://www.zsh.org/pub/zsh-&zsh-version;-doc.tar.xz"/>
</para>
</listitem>
<listitem>
<para>
Documentation MD5 sum: &zsh-doc-md5sum;
</para>
</listitem>
<listitem>
<para>
Documentation download size: &zsh-doc-size;
</para>
</listitem>
</itemizedlist>
<note>
<para>
When there is a new <application>zsh</application> release, the old
@ -114,11 +94,11 @@
<title>Installation of zsh</title>
<para>
If you downloaded the optional documentation, unpack it with
the following command:
Adapt the documentation build system for texinfo-7.0 or later:
</para>
<screen><userinput>tar --strip-components=1 -xvf ../zsh-&zsh-version;-doc.tar.xz</userinput></screen>
<screen><userinput>sed -e 's/set_from_init_file/texinfo_&amp;/' \
-i Doc/Makefile.in</userinput></screen>
<!-- <note>
<para>
@ -137,12 +117,12 @@
--sysconfdir=/etc/zsh \
--enable-etcdir=/etc/zsh \
--enable-cap \
--enable-gdbm &amp;&amp;
make &amp;&amp;
--enable-gdbm &amp;&amp;
make &amp;&amp;
makeinfo Doc/zsh.texi --plaintext -o Doc/zsh.txt &amp;&amp;
makeinfo Doc/zsh.texi --html -o Doc/html &amp;&amp;
makeinfo Doc/zsh.texi --html --no-split --no-headers -o Doc/zsh.html</userinput></screen>
makeinfo Doc/zsh.texi --html -o Doc/html &amp;&amp;
makeinfo Doc/zsh.texi --plaintext -o zsh.txt &amp;&amp;
makeinfo Doc/zsh.texi --html --no-split --no-headers -o zsh.html</userinput></screen>
<para>
If you have <xref linkend="texlive"/>
@ -160,21 +140,10 @@ makeinfo Doc/zsh.texi --html --no-split --no-headers -o Doc/zsh.html</userinput
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>make install &amp;&amp;
make infodir=/usr/share/info install.info &amp;&amp;
install -v -m755 -d /usr/share/doc/zsh-&zsh-version;/html &amp;&amp;
install -v -m644 Doc/html/* /usr/share/doc/zsh-&zsh-version;/html &amp;&amp;
install -v -m644 Doc/zsh.{html,txt} /usr/share/doc/zsh-&zsh-version;</userinput></screen>
<para>
If you downloaded the optional documentation, install it by issuing
the following commands as the
<systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>make htmldir=/usr/share/doc/zsh-&zsh-version;/html install.html &amp;&amp;
install -v -m644 Doc/zsh.dvi /usr/share/doc/zsh-&zsh-version;</userinput></screen>
<screen role="root"><userinput>make install &amp;&amp;
make infodir=/usr/share/info install.info &amp;&amp;
make htmldir=/usr/share/doc/zsh-&zsh-version;/html install.html &amp;&amp;
install -v -m644 zsh.{html,txt} Etc/FAQ /usr/share/doc/zsh-&zsh-version;</userinput></screen>
<para>
If you built the PDF format of the documentation, install