[sdk/kdesrc-build/docbook_historied_per_file] doc: finish the getting started chapter

Carlos Leonhard Woelz null at kde.org
Fri May 10 10:14:25 BST 2024


Git commit 532f0474ceaec4c5a309d09cbfdd42a4c76236d8 by Carlos Leonhard Woelz.
Committed on 18/05/2005 at 12:38.
Pushed by ashark into branch 'docbook_historied_per_file'.

finish the getting started chapter

svn path=/trunk/KDE/kdesdk/doc/scripts/kdesvn-build/; revision=415352

Original commit: 84d6223d
https://invent.kde.org/sdk/kdesrc-build/-/commit/84d6223d942fb93a0b5877bf9ea38b59b668daca

M  +1    -1    doc/cmdline/index.docbook
M  +2    -2    doc/getting-started/before-building.docbook
M  +21   -1    doc/getting-started/building-and-troubleshooting.docbook
M  +27   -1    doc/getting-started/configure-data.docbook
M  +94   -1    doc/getting-started/environment.docbook
M  +2    -2    doc/kdesvn-buildrc/index.docbook

https://invent.kde.org/sdk/kdesrc-build/-/commit/532f0474ceaec4c5a309d09cbfdd42a4c76236d8

diff --git a/doc/cmdline/index.docbook b/doc/cmdline/index.docbook
index 19b9e2fd..ec76c202 100644
--- a/doc/cmdline/index.docbook
+++ b/doc/cmdline/index.docbook
@@ -9,7 +9,7 @@ linkend="conf-set-env">set-env</link> option.</para>
 
 <itemizedlist>
 
-<listitem id="cmdline-help"><para><option>--help</option>,= only display simple help on this script.</para></listitem>
+<listitem id="cmdline-help"><para><option>--help</option>, only display simple help on this script.</para></listitem>
 
 <listitem id="cmdline-version"><para><option>--version</option>, display the program version.</para></listitem>
 
diff --git a/doc/getting-started/before-building.docbook b/doc/getting-started/before-building.docbook
index e6023782..3c1834ba 100644
--- a/doc/getting-started/before-building.docbook
+++ b/doc/getting-started/before-building.docbook
@@ -19,7 +19,7 @@ You need the Qt library, version 3.3.0 or greater, Automake 1.8,
 Autoconf 2.5X (better if >=2.57 as a bug was reported with lower versions),
 the subversion (svn) client, the gcc compiler with C++ support, libxml2,
 openssl, libbz2, and many more (for a complete list, visit the
-<ulink url="http://www.kde.org/info/requirements/3.4.php">KDE 3.4 Compilation
+<ulink url="http://www.kde.org/info/requirements/3.4.php">KDE Compilation
 Requirements</ulink>). You can usually get those tools packaged for your system
 from your distribution or vendor.
 </para>
@@ -56,7 +56,7 @@ You will see a list of the files available in the kdesdk/scripts directory in
 the &kde; &svn; repository. Click the &kdesvn-build; link and download
 the latest version of the script. Do the same for the
 <filename>kdesvn-buildrc-sample</filename> file.
-
+Make the script executable, and be sure it is in your path.
 </para>
 
 
diff --git a/doc/getting-started/building-and-troubleshooting.docbook b/doc/getting-started/building-and-troubleshooting.docbook
index e4a901fc..f9825851 100644
--- a/doc/getting-started/building-and-troubleshooting.docbook
+++ b/doc/getting-started/building-and-troubleshooting.docbook
@@ -1,6 +1,26 @@
 <sect1 id="building-and-troubleshooting">
 <title>Using the &kdesvn-build; script</title>
 
-<para>Bla Bla.</para>
+<para>Now you are ready to run the script. From a terminal window,
+log in to the user you are using to compile &kde; and execute
+the script:
+<screen>
+<prompt /><command>su</command> <option>-</option> <replaceable>devel-username</replaceable>
+<prompt /><command>kdesvn-build</command>
+</screen>
+</para>
+
+<para>
+Now, the script should start downloading the sources and compiling them. It is
+unlikely that you will succeed in the first time you compile &kde;. Do not despair!
+Check the log files to see if you are missing some tools or development  packages
+(the location of the log files is set by the log-dir variable in the configuration
+file). Sometimes, the main development branch get very unstable and hard to build,
+especially whwn a development freeze is close. Be patient. 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://quality.kde.org/develop/cvsguide/buildstep.php#step1">
+Building &kde; from Source Step by Step Guide</ulink>.
+</para>
 
 </sect1>
diff --git a/doc/getting-started/configure-data.docbook b/doc/getting-started/configure-data.docbook
index 2f6da633..eb34f3f9 100644
--- a/doc/getting-started/configure-data.docbook
+++ b/doc/getting-started/configure-data.docbook
@@ -1,7 +1,33 @@
 <sect1 id="configure-data">
 <title>Setting the Configuration Data</title>
 
-<para>Bla Bla.</para>
+<para>
+To use the script, you must have a file in your home directory called
+<filename>.kdesvn-buildrc</filename>, which sets the general options and sets the modules
+you would like to download and build.
+</para>
 
+<para>
+Use the <filename>kdesvn-buildrc-sample</filename> file as a
+template, setting global options, and the modules you want to build.
+Pay close attention to the kdedir and qtdir global variables, as the first sets
+where your &kde; build is going to be installed, (by default to
+<filename>~/kde</filename>), and the second where (and if) your qt library is
+going to be built and installed, (by default to
+<filename>~/kdesvn/build/qt-copy</filename>). You will need to know the
+kdedir and qtdir location later, to set up the environment variables
+that are necessary to run your new installation.
+Check if the listed modules are in fact the modules you want to build.
+The default options from the <filename>kdesvn-buildrc-sample</filename> file
+should be enough to get a fairly complete &kde; installation.
+Save the resulting as <filename>.kdesvn-buildrc</filename> in your home
+folder.
+</para>
+
+<para>
+If you wish to fine tune your <filename>.kdesvn-buildrc-sample</filename>,
+consult <xref linkend="kdesvn-buildrc" /> for detailed information
+about all configuration options.
+</para>
 
 </sect1>
diff --git a/doc/getting-started/environment.docbook b/doc/getting-started/environment.docbook
index 316f9966..76f9c303 100644
--- a/doc/getting-started/environment.docbook
+++ b/doc/getting-started/environment.docbook
@@ -1,6 +1,99 @@
 <sect1 id="environment">
 <title>Setting the Environment to Run Your Fresh &kde;</title>
 
-<para>Bla Bla.</para>
+<para>
+Assuming you are using a dedicated user to build &kde;, and you already have
+an installed &kde; version, running your new &kde; may be a bit tricky, as the new &kde;
+has to take precedence over the old. Change the environment variables to
+make sure it does.
+</para>
+
+<para>
+Open or create the <filename>.bash_profile</filename> file in the home directory with your favorite editor,
+and add to the end of the file:
+
+<programlisting>
+KDEDIR=(path to kdedir)
+KDEDIRS=$KDEDIR
+PATH=$KDEDIR/bin:$QTDIR/bin:$PATH
+LD_LIBRARY_PATH=$KDEDIR/lib:$LD_LIBRARY_PATH
+export KDEDIRS PATH LD_LIBRARY_PATH
+</programlisting>
+
+If you are building the qt-copy module, add instead:
+
+<programlisting>
+QTDIR=(path to qtdir)
+KDEDIR=(path to kdedir)
+KDEDIRS=$KDEDIR
+PATH=$KDEDIR/bin:$QTDIR/bin:$PATH
+MANPATH=$QTDIR/doc/man:$MANPATH
+LD_LIBRARY_PATH=$KDEDIR/lib:$QTDIR/lib:$LD_LIBRARY_PATH
+export QTDIR KDEDIRS PATH MANPATH LD_LIBRARY_PATH
+</programlisting>
+</para>
+
+<para>If you are not using a dedicated user, set a different <envar>$KDEHOME</envar> for your
+new environment in your <filename>.bash_profile</filename>:
+
+<programlisting>
+export KDEHOME="${HOME}/.kde-svn"
+
+# Create it if needed
+[ ! -e ~/.kde-svn ] && mkdir ~/.kde-svn
+</programlisting>
+</para>
+
+<note>
+<para>
+If later your menu is empty or too crowded with applications from your distribution,
+you may have to set the xdg environment variables in your <filename>.bash_profile</filename>:
+
+<programlisting>
+XDG_CONFIG_DIRS="${KDEDIR}/etc/xdg"
+XDG_DATA_DIRS="${KDEDIR}/share:/usr/share"
+export XDG_CONFIG_DIRS XDG_DATA_DIRS
+</programlisting>
+
+</para>
+</note>
+
+<para>Now that we are done with the you have to make sure that the right <application>startkde</application>
+script is going to be used:</para>
+
+<para>Open the <filename>.xinitrc</filename> text file (or <filename>.xsession</filename>,
+depending on the distribution) from the home directory, or create it if necessary. Add the
+line:
+
+<programlisting>
+exec /home/kdedev/kde-unstable/bin/startkde
+</programlisting>
+</para>
+
+<para>Now start your fresh &kde;: in  BSD and Linux systems with virtual terminal support,
+Ctrl+Alt+F1...F12 keystroke combinations are used to switch to Virtual Console 1 through 12.
+This allows you to run more than one desktop environment at the same time. The fist six are
+text terminals and the following six are graphical displays.</para>
+
+<para>If when you boot you are presented to the graphical display manager instead, you can
+use the new KDE environment, even if it is not listed as an option. Press Crtl + Alt + F2,
+and you will be presented to a text terminal. Log in using the dedicated user and type:</para>
+
+<screen>
+startx -- :1
+</screen>
+
+<tip>
+<para>
+You can run the KDE from sources and the old KDE at the same time! Log in using your regular user,
+start the stable KDE desktop. Press Crtl + Alt + F2 (or F1, F3, etc..), and you will be presented
+to a text terminal. Log in using the dedicated user and type "startx -- :1". You can go back to the
+regular user by pressing Crtl + Alt + F6 (Or F7, F8, etc... Try them out! One of them is the right
+one.) To return to KDE from sources, press Crtl + Alt + F7 (or F6, F8,etc..). Now you can switch
+between your KDE versions, and test the new one knowing you can quickly return to the safety of
+the stable KDE desktop.
+</para>
+</tip>
+
 
 </sect1>
diff --git a/doc/kdesvn-buildrc/index.docbook b/doc/kdesvn-buildrc/index.docbook
index 6e58ff2d..0c798238 100644
--- a/doc/kdesvn-buildrc/index.docbook
+++ b/doc/kdesvn-buildrc/index.docbook
@@ -2,8 +2,8 @@
 <title>The Format of .kdesvn-buildrc</title>
 
 <para>To use the script, you must have a file in your home directory called
-.kdesvn-buildrc, which describes the modules you would like to download and
-build.</para>
+<filename>.kdesvn-buildrc</filename>, which describes the modules you would
+like to download and build.</para>
 
 
 



More information about the kde-doc-english mailing list