[network/smb4k] doc: doc: remove download/build instructions
Pino Toscano
null at kde.org
Sun Jun 28 08:16:58 BST 2020
Git commit bcb475a18e86777bf326a769f0401d3d7ac0c0a4 by Pino Toscano.
Committed on 28/06/2020 at 07:15.
Pushed by pino into branch 'master'.
doc: remove download/build instructions
They do not belong to an user-facing documentation, but rather to
separate download/build development pages.
See also:
https://mail.kde.org/pipermail/kde-doc-english/2015-May/012119.html
https://mail.kde.org/pipermail/kde-doc-english/2015-May/012127.html
M +1 -129 doc/index.docbook
https://invent.kde.org/network/smb4k/commit/bcb475a18e86777bf326a769f0401d3d7ac0c0a4
diff --git a/doc/index.docbook b/doc/index.docbook
index 53b87622..9a155a59 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -3841,7 +3841,7 @@ ntlm auth = yes
<listitem><para>Provide the version of &smb4k; and &kf5;.</para></listitem>
<listitem><para>Mention your operating system (&Linux;, FreeBSD, &etc;) and the distribution that is running on your computer.</para></listitem>
<listitem><para>Include the full error message if an error dialog was displayed.</para></listitem>
- <listitem><para>If you experienced a crash, attach a full backtrace. For this it is recommended that you (re-)compile &smb4k; with debugging symbols. How this is done is mentioned in the <link linkend="appendix_compilation">Configuration, Compilation and Installation</link> chapter in the appendix.</para></listitem>
+ <listitem><para>If you experienced a crash, attach a full backtrace. For this it is recommended that you (re-)compile &smb4k; with debugging symbols. How this is done is mentioned in the <filename>README</filename> file shipped in the sources.</para></listitem>
<listitem><para>Add additional data, ⪚ send a screen shot if you are reporting a &GUI; related problem.</para></listitem>
</itemizedlist>
<para>The recommended method to report a bug is to use the dialog that opens when you click the <menuchoice><guimenu>Help</guimenu><guimenuitem>Report Bug...</guimenuitem></menuchoice> menu item. But you can also go directly to the <ulink url="https://bugs.kde.org/enter_bug.cgi?product=Smb4k&format=guided">KDE Bugtracking System</ulink> and fill out the form.</para>
@@ -3883,132 +3883,4 @@ ntlm auth = yes
</chapter>
-<!--
- Appendix
- -->
-
-<appendix id="appendix">
- <title>Appendix</title>
-
- <sect1 id="appendix_getting_smb4k" >
- <title>How to obtain &smb4k;</title>
-
- <para>The latest stable release is available at <ulink url="https://sourceforge.net/projects/smb4k/files/">https://sourceforge.net/projects/smb4k/files/</ulink>.</para>
- </sect1>
-
- <sect1 id="appendix_requirements" >
- <title>Requirements</title>
-
- <para>&smb4k; officially supports &Linux;, FreeBSD, NetBSD and DragonFly BSD. Other operating systems might work as well, but haven't been tested.</para>
- <para>To compile &smb4k;, you need:</para>
- <itemizedlist>
- <listitem><para><ulink url="https://www.cmake.org">CMake</ulink> (≥ 3.2)</para></listitem>
- <listitem><para><ulink url="https://gcc.gnu.org">GNU Compiler Collection</ulink> (g++ ≥ 5.0) or <ulink url="https://clang.llvm.org">clang/LLVM</ulink> (≥ 3.0)</para></listitem>
- </itemizedlist>
- <para>To be able to use the main application of &smb4k;, you need at least <ulink url="https://www.qt.io">&Qt;</ulink> version 5.9.0 and <ulink url="https://www.kde.org">&kf5;</ulink> version 5.44.0 to be installed.</para>
- <para>&smb4k; build depends on:</para>
- <itemizedlist>
- <listitem><para>QtCore, QtGui, QtWidgets, QtTest, QtNetwork, QtPrintSupport, QtQml</para></listitem>
- <listitem><para>KConfig, KAuth, KDocTools, KIconThemes, KWidgetsAddons, KI18n, KCompletion, KCoreAddons, &solid;, KIO, KNotifications, KXmlGui, KJobWidgets, &kwallet5;, KDBusAddons, KDNSSD, KConfigWidgets, KNotifications, KWindowSystem</para></listitem>
- <listitem><para>libsmbclient</para></listitem>
- </itemizedlist>
- <para>If you would like to enable WS-Discovery support (see also <link linkend="appendix_compilation">here</link>), you additionally need:</para>
- <itemizedlist>
- <listitem><para><ulink url="https://www.kdab.com/development-resources/qt-tools/kd-soap/">KDSoap</ulink> (version ≥ 1.9.0)</para></listitem>
- <listitem><para><ulink url="https://github.com/caspermeijn/kdsoap-ws-discovery-client">KDSoap WS-Discovery client</ulink> (version ≥ 0.2)</para></listitem>
- </itemizedlist>
- <para>&smb4k; runtime depends on:</para>
- <itemizedlist>
- <listitem><para>KPlasma</para></listitem>
- <listitem><para><ulink url="https://wiki.samba.org/index.php/LinuxCIFS_utils">LinuxCIFS utils</ulink> (&Linux; only)</para></listitem>
- </itemizedlist>
- <para>To enable full functionality, you may also want to install these programs:</para>
- <itemizedlist>
- <listitem><para><ulink url="https://rsync.samba.org">rsync</ulink></para></listitem>
- </itemizedlist>
- <para>The full list of changes can be found in the Git log at <ulink url="https://invent.kde.org/networksmb4k.git">invent.kde.org</ulink>. A summary can be found in the <filename>ChangeLog</filename> file in the tarball.</para>
- </sect1>
-
-<!--
- Appendix: Configuration, Compilation and Installation
- -->
-
- <sect1 id="appendix_compilation">
- <title>Configuration, Compilation and Installation</title>
-
- <para>This section describes the configuration, compilation and installation of &smb4k;. Make sure, you have read the <link linkend="appendix_requirements">Requirements</link> section before you start.</para>
- <para><ulink url="https://sourceforge.net/projects/smb4k/files">Download</ulink> the version of &smb4k; you are interested in and extract the source tarball:</para>
-
-<screen>
-<prompt>$</prompt> <userinput><command>tar</command> xvfJ smb4k-x.y.z.tar.xz</userinput>
-</screen>
-
- <para>Replace x.y.z with the version number. Change into the source code directory and create a <filename class="directory">build</filename> directory:</para>
-
-<screen>
-<prompt>$</prompt> <userinput><command>cd</command> <filename class="directory">smb4k-x.y.z</filename></userinput>
-<prompt>$</prompt> <userinput><command>mkdir</command> <filename class="directory">build</filename></userinput>
-</screen>
-
- <para>Change into the <filename class="directory">build</filename> directory and configure the source code:</para>
-
-<screen>
-<prompt>$</prompt> <userinput><command>cd</command> <filename class="directory">build</filename></userinput>
-<prompt>$</prompt> <userinput><command>cmake</command> -DCMAKE_INSTALL_PREFIX=`qtpaths --install-prefix` -DCMAKE_BUILD_TYPE=Release <filename class="directory">..</filename></userinput>
-</screen>
-
- <para>If &smb4k; cannot find some shared libraries after the installation (⪚ if you are using Kubuntu 16.04), it may be necessary to add the <option>-DKDE_INSTALL_PLUGINDIR</option> argument to the command line above:</para>
-
-<screen>
-<prompt>$</prompt> <userinput><command>cd</command> <filename class="directory">build</filename></userinput>
-<prompt>$</prompt> <userinput><command>cmake</command> -DCMAKE_INSTALL_PREFIX=`qtpaths --install-prefix` \
- -DKDE_INSTALL_PLUGINDIR=`qtpaths --plugin-dir` -DCMAKE_BUILD_TYPE=Release <filename class="directory">..</filename></userinput>
-</screen>
-
- <para>If you want to compile &smb4k; with debug symbols, replace Release by Debug. You should consider this if you experience &ie; a crash and want to either debug &smb4k; yourself or report a bug including a full backtrace.</para>
- <para>There are also some &smb4k; specific arguments you might be interested in:</para>
- <para>
- <informaltable frame="all">
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry>Argument</entry>
- <entry>Since</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>-DINSTALL_HEADER_FILES=ON|OFF</entry>
- <entry align="center">1.0.0</entry>
- <entry>Install the core header files. This is off by default.</entry>
- </row>
- <row>
- <entry>-DINSTALL_PLASMOID=ON|OFF</entry>
- <entry align="center">1.1.0</entry>
- <entry>Install the plasmoid. This is on by default.</entry>
- </row>
- <row>
- <entry>-DWITH_WS_DISCOVERY=ON|OFF</entry>
- <entry align="center">3.1.0</entry>
- <entry>Build with WS-Discovery support for browsing. This is off by default.</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
- <para>After the configuration, compile and install &smb4k;:</para>
-
-<screen>
-<prompt>$</prompt> <userinput><command>make</command> && <command>sudo make</command> install</userinput>
-</screen>
-
- <para>If you want to be able to remove &smb4k; with your package manager later on, use <application>checkinstall</application> instead of <command>make install</command>. The package should be present in your distribution's repository. Run:</para>
-
-<screen>
-<prompt>$</prompt> <userinput><command>make</command> && <command>sudo checkinstall</command></userinput>
-</screen>
-
- </sect1>
-</appendix>
</book>
More information about the kde-doc-english
mailing list