Getting Started/Using Project Neon to contribute to KDE - Revision history

Yofel: mention the -all meta-packages

2012-11-24T19:04:51Z

mention the -all meta-packages

Agateau: /* Using Project Neon version of KDE Workspace */ project-neon-session -> project-neon-base

2012-11-20T14:54:01Z

‎Using Project Neon version of KDE Workspace: project-neon-session -> project-neon-base

Agateau: /* Installing Project Neon */ splitted "workspace" and "single-app" setup a bit more

2012-11-19T17:17:40Z

‎Installing Project Neon: splitted "workspace" and "single-app" setup a bit more

Agateau: /* Installing Project Neon */ Clarify where neon-env comes from (got bitten by that)

2012-11-19T16:36:20Z

‎Installing Project Neon: Clarify where neon-env comes from (got bitten by that)

Agateau: typos--

2012-11-19T16:07:24Z

typos--

Yofel: neon-env is in project-neon-utils, so people need to have that installed

2012-10-15T17:44:05Z

neon-env is in project-neon-utils, so people need to have that installed

Mechanical snail: Formatting; specify it's for ubuntu in the lead.

2012-09-11T05:35:05Z

Formatting; specify it's for ubuntu in the lead.

Yofel: as neon-env also runs kbuildsycoca4 it's really the preferred way of setting up the shell.

2012-07-26T12:18:11Z

as neon-env also runs kbuildsycoca4 it's really the preferred way of setting up the shell.

Skierpage: rephrase some obsolete mentions of SVN

2011-11-14T23:25:33Z

rephrase some obsolete mentions of SVN

Yofel: remove the confusing neon-env subshell warning.

2011-10-27T16:13:15Z

remove the confusing neon-env subshell warning.

← Older revision		Revision as of 19:04, 24 November 2012
Line 69:		Line 69:

	Note that settings for applications that you run from project neon do not conflict with your regular application settings and data. <tt>.project-neon-kde/</tt> is used instead of <tt>.kde/</tt>		Note that settings for applications that you run from project neon do not conflict with your regular application settings and data. <tt>.project-neon-kde/</tt> is used instead of <tt>.kde/</tt>
		+
		+	=== Installing everything ===
		+
		+	If you want to install all packages that are provided by Project Neon in one go, you can use the <tt>project-neon-all</tt> package which will install all provided packages. To install all debugging symbols (Warning: takes a lot of disk space) <tt>project-neon-all-dbg</tt> can be used.

	== Using Project Neon for development ==		== Using Project Neon for development ==

@@ Line 29: / Line 29: @@
 === Using Project Neon version of KDE Workspace ===
-To use Project Neon version of KDE Workspace, install the <tt>project-neon-session</tt> package. You can then log out, select the "Project Neon" session in KDM session list and log in.
+To use Project Neon version of KDE Workspace, install the <tt>project-neon-base</tt> package. You can then log out, select the "Project Neon" session in KDM session list and log in.
 <syntaxhighlight lang="bash">
-sudo apt-get install project-neon-session
+sudo apt-get install project-neon-base
 </syntaxhighlight>

@@ Line 25: / Line 25: @@
 After that, you can simply install the nightly package of whichever modules you want to work on. The packages are named project-neon-<git/svn module name>. The packages are installed in /opt/project-neon/ and won't affect your stable KDE install.
-You can install all of the packages or just the ones you are interested in, depending on what you want to use them for. For example if you want to install the KDE Workspace with the extra plasmoids, you would install the <tt>project-neon-kdeplasma-addons</tt> and <tt>project-neon-session</tt> so you get KDM support for Project Neon.
+You can install all of the packages or just the ones you are interested in, depending on what you want to use them for.
 <syntaxhighlight lang="bash">
-sudo apt-get install project-neon-kdeplasma-addons project-neon-session
+sudo apt-get install project-neon-session
 </syntaxhighlight>
 If you are only interested in application development in another module, you can install just the module package.
-First install <tt>project-neon-utils</tt>. This package installs a number of utilities, among which <tt>neon-env</tt>, which is needed to run Project Neon applications:
+First install <tt>project-neon-utils</tt>. This package contains a number of utilities among which <tt>neon-env</tt>, which is needed to run Project Neon applications:
 <syntaxhighlight lang="bash">

@@ Line 32: / Line 32: @@
 If you are only interested in application development in another module, you can install just the module package.
 <syntaxhighlight lang="bash">
-sudo apt-get install project-neon-kdepim project-neon-utils
+sudo apt-get install project-neon-kdepim
 </syntaxhighlight>
-That command will also install the <tt>kdelibs</tt>, <tt>kdepimlibs</tt> and other dependencies too. In your regular (stable) KDE session you can then run the nightly version of your chosen application after setting up the environment.
+That command will also install the <tt>kdelibs</tt>, <tt>kdepimlibs</tt> and other dependencies too. In your regular (stable) KDE session you can now set up Project Neon environment and run the nightly version of your chosen application.
 <syntaxhighlight lang="bash">

@@ Line 23: / Line 23: @@
 </pre>
-After that, you can simply install the nightly package of whichever modules you want to work on. The Packages are named project-neon-<git/svn module name>. The packages are installed in /opt/project-neon/ and won't affect your stable KDE install.
+After that, you can simply install the nightly package of whichever modules you want to work on. The packages are named project-neon-<git/svn module name>. The packages are installed in /opt/project-neon/ and won't affect your stable KDE install.
 You can install all of the packages or just the ones you are interested in, depending on what you want to use them for. For example if you want to install the KDE Workspace with the extra plasmoids, you would install the <tt>project-neon-kdeplasma-addons</tt> and <tt>project-neon-session</tt> so you get KDM support for Project Neon.
@@ Line 60: / Line 60: @@
 * <tt>neonmake</tt> - convenience script which will create a build folder, configure the source, build it and install it in /opt/project-neon/ so you can test your changes.
 * <tt>neon-clean</tt> - script that resets any changes you made to /opt/project-neon after installing the packages. Since this script reinstalls the packages it might require a working internet connection.
-* <tt>neonbuild</tt> - pbuilder/pdebuild wrapper to rebuild a neon package in a chroot. Takes the same options as pbuilder. If no pbuidler action is given pdebuild is run instead.
+* <tt>neonbuild</tt> - pbuilder/pdebuild wrapper to rebuild a neon package in a chroot. Takes the same options as pbuilder. If no pbuilder action is given pdebuild is run instead.
 === Options for cmake/make ===
@@ Line 70: / Line 70: @@
 === Debugging symbols ===
-The debugging symbols for every package are in it's corresponding <code>-dbg</code> package, so to install the debugging symbols for kdelibs you can use
+The debugging symbols for every package are in its corresponding <code>-dbg</code> package, so to install the debugging symbols for kdelibs you can use
 <syntaxhighlight lang="bash">
 sudo apt-get install project-neon-kdelibs-dbg
 </syntaxhighlight>
-If you are already using a nightly package of the module you want to develop for, you should remove that, and checkout the development version. For example:
+If you are already using a nightly package of the module you want to develop for, you should remove that and checkout the development version. For example:
 <pre>
@@ Line 133: / Line 133: @@
 </syntaxhighlight>
-exit the shell to reset the settings.
+Exit the shell to reset the settings.
 == Using Project Neon for documentation ==

@@ Line 1: / Line 1: @@
-[https://launchpad.net/project-neon Project Neon] is a nightly build of the latest KDE trunk. It is an easy way for new contributors to KDE to get started without having to download and build the entire KDE source code tree. Additionally, dependencies are automatically handled and updated. This is suitable for new developers, translators, usability designers, documenters, promoters, bug triagers etc. This process makes the steps detailed on [[Getting_Started/Build|this page]].
+[https://launchpad.net/project-neon Project Neon] is a nightly build of the latest KDE trunk for Ubuntu. It is an easy way for new contributors to KDE to get started without having to download and build the entire KDE source code tree. Additionally, dependencies are automatically handled and updated. This is suitable for new developers, translators, usability designers, documenters, promoters, bug triagers, etc. This process makes the steps detailed on [[Getting_Started/Build|this page]].
 However, for developers, it may at some point become necessary to build more components from source code as you become more involved in the project. The [[Getting_Started/Build/kdesrc-build|kdesrc-build]] script is an easy way to build all or parts of KDE from its source code repositories.
@@ Line 5: / Line 5: @@
 == Requirements ==
-Project neon always requires the latest stable Kubuntu release or development release. Previous versions of Kubuntu are not supported.
+Project Neon always requires either the latest stable Kubuntu release or the development release. Previous versions of Kubuntu are not supported.
 == Installing Project Neon ==
@@ Line 56: / Line 56: @@
 NOTE: both neon-cmake and neonmake require neon-env to be run first!
-<tt>neon-env</tt> -
+* <tt>neon-env</tt> - sets up the necessary environment settings for project neon builds and opens a subshell.
-sets up the necessary environment settings for project neon builds and opens a subshell.
+* <tt>neon-cmake</tt> - cmake wrapper with neon environment settings for cmake, same synopsis as cmake and passes arguments to cmake
+* <tt>neonmake</tt> - convenience script which will create a build folder, configure the source, build it and install it in /opt/project-neon/ so you can test your changes.
-<tt>neon-cmake</tt> -
+* <tt>neon-clean</tt> - script that resets any changes you made to /opt/project-neon after installing the packages. Since this script reinstalls the packages it might require a working internet connection.
-cmake wrapper with neon environment settings for cmake, same synopsis as cmake and passes arguments to cmake
+* <tt>neonbuild</tt> - pbuilder/pdebuild wrapper to rebuild a neon package in a chroot. Takes the same options as pbuilder. If no pbuidler action is given pdebuild is run instead.
-−
 <tt>neonmake</tt> -
 convenience script which will create a build folder, configure the source, build it and install it in /opt/project-neon/ so you can test your changes.
-−
 <tt>neon-clean</tt> -
-This script will reset all changes you did to /opt/project-neon after installing the packages. Since this script reinstalls the packages it might require a working internet connection.
-−
 <tt>neonbuild</tt> -
 pbuilder/pdebuild wrapper to rebuild a neon package in a chroot. Takes the same options as pbuilder. If no pbuidler action is given pdebuild is run instead.
-−
 You can change the cmake and make options used by setting these variables in ~/.neonrc:
-<tt>NEON_CMAKE_OPTS=""</tt> Here you can add additional cmake options that should be used together with the default neon options.
+* <tt>NEON_CMAKE_OPTS=""</tt> - Here you can add additional cmake options that should be used together with the default neon options.
+* <tt>NEON_CMAKE_OVERRIDE=""</tt> - If you set this variable cmake will ignore the default neon options and only use the ones in NEON_CMAKE_OVERRIDE.
-<tt>NEON_CMAKE_OVERRIDE=""</tt> If you set this variable cmake will ignore the default neon options and only use the ones in NEON_CMAKE_OVERRIDE.
+* <tt>NEON_MAKE_OVERRIDE=""</tt> - If you set this variable make in neonmake will only use your options. By default make uses '-j CPUs+1'
-−
 <tt>NEON_MAKE_OVERRIDE=""</tt> If you set this variable make in neonmake will only use your options. By default make uses '-j CPUs+1'
-−
-−
-Debugging Symbols:
+=== Debugging symbols ===
-The debugging symbols for every package are in it's corresponding -dbg package, so to install the debugging symbols for kdelibs you can use
+The debugging symbols for every package are in it's corresponding <code>-dbg</code> package, so to install the debugging symbols for kdelibs you can use
 <syntaxhighlight lang="bash">
 sudo apt-get install project-neon-kdelibs-dbg

@@ Line 40: / Line 40: @@
 <syntaxhighlight lang="bash">
-. /opt/project-neon/share/project-neon/environment.rc
+neon-env
 kmail
 </syntaxhighlight>
-Instead of sourcing the settings by hand every time, you could add this to your .bashrc:
+<tt>neon-env</tt> will setup the environment and start a subshell from which you can work with your project neon installation.
+This will correctly use the nightly version of libraries instead of using the stable versions, so no other changes are necessary to your library path etc.
-<syntaxhighlight lang="bash">
-switchtonightly ()
-−
-  . /opt/project-neon/share/project-neon/environment.rc
-−
-</syntaxhighlight>
-−
-or use <tt>neon-env</tt> (see below).
-−
 You'll need to close the terminal session for the settings to be undone.
 Note that settings for applications that you run from project neon do not conflict with your regular application settings and data. <tt>.project-neon-kde/</tt> is used instead of <tt>.kde/</tt>