[kde-doc-english] [kdesrc-build] doc: Fix kdesrc-build docbook
Burkhard Lück
lueck at hube-lueck.de
Thu May 26 06:32:49 UTC 2016
Git commit 2d6f3c8a5208f91165c0b73de2633d3792686a83 by Burkhard Lück.
Committed on 26/05/2016 at 06:32.
Pushed by lueck into branch 'master'.
Fix kdesrc-build docbook
adapt header to doctools.git / src / templates
fix wrong + outdated links
use new repo address scheme
set date to 16.05
use http://code.qt.io/cgit/qt/ for Qt repo
add some fixme's where the docbook seems to be wrong or outdated
REVIEW:127820
M +33 -33 doc/index.docbook
M +3 -2 doc/man-kdesrc-build-setup.1.docbook
M +2 -1 doc/man-kdesrc-build.1.docbook
http://commits.kde.org/kdesrc-build/2d6f3c8a5208f91165c0b73de2633d3792686a83
diff --git a/doc/index.docbook b/doc/index.docbook
index 6a83d21..301a1e7 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -112,7 +112,7 @@
<legalnotice>&FDLNotice;</legalnotice>
<date>2016-05-02</date>
-<releaseinfo>16.05</releaseinfo>
+<releaseinfo>&kdesrc-build; 16.05</releaseinfo>
<abstract>
<para>&kdesrc-build; is a script which builds and installs &kde; software
@@ -222,9 +222,9 @@ the script.
<para>
All topics present in this chapter are covered with even more detail in the
-<ulink url="http://techbase.kde.org/Getting_Started/Build/KDE4">
-Building &kde; 4 from Source</ulink> article, at the
-<ulink url="http://techbase.kde.org/">&kde; TechBase site</ulink>.
+<ulink url="https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source">
+Build from Source</ulink> article, at the
+<ulink url="https://community.kde.org/">&kde; Community Wiki</ulink>.
If you are compiling &kde; for the first time, it is a good idea to read
it, or consult it as a reference source. You will find detailed information
about packaging tools and requirements, common compilation pitfalls and
@@ -264,8 +264,8 @@ in order to prepare and use the system installation correctly.
<para>Before using the &kdesrc-build; script (or any other building
strategy) you must install the development tools and libraries needed for &kde;.
The nearly complete list of required tools can be found from
-the <ulink url="http://techbase.kde.org/Getting_Started/Build/Requirements">KDE
-TechBase Build Requirements</ulink> page.
+the <ulink url="https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source#Install_required_devel_packages">&kde;
+Community Wiki Build Requirements</ulink> page.
</para>
<para>Here is a list of some of the things you will need:</para>
@@ -289,8 +289,8 @@ if you have it by running <userinput><command>svn
<listitem><para>You will need the <ulink url="http://gitscm.org/">Git
source control manager</ulink> installed as well, for &kde;'s <ulink
-url="http://projects.kde.org/">git-based projects.</ulink>
-.</para></listitem>
+url=" https://commits.kde.org/">git-based projects.
+</ulink></para></listitem>
<listitem><para>Although it is not required, the <ulink
url="http://bazaar.canonical.com/">Bazaar</ulink> source control manager is
@@ -301,7 +301,7 @@ build libdbusmenu-qt, you must have Bazaar installed.</para></listitem>
</itemizedlist></listitem>
-<listitem><para>You will need a full C++ development environment. GCC 4.6 or
+<listitem><para>You will need a full C++ development environment. GCC 4.6 or <!--FIXME update? -->
later is recommended.</para></listitem>
<listitem><para>Finally, you will need a <quote>make</quote> tool. GNU Make is
@@ -313,9 +313,9 @@ why it is required.</para></listitem>
</itemizedlist>
<note><para>Most operating system distributions include a method of easily
-installing required development tools. Consult the TechBase <ulink
-url="http://techbase.kde.org/Getting_Started/Build/KDE4">Getting Started</ulink>
-page's <quote>Required Packages from your Distribution</quote> section to see
+installing required development tools. Consult the Community Wiki page <ulink
+url="https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source#Install_required_devel_packages"
+>Required devel packages</ulink> to see
if these instructions are already available.</para></note>
<para>One exception to the required libraries is the &Qt; library.
@@ -355,8 +355,8 @@ and development packages. You will need at least the program or library
<emphasis>and</emphasis> its development package. The libraries you need will
change depending on the modules you intend to build, as each module has its own
requirements. The <ulink
-url="http://techbase.kde.org/Getting_Started/Build/KDE4#Required_packages_from_your_distribution">&kde;
-TechBase</ulink> has more details about the specific tools and techniques used
+url="https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source">&kde;
+Community wiki</ulink> has more details about the specific tools and techniques used
to install and find the required software.
</para></important>
@@ -488,8 +488,8 @@ source code.
<listitem><para><link linkend="conf-svn-server">svn-server</link>, which
selects what &url; to download the sources from. This is useful if you are a
-developer with a <ulink url="http://techbase.kde.org/Contribute/First_Steps_with_your_KDE_SVN_Account">&kde;
-&subversion; account</ulink>.</para></listitem>
+developer with a <ulink url="https://community.kde.org/Infrastructure/First_Steps_with_your_Contributor_Account">&kde;
+contributor account</ulink>.</para></listitem>
<listitem><para>You will probably want to select different modules to build, which
is described in <xref linkend="selecting-modules"/>.</para></listitem>
@@ -510,7 +510,7 @@ select the software modules that you want built.
</para>
<orderedlist>
-<listitem><para>At the lowest level comes Digia's &Qt; library, which is a
+<listitem><para>At the lowest level comes the &Qt; library, which is a
very powerful, cross-platform <quote>toolkit</quote> library. &kde; is based on
&Qt;, and some of the non-&kde; libraries required by &kde; are also based on
&Qt;. &kdesrc-build; can build &Qt;, or use the one already installed on your
@@ -522,9 +522,9 @@ system if it is a recent enough version.</para></listitem>
Platform. These libraries tended to get combined into a single
<literal>kdesupport</literal> module.</para>
-<note><para>As of &kde; Platform 4.6, many of the libraries in the kdesupport
-module are being migrated over to <ulink
-url="http://projects.kde.org/">git.kde.org</ulink>, although they are still not
+<note><para>As of &kde; Platform 4.6, many of the libraries in the kdesupport <!--FIXME this is outdated ->frameworks, workspace/Plasma, applications-->
+module are being migrated over to the <ulink
+url=" https://commits.kde.org/">&kde; git archive</ulink>, although they are still not
considered part of the Platform.</para></note>
</listitem>
@@ -564,8 +564,8 @@ full desktop environment is not provided by the Platform however.
modules are known as <quote>Extragear</quote>, and have module names
such as <literal>extragear/network</literal>. As with
<literal>kdesupport</literal>, some of these Extragear applications are
- migrating to <ulink
- url="http://projects.kde.org/">git.kde.org</ulink>.</para></listitem>
+ migrating to the <ulink
+ url=" https://commits.kde.org/">&kde; git archive</ulink>.</para></listitem>
</itemizedlist>
</listitem>
</orderedlist>
@@ -669,7 +669,7 @@ give module-sets a name (as shown in the example), which allows you to quickly
refer to the entire group of modules from the command line.</para>
<note><para>Module sets are used in supporting module downloads from
-the &kde; <ulink url="https://projects.kde.org/">projects.kde.org</ulink>
+the &kde; <ulink url="https://commits.kde.org/">&kde; git archive</ulink>
module database. See also <xref linkend="kde-projects-module-sets"/>.
</para></note>
@@ -711,7 +711,7 @@ appropriately. Among other things, &kdesrc-build; will:</para>
<itemizedlist>
<listitem><para>Download the latest module database from <ulink
-url="https://projects.kde.org/">projects.kde.org</ulink>.</para></listitem>
+url=" https://commits.kde.org/">&kde; git archive</ulink>.</para></listitem>
<listitem><para>Try to find a module with the name given in the module set's
<option>use-modules</option> setting.</para></listitem>
@@ -921,8 +921,8 @@ required first) in order to report the build failure.</para>
<para>You can find more common examples of things that can go wrong and their
solutions, as well as general tips and strategies to build &kde; in the
-<ulink url="http://techbase.kde.org/Getting_Started/Build/KDE4">
-Building &kde; 4 from Source</ulink>.
+<ulink url="https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source">
+Build from Source</ulink>.
</para>
<para>On the other hand, assuming everything went well, you should have a new
@@ -2179,7 +2179,7 @@ language.</para>
<para>To use this option, set it to a space-separated list of languages to
install. Each language has a language code associated with it, which you
can look up at this page: <ulink
-url="http://i18n.kde.org/teams/">http://i18n.kde.org/teams/</ulink>.
+url="http://l10n.kde.org/teams-list.php">http://l10n.kde.org/teams-list.php</ulink>.
</para>
<para>It is alright to choose only one language. By default, none are
@@ -2538,8 +2538,8 @@ anonymous repository.</para></note>
<entry><para>Use this option to download a specific release of a module.</para>
<para><emphasis>Note:</emphasis> The odds are very good that you <emphasis>do not
want</emphasis> to use this option. &kde; releases are available in tarball form
-from <ulink url="ftp://ftp.kde.org/">The &kde; FTP site</ulink> or one of <ulink
-url="http://download.kde.org/download.php">its mirrors</ulink>.</para>
+from the <ulink
+url="http://download.kde.org/">&kde; download site</ulink>.</para>
<note><para>This option has only been supported for git-based modules since
&kdesrc-build; 1.16.</para></note>
@@ -3430,7 +3430,7 @@ qt.</para>
<note><para>&Qt; is developed under a separate repository from &kde; software
located at <ulink
-url="http://qt.gitorious.org/qt">http://qt.gitorious.org/qt</ulink>.</para></note>
+url="http://code.qt.io/cgit/qt/">http://code.qt.io/cgit/qt/</ulink>.</para></note>
<para>In order to build &Qt;, you should make sure that the
<link linkend="conf-qtdir">qtdir</link> setting is set to the directory you'd
@@ -3653,7 +3653,7 @@ option for a module, which will specify a list of directories to download.
<tip><para>
If you do not already know what to download from a module, it may be a good idea
to browse the &subversion; layout for a module first, using
-<ulink url="http://websvn.kde.org/branches/KDE/4.6/">WebSVN</ulink>.
+<ulink url="http://websvn.kde.org/branches/KDE/4.6/">WebSVN</ulink>. <!--FIXME outdated-->
</para></tip>
<informalexample>
@@ -4263,7 +4263,7 @@ beat out several competitors and was selected to be the build system for &kde; 4
autotools-based system that &kde; has used from the beginning.</para>
<para>A introduction to &cmake; page is available on the <ulink
-url="http://techbase.kde.org/Development/Tutorials/CMake">&kde; TechBase</ulink>.
+url="https://community.kde.org/Guidelines_HOWTOs/CMake">&kde; Community Wiki</ulink>.
Basically, instead of running <userinput><command>make</command> <option>-f</option>
<filename>Makefile.cvs</filename></userinput>, then <command>configure</command>,
then &make;, we simply run &cmake; and then &make;.
@@ -4298,7 +4298,7 @@ as of &kdesrc-build; version 1.6.3.
<para>&kde; groups its software into <quote>modules</quote> of various size.
This was initially a loose grouping of a few large modules, but with the
introduction of the <ulink url="http://git-scm.com/">Git</ulink>-based <ulink
-url="https://projects.kde.org/">source code repositories</ulink>, these large
+url=" https://commits.kde.org/">source code repositories</ulink>, these large
modules were further split into many smaller modules.
</para>
diff --git a/doc/man-kdesrc-build-setup.1.docbook b/doc/man-kdesrc-build-setup.1.docbook
index e4b4c29..d583318 100644
--- a/doc/man-kdesrc-build-setup.1.docbook
+++ b/doc/man-kdesrc-build-setup.1.docbook
@@ -16,13 +16,14 @@
<refentry lang="&language;">
<refentryinfo>
-<title>&kde; User's Manual</title>
+<title>kdesrc-build-setup User's Manual</title>
<author>
<personname><firstname>Michael</firstname><surname>Pyne</surname></personname>
<email>mpyne at kde.org</email>
<personblurb><para>Authored man page</para></personblurb>
</author>
<date>2012-05-05</date>
+<releaseinfo>kdesrc-build-setup 16.05</releaseinfo>
</refentryinfo>
<refmeta>
@@ -92,7 +93,7 @@ location other than <filename>~/.kdesrc-buildrc</filename>.</para>
<para>
Either there was an I/O failure of some type (invalid permissions, disk
full, etc.), or the user canceled the program by pressing
- <keysym>ESC</keysym> during a dialog.
+ &Esc; during a dialog.
</para>
</listitem>
</varlistentry>
diff --git a/doc/man-kdesrc-build.1.docbook b/doc/man-kdesrc-build.1.docbook
index 27745cb..209baa6 100644
--- a/doc/man-kdesrc-build.1.docbook
+++ b/doc/man-kdesrc-build.1.docbook
@@ -16,13 +16,14 @@
<refentry lang="&language;">
<refentryinfo>
-<title>&kde; User's Manual</title>
+<title>kdesrc-build User's Manual</title>
<author>
<personname><firstname>Michael</firstname><surname>Pyne</surname></personname>
<email>mpyne at kde.org</email>
<personblurb><para>Authored man page</para></personblurb>
</author>
<date>2016-05-02</date>
+<releaseinfo>kdesrc-build 16.05</releaseinfo>
</refentryinfo>
<refmeta>
More information about the kde-doc-english
mailing list