[kmymoney/5.0] doc: doc: drop almost all bits related to installation
Pino Toscano
null at kde.org
Thu May 9 20:46:30 BST 2019
Git commit 6bffb7d0d9b68ad97130ed167d6174efd43811e5 by Pino Toscano.
Committed on 09/05/2019 at 19:46.
Pushed by pino into branch '5.0'.
doc: drop almost all bits related to installation
Summary:
In the majority of the cases, users install kmymoney as available in
their distribution, and thus most of this content is not useful; users
that want to compile kmymoney from sources find already instructions on
kmymoney.org, in the development wikis, and in the in-source files, so
no need to duplicate them in a user-taylored documentation.
Furthermore, the current building instructions are outdated, and an
updated version, together with any FAQ related to building from sources
and developing on kmymoney, belongs to online resources (easier to keep
up-to-date).
Test Plan:
- build the documentation
- verify the mentioned bits are not present
Reviewers: ostroffjh
Reviewed By: ostroffjh
Subscribers: tbaumgart, #kmymoney, kde-doc-english
Tags: #documentation
Differential Revision: https://phabricator.kde.org/D20389
M +3 -86 doc/faq.docbook
M +0 -2 doc/index.docbook
D +0 -217 doc/installation.docbook
M +0 -1 doc/whatsnew.docbook
https://commits.kde.org/kmymoney/6bffb7d0d9b68ad97130ed167d6174efd43811e5
diff --git a/doc/faq.docbook b/doc/faq.docbook
index bdb311180..be88e26f6 100644
--- a/doc/faq.docbook
+++ b/doc/faq.docbook
@@ -37,87 +37,10 @@
didn't you?)</para>
<para>If &kmymoney; crashes on startup without trying to load a data file,
there may be a problem with your installation. See the section on <link
- linkend="installation">installing &kmymoney;</link> or the section on <link
linkend="firsttime.contact">getting help</link>.</para>
</answer>
</qandaentry>
-<qandaentry>
- <question>
- <para>When I start KMyMoney I get a "Malformed URL" error. What's
- wrong?</para>
- </question>
- <answer>
- <para>Usually the reason for this is that you didn't run 'make install' as
- root. This step actually copies all of the icons, and other files needed by
- KMyMoney to run properly. If you did run this, make sure you passed the
- correct prefix to cmake at the beginning of your compile. See the section on
- <link linkend="installation.fromsource">compiling from source</link> for more
- information.</para>
- </answer>
-</qandaentry>
-
-<qandaentry>
- <question>
- <para>When I compile from source, all the icons show up as missing. What
- did I do wrong?</para>
- </question>
- <answer>
- <para>Usually the reason for this is that you didn't run 'make install' as
- root. See the previous question/answer for more information.</para>
- </answer>
-</qandaentry>
-
-<qandaentry>
- <question>
- <para>What options are useful to pass to cmake?</para>
- </question>
- <answer>
- <para>The most important option is -DCMAKE_INSTALL_PREFIX. This specifies
- where you want to install KMyMoney; it should be the same location where
- &kde; is installed. In many distributions, cmake will find this location on
- its own, but if it can't, you can use the command line tool
- <command>kde4-config --prefix</command> to read out what the prefix should
- be. For &RedHat;-based distributions, including Mandriva and Fedora, &kde; is
- installed in <filename role="directory">/usr</filename>.</para>
- <para>Another useful option is -DCMAKE_BUILD_TYPE. Normally this is not set,
- but if it is set to Debug, it will allow you to build KMyMoney with debug
- symbols, which help in trying to figure out crashes. This option is essential
- if you are a developer and want to contribute.</para>
- </answer>
-</qandaentry>
-
-<qandaentry>
- <question>
- <para>The Git version is broken! What do I do now?</para>
- </question>
- <answer>
- <para>Usually the reason for this is that one of the developers made a change
- to the code that requires a clean reconfigure. See the end of the section on
- <link linkend="installation.fromsource">compiling from source</link> for
- instructions. If you follow these steps carefully, and still have a problem
- compiling, please post a message to the &kmymoney; Developers List at
- &devlist;, and include the failed output of either the cmake or
- make command.
-</para>
- </answer>
-</qandaentry>
-
-<qandaentry>
- <question>
- <para>I compiled from source, but the version number in the Help->About
- dialog no longer gets changed to show the latest git commit, like it used
- to?</para>
- </question>
- <answer>
- <para>You probably ran <command>$ make</command> without running <command>$
- cmake</command> or <command>$ ccmake</command> first. If you update the
- code, using <command>$ git pull</command>, one of those two commands is
- necessary to put the updated version number/git commit in the right place.
-</para>
- </answer>
-</qandaentry>
-
<qandaentry>
<question>
<para>Will &kmymoney; work on my X/&ubuntu; desktop? Will &kmymoney; work
@@ -126,15 +49,9 @@
<answer>
<para>Yes, &kmymoney; will work without a full &kde; desktop, but you will
have to install the basic &kde; libraries first. The easiest way to do this
- is to use <link linkend="installation.distribution">your distribution's
- package management system</link>, which will handle these requirements
- automatically. If you are going to install from source, you will probably
- need development versions of those libraries; refer to these <link
- linkend="installation.fromsource">instructions</link> for details.</para>
- <para>There has been at least one report of an error message about a
- &kmymoney; process which did not come from any &kmymoney; or &kde;
- source. This is not necessarily bad, but it can be very difficult to
- determine the actual cause.</para>
+ is to use your distribution's package management system, which will handle
+ these requirements automatically. If you are going to install from source,
+ you will probably need development versions of those libraries.</para>
</answer>
</qandaentry>
diff --git a/doc/index.docbook b/doc/index.docbook
index f2670994e..5b91f394d 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -99,7 +99,6 @@
<!ENTITY faq SYSTEM "faq.docbook">
<!ENTITY reference SYSTEM "reference.docbook">
<!ENTITY credits SYSTEM "credits.docbook">
- <!ENTITY installation SYSTEM "installation.docbook">
]>
<book id="kmymoney" lang="&language;">
@@ -214,7 +213,6 @@ consistent documentation style across all KDE apps. -->
&faq;
&reference;
&credits;
-&installation;
&documentation.index;
</book>
<!--
diff --git a/doc/installation.docbook b/doc/installation.docbook
deleted file mode 100644
index 7f903ef94..000000000
--- a/doc/installation.docbook
+++ /dev/null
@@ -1,217 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<appendix id="installation">
-<appendixinfo>
- <authorgroup>
- <author>&Jack.H.Ostroff; &Jack.H.Ostroff.mail;</author>
- </authorgroup>
- <date>2014-08-30</date>
- <releaseinfo>4.7.01</releaseinfo>
-</appendixinfo>
-
-<title>Installation</title>
-
-<para>
- This appendix primarily addresses the installation of &kmymoney; under the
- &Linux; operating system. The <link linkend="installation.nonlinux">final
- section</link> addresses other operating systems.
-</para>
-
-<sect1 id="installation.getting">
-<title>How to obtain &kmymoney;</title>
-
-<para>
- &kmymoney; has existed for a number of years, and we have worked very hard on
- full integration into &kde;. The earliest stable versions (1.0.x) required
- libraries from &kde; 3, and so were not available in many Linux distributions,
- which had already migrated to &kde; 4. However, with the release of version
- 4.5 in August 2010, &kmymoney; could be easily compiled and installed on any
- version of &kde; 4.3 or higher. The current version, 4.7, requires &kde; 4.6,
- specifically kdelibs and kdepimlibs.
-</para>
-
-<para>
- Although work has begun porting &kmymoney; to the new &kf5-full;, this is
- still very early, and not yet usable. Hopefully it will be available in the
- 5.0 version, which we expect to release in early 2015. Until then, if you are
- specifically interested in following this work, you should subscribe to the
- developers mailing list &devlist;.
-</para>
-
-<para>
- The rest of this section will describe installing &kmymoney; using the
- standard software installation process for your Linux distribution. The
- following section will discuss compiling from source.
-</para>
-
-<sect2 id="installation.distribution">
-<title>Official Distribution Packages</title>
-<para>
- The best way to install &kmymoney; is to use the package manager of your
- distribution, such as apt-get, yum, portage, or pacman. This will take care
- of all the dependencies and required libraries. Although it takes some time
- after the release a new version of &kmymoney; for all the distributions to add
- it to their official repositories, please check there first.
-</para>
-</sect2>
-
-<sect2 id="installation.unsupported">
-<title>Unsupported Repositories</title>
-<para>
- Many Linux distributions have users who provide unsupported repositories that
- offer more up-to-date packages than the distributions' official repositories.
- A list of these may be found at the <ulink
- url="http://www.kmymoney.org">&kmymoney; home page</ulink>.
-</para>
-</sect2>
-</sect1>
-
-<sect1 id="installation.fromsource">
-<title>Compiling &kmymoney; from Source</title>
-
-<para>
- More up-to-date information on the latest available version and any known
- installation issues will be available on the <ulink
- url="http://www.kmymoney.org">&kmymoney; home page</ulink>. That page will
- also have links to tarballs of recent versions as well as instructions for
- obtaining the source from &kde; &git;, in case you want to compile the latest,
- development version.
-</para>
-
-<para>
- As the previous paragraph implied, there are two distinct reasons to compile
- &kmymoney; from source. If you cannot find a version specifically packaged
- for your distribution, please download the tarball of the most recent stable
- release. This is version 4.6.0 as of the time this is being written. This is
- the compile option recommended for normal users.
-</para>
-
-<para>
- On the other hand, if you want to see the current state of development, to
- check out a recent bug fix or new feature, you can download a tarball which is
- a snapshot of the development repository. You can also check the source
- directly out of the repository. The version 4.x source is in &kde; &git;. (The
- version 1.0.x source was in SourceForge cvs, but it is no longer being
- developed or supported at all.) Instructions for access are on the project
- home page.
-</para>
-
-<warning>
- <para>
- The code in the &git; repository and in development snapshots is under active
- development: it may have bugs, it may crash, and it may mess up or lose data.
- If you use it, be absolutely sure to make adequate backups. Unless you have
- a good reason to use this, stick to a stable released version.
- </para>
-</warning>
-
-<sect2><title>Required libraries</title>
-<para>
- &kmymoney; depends on certain libraries in order to compile and run
- properly. First is KDE version 4.3.5 or later, specifically kdelibs and
- kdepimlibs. Depending on your distribution, you may need to explicitly load
- the <quote>-devel</quote> versions in order to compile &kmymoney;, rather
- than just running a pre-compiled version. As of version 4.6.0, &kmymoney;
- also depends on libalkimia, version 4.3.1 or higher. Additional
- requirements may be detected during the <quote>cmake</quote> step below.
-</para>
-
-<para>
- Additional functionality can be obtained if extra libraries are available at
- compile time. The two most common are
-</para>
-
-<itemizedlist>
-<listitem>
- <para>libofx, version 0.9.4 or higher, to be able to import financial data
- in the OFX format, and</para>
-</listitem>
-
-<listitem>
- <para>AqBanking, version 5.0.0 or higher, to be able to use certain on-line
- banking features. Note that version 5.0.14 or higher is strongly
- recommended, due to bugs in earlier versions.</para>
-</listitem>
-</itemizedlist>
-</sect2>
-
-<sect2><title>Build instructions</title>
-<para>
- &kmymoney; uses the cmake build system. Further information can be found in
- the README.cmake file in the root folder of the source. The basic steps are
- the following:
-</para>
-
-<simplelist>
-<member><command>$ mkdir build</command></member>
-<member><command>$ cd build</command></member>
-<member><command>$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr/</command></member>
-<member><command>$ make</command></member>
-<member><command>$ sudo make install/fast</command></member>
-</simplelist>
-
-<important><para>
- Note that the last step is required. &kmymoney; expects to find certain
- components in standard locations, and if you run it from within the build
- directory without the install step, you will have missing icons or other
- surprises.
-</para></important>
-
-<para>
- If you have compiled the source from &git;, and want to update to the latest
- revision, most of the time you can do the following:
-</para>
-
-<simplelist>
-<member><command>$ cd <path to root of source></command></member>
-<member><command>$ git pull --rebase</command></member>
-<member><command>$ cd build</command></member>
-<member><command>$ make</command></member>
-<member><command>$ sudo make install/fast</command></member>
-</simplelist>
-
-<para>
- However, changes made by the developers sometimes cause compile problems if
- you do not start with a clean code base. In these cases, you need to do the
- following:
-</para>
-
-<simplelist>
-<member><command>$ cd <path to root of source></command></member>
-<member><command>$ git pull --rebase</command></member>
-<member><command>$ rm -r build</command></member>
-<member><command>$ mkdir build</command></member>
-<member><command>$ cd build</command></member>
-<member><command>$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr/</command></member>
-<member><command>$ make</command></member>
-<member><command>$ sudo make install/fast</command></member>
-</simplelist>
-</sect2>
-</sect1>
-
-<sect1 id="installation.nonlinux">
-<title>Installing &kmymoney; without Linux</title>
-
-<para>
- &kmymoney; has been successfully compiled for &MacOS; X, and is available at
- the <ulink url="http://www.macports.com">MacPorts web site</ulink>.
-</para>
-<para>
- &kmymoney; is also available for &Windows;. This initiative is still a work
- in progress, but great improvements have been made in the past year. For more
- information about running &kde;, including &kmymoney; on &Windows; see the
- <ulink url="http://windows.kde.org">KDE on Windows Initiative</ulink> page.
- For a standalone installer that only installs &kmymoney; see the download link
- on the right of the <ulink url="http://www.kmymoney.org">&kmymoney; home
- page</ulink>. Note that the most recent version of this installer no longer
- works on &Windows; XP. At the time of this release, it was not known if this
- could be changed, as the issue was related to the tools used to build the
- application, not the application itself.
-</para>
-
-<para>
- If you know of &kmymoney; being successfully compiled and made available for
- any other operating system, please let us know, so we can spread the word.
-</para>
-
-</sect1>
-</appendix>
diff --git a/doc/whatsnew.docbook b/doc/whatsnew.docbook
index a4bd31de2..cdfa38b0c 100644
--- a/doc/whatsnew.docbook
+++ b/doc/whatsnew.docbook
@@ -107,7 +107,6 @@
<member><link linkend="details.database">Database</link></member>
<member><link linkend="faq">Questions and Answers</link></member>
<member><link linkend="reference.widgets">Reference: Widgets</link></member>
- <member><link linkend="installation">Installation</link></member>
</simplelist>
</entry>
</row>
More information about the kde-doc-english
mailing list