Difference between revisions of "KBibTeX/Development"

Jump to: navigation, search
(Various Useful Resources: Adding EBN and Coverity Scan)
(prepared page for translation)
Line 1: Line 1:
 +
<languages />
 +
<translate>
 +
 
== Various Useful Resources ==
 
== Various Useful Resources ==
  
Line 4: Line 7:
  
 
* [https://cgit.kde.org/kbibtex.git Git repository's webpage]
 
* [https://cgit.kde.org/kbibtex.git Git repository's webpage]
 +
 
* [https://bugs.kde.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDSINFO&bug_status=VERIFIED&order=Importance&product=KBibTeX&query_format=advanced Bug reports]
 
* [https://bugs.kde.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDSINFO&bug_status=VERIFIED&order=Importance&product=KBibTeX&query_format=advanced Bug reports]
 +
 
* [https://build.kde.org/job/Extragear%20kbibtex%20kf5-qt5%20SUSEQt5.9/ Continuous Integration]
 
* [https://build.kde.org/job/Extragear%20kbibtex%20kf5-qt5%20SUSEQt5.9/ Continuous Integration]
 +
 
* [https://ebn.kde.org/krazy/reports/extragear/office/kbibtex/index.html English Breakfast Network]
 
* [https://ebn.kde.org/krazy/reports/extragear/office/kbibtex/index.html English Breakfast Network]
 +
 
* [https://scan.coverity.com/projects/kbibtex Coverity Scan]
 
* [https://scan.coverity.com/projects/kbibtex Coverity Scan]
  
Line 13: Line 20:
 
KBibTeX's sources are available through KDE's Git infrastructure, the repository's name is {{path|kbibtex}}. How to clone a Git repository is explained in the [https://techbase.kde.org/Development/Git/Recipes#Cloning_a_Repository Git Recipes in TechBase]. In short, run the following command in your terminal:
 
KBibTeX's sources are available through KDE's Git infrastructure, the repository's name is {{path|kbibtex}}. How to clone a Git repository is explained in the [https://techbase.kde.org/Development/Git/Recipes#Cloning_a_Repository Git Recipes in TechBase]. In short, run the following command in your terminal:
  
    git clone git://anongit.kde.org/kbibtex
+
{{Input|git clone git://anongit.kde.org/kbibtex}}
  
 
You can browse KBibTeX's source code at [https://cgit.kde.org/kbibtex.git KDE's Git server].
 
You can browse KBibTeX's source code at [https://cgit.kde.org/kbibtex.git KDE's Git server].
Line 32: Line 39:
  
 
KBibTeX is configured using CMake. There are a few options relevant for the configuration of this project:
 
KBibTeX is configured using CMake. There are a few options relevant for the configuration of this project:
# <code>CMAKE_INSTALL_PREFIX:PATH</code> specifies the installation location. There are a number of choices available for this option:
+
 
## The location of your KDE installation, for example {{Path|/usr}}. The commands <code>kde4-config --prefix</code> (compiling for KDE4) or <code>kf5-config --prefix</code> (compiling for KDE Frameworks 5) print this location. Requires root permissions (e. g. via sudo). Caution: This choice will interfere with the package management.
+
# <code>CMAKE_INSTALL_PREFIX:PATH</code> specifies the installation location. There are a number of choices available for this option:</translate>
## A directory outside the package management's control, for example {{Path|/usr/local}}. Requires setting some environment variables as explained below. This installation stays available across reboots and is available to all users. Requires root permissions (e. g. via sudo).
+
<translate>
## A user-writable directory like {{Path|/tmp/usr}} or {{Path|~/usr}}. Similar to above choice, it requires setting some environment variables, but no root permissions. Many distributions are configured to clean {{Path|/tmp}} on reboot.
+
## The location of your KDE installation, for example {{Path|/usr}}. The commands <code>kde4-config --prefix</code> (compiling for KDE4) or <code>kf5-config --prefix</code> (compiling for KDE Frameworks 5) print this location. Requires root permissions (e. g. via sudo). Caution: This choice will interfere with the package management.</translate>
 +
<translate>
 +
## A directory outside the package management's control, for example {{Path|/usr/local}}. Requires setting some environment variables as explained below. This installation stays available across reboots and is available to all users. Requires root permissions (e. g. via sudo).</translate>
 +
<translate>
 +
## A user-writable directory like {{Path|/tmp/usr}} or {{Path|~/usr}}. Similar to above choice, it requires setting some environment variables, but no root permissions. Many distributions are configured to clean {{Path|/tmp}} on reboot.</translate>
 +
<translate>
 
# <code>CMAKE_BUILD_TYPE</code> determines the amount of debug information included in the final code. Regular users may set it to <code>release</code>, developers to <code>debug</code>, and for step-by-step debugging <code>debugfull</code> works best. All available options are discussed in the [https://techbase.kde.org/Development/CMake/Addons_for_KDE#Buildtypes CMake documentation in TechBase].
 
# <code>CMAKE_BUILD_TYPE</code> determines the amount of debug information included in the final code. Regular users may set it to <code>release</code>, developers to <code>debug</code>, and for step-by-step debugging <code>debugfull</code> works best. All available options are discussed in the [https://techbase.kde.org/Development/CMake/Addons_for_KDE#Buildtypes CMake documentation in TechBase].
  
 
A complete example looks like this:
 
A complete example looks like this:
    cmake -DCMAKE_INSTALL_PREFIX:PATH=/tmp/usr -DCMAKE_BUILD_TYPE=debug ../kbibtex
+
{{Input|1=cmake -DCMAKE_INSTALL_PREFIX:PATH=/tmp/usr -DCMAKE_BUILD_TYPE=debug ../kbibtex}}
  
 
=== Compiling ===
 
=== Compiling ===
Line 45: Line 57:
 
GNU Make is the default choice for source code compilation. The number of parallel processes should be specified to shorten the time to finish on multi-core systems. The priority of the compilation tasks may get reduced.
 
GNU Make is the default choice for source code compilation. The number of parallel processes should be specified to shorten the time to finish on multi-core systems. The priority of the compilation tasks may get reduced.
  
    nice -n 16 make -j$(nproc)
+
{{Input|nice -n 16 make -j$(nproc)}}
  
 
To make use of of [https://ninja-build.org/ ninja], the <code>cmake</code> statement above has to include the argument <code>-GNinja</code>. Combining both cmake and ninja may look like this:
 
To make use of of [https://ninja-build.org/ ninja], the <code>cmake</code> statement above has to include the argument <code>-GNinja</code>. Combining both cmake and ninja may look like this:
  
  cmake -GNinja -DCMAKE_INSTALL_PREFIX:PATH=/tmp/usr -DCMAKE_BUILD_TYPE=debug ../kbibtex && ninja
+
{{Input|1=cmake -GNinja -DCMAKE_INSTALL_PREFIX:PATH=/tmp/usr -DCMAKE_BUILD_TYPE=debug ../kbibtex && ninja}}
  
 
== Installation ==
 
== Installation ==
Line 56: Line 68:
  
 
Running
 
Running
    make install
+
{{Input|make install}}
 
will install KBibTeX into the directory as specified as installation prefix earlier.
 
will install KBibTeX into the directory as specified as installation prefix earlier.
  
 
Unless the installation prefix equals the KDE install directory, the following environment variables have to be specified:
 
Unless the installation prefix equals the KDE install directory, the following environment variables have to be specified:
# '''Only for KDE4''': Set variable <code>KDEDIRS</code> to include the KDE installation directory and KBibTeX's installation directory, for example {{Path|/usr:/tmp/usr}}
+
 
# '''Only for KF5''': Set variable <code>QT_PLUGIN_PATH</code> to include the plugin directory inside the library directory of KBibTeX's installation directory, for example {{Path|/usr/lib/plugins:/usr/lib/qt5/plugins:/tmp/usr/lib64/plugins/}}
+
# '''Only for KDE4''': Set variable <code>KDEDIRS</code> to include the KDE installation directory and KBibTeX's installation directory, for example {{Path|/usr:/tmp/usr}}</translate>
# Set variable <code>LD_LIBRARY_PATH</code> to the library directory inside KBibTeX's installation directory, for example {{Path|/tmp/usr/lib64}}
+
<translate>
 +
# '''Only for KF5''': Set variable <code>QT_PLUGIN_PATH</code> to include the plugin directory inside the library directory of KBibTeX's installation directory, for example {{Path|/usr/lib/plugins:/usr/lib/qt5/plugins:/tmp/usr/lib64/plugins/}}</translate>
 +
<translate>
 +
# Set variable <code>LD_LIBRARY_PATH</code> to the library directory inside KBibTeX's installation directory, for example {{Path|/tmp/usr/lib64}}</translate>
 +
<translate>
 
# Set variable <code>XDG_DATA_DIRS</code> to include the shared data directories of the KDE installation directory, KBibTeX's installation directory, and other relevant prefixes, for example {{Path|/usr/share:/usr/local/share:/tmp/usr/share}}
 
# Set variable <code>XDG_DATA_DIRS</code> to include the shared data directories of the KDE installation directory, KBibTeX's installation directory, and other relevant prefixes, for example {{Path|/usr/share:/usr/local/share:/tmp/usr/share}}
  
Line 69: Line 85:
 
Now KBibTeX can be started, like shown in this example:
 
Now KBibTeX can be started, like shown in this example:
  
    /tmp/usr/bin/kbibtex
+
{{Input|/tmp/usr/bin/kbibtex}}
  
 
== Git cookbook ==
 
== Git cookbook ==
Line 79: Line 95:
 
In below example, replace {{path|xxxx}} with a short and concise name for a feature to be developed (as discussed above). Branches for bugs are created similarly, but follow the scheme {{path|bugs/kdeNNNN}}, where NNNN is the bug number in [https://bugs.kde.org KDE's bug tracker]. Bugs in other bug trackers such as [https://gna.org/bugs/?group=kbibtex Gna!] or your distribution may use a different prefix such as {{path|bugs/gnaNNNN}} or {{path|bugs/gentooNNNN}}.
 
In below example, replace {{path|xxxx}} with a short and concise name for a feature to be developed (as discussed above). Branches for bugs are created similarly, but follow the scheme {{path|bugs/kdeNNNN}}, where NNNN is the bug number in [https://bugs.kde.org KDE's bug tracker]. Bugs in other bug trackers such as [https://gna.org/bugs/?group=kbibtex Gna!] or your distribution may use a different prefix such as {{path|bugs/gnaNNNN}} or {{path|bugs/gentooNNNN}}.
  
  git branch --track feature/xxxx origin/master && git checkout feature/xxxx
+
{{Input|1=git branch --track feature/xxxx origin/master && git checkout feature/xxxx}}
  
 
=== Pushing a Local Feature or Bug Branch ===
 
=== Pushing a Local Feature or Bug Branch ===
Line 87: Line 103:
 
To publish you changes, use a command like this:
 
To publish you changes, use a command like this:
  
    git push personalpublicclone feature/xxxx:feature/xxxx
+
{{Input|git push personalpublicclone feature/xxxx:feature/xxxx}}
  
 
Others can add your repository to their local clone of KBibTeX's git and clone your branch (assuming in this example it is located on KDE's Git server):
 
Others can add your repository to their local clone of KBibTeX's git and clone your branch (assuming in this example it is located on KDE's Git server):
  
    git remote add someonespublicclone git@git.kde.org:clones/kbibtex/NAME/kbibtex # run once
+
{{Input|git remote add someonespublicclone git@git.kde.org:clones/kbibtex/NAME/kbibtex # run once
    git fetch someonespublicclone feature/xxxx && git checkout feature/xxxx # every time to get updates
+
git fetch someonespublicclone feature/xxxx && git checkout feature/xxxx # every time to get updates
    git remote rm someonespublicclone && git checkout master && git branch -D feature/xxxx # to erase branch
+
git remote rm someonespublicclone && git checkout master && git branch -D feature/xxxx # to erase branch}}
  
 
=== Create Release Branches and Tags ===
 
=== Create Release Branches and Tags ===
Line 99: Line 115:
 
To create a release branch from {{path|master}} and push it to {{path|origin}}, run
 
To create a release branch from {{path|master}} and push it to {{path|origin}}, run
  
    git checkout -b kbibtex/0.6 master && git push origin kbibtex/0.6
+
{{Input|git checkout -b kbibtex/0.6 master && git push origin kbibtex/0.6}}
  
 
To tag a release in a release branch, run the following commands:
 
To tag a release in a release branch, run the following commands:
  
    git checkout kbibtex/0.6 # be in right branch
+
{{Input|git checkout kbibtex/0.6 # be in right branch
    git pull --ff-only # get latest changes from origin
+
git pull --ff-only # get latest changes from origin
    git status # just check that everything is ok
+
git status # just check that everything is ok
    git tag -s -u GPGKEY -m "Tagging 0.6" v0.6 # actual tagging, GnuPG signed
+
git tag -s -u GPGKEY -m "Tagging 0.6" v0.6 # actual tagging, GnuPG signed
    git push --tags # explicitly push tag to origin
+
git push --tags # explicitly push tag to origin}}
  
 
== Creating a Release ==
 
== Creating a Release ==
Line 114: Line 130:
 
To create a release, use the Ruby scripts from the {{path|git.kde.org:releaseme.git}} repository. KBibTeX's package generation is configured through files {{path|kbibtex.rb}} and {{path|kbibtexrc}}. Configure those files or invoke {{path|kbibtex.rb}} with the correct arguments, such as:
 
To create a release, use the Ruby scripts from the {{path|git.kde.org:releaseme.git}} repository. KBibTeX's package generation is configured through files {{path|kbibtex.rb}} and {{path|kbibtexrc}}. Configure those files or invoke {{path|kbibtex.rb}} with the correct arguments, such as:
  
    ./kbibtex.rb --src=file:///${HOME}/git/kbibtex --version=0.6.0 --no-doc --no-l10n
+
{{Input|1=./kbibtex.rb --src=file:///${HOME}/git/kbibtex --version=0.6.0 --no-doc --no-l10n}}
  
 
Fetching documentation and translation files is the most time-consuming part of this process.
 
Fetching documentation and translation files is the most time-consuming part of this process.
Line 120: Line 136:
 
Detached cryptographic hashes can be created and signed like this:
 
Detached cryptographic hashes can be created and signed like this:
  
    sha512sum kbibtex-0.6.0.tar.xz >kbibtex-0.6.0.tar.xz.sha512
+
{{Input|1=sha512sum kbibtex-0.6.0.tar.xz >kbibtex-0.6.0.tar.xz.sha512
    gpg --default-key GPGKEY --output kbibtex-0.6.0.tar.xz.sha512.asc --detach-sign --armor kbibtex-0.6.0.tar.xz.sha512
+
gpg --default-key GPGKEY --output kbibtex-0.6.0.tar.xz.sha512.asc --detach-sign --armor kbibtex-0.6.0.tar.xz.sha512
    gpg --default-key GPGKEY --output kbibtex-0.6.0.tar.xz.asc --detach-sign --armor kbibtex-0.6.0.tar.xz
+
gpg --default-key GPGKEY --output kbibtex-0.6.0.tar.xz.asc --detach-sign --armor kbibtex-0.6.0.tar.xz}}
 +
 
 +
</translate>

Revision as of 08:53, 24 September 2017

Other languages:
English • ‎українська

Various Useful Resources

The following links refer to other web pages or resources relevant for the development of KBibTeX.

Getting the Source Code

KBibTeX's sources are available through KDE's Git infrastructure, the repository's name is kbibtex. How to clone a Git repository is explained in the Git Recipes in TechBase. In short, run the following command in your terminal:

git clone git://anongit.kde.org/kbibtex

You can browse KBibTeX's source code at KDE's Git server.

Branches

Main development happens in the master branch (named master). It is an objective that this branch is functional and mostly stable, although it is not guaranteed. Use this branch to enjoy new features.

For releases, release branches are created. The naming scheme is kbibtex/versionnumber, where versionnumber may be something like 0.6. Actual releases are tagged commits ('tags') within such a branch, for example v0.5.1. There won't be branches for bug fix releases, e.g. no kbibtex/0.6.1.

For bugs or features that require multiple commits and where individual commits may break master or a release branch, so-called feature branches are used. These branches are supposed to track master (typical for features) or a release branch (typical for bugs). Branches for bugs are meant to be merged into the release branch where the bug was reported for as well as into the master branch (for future releases). Feature branches are merged into the master branch, in selected cases into releases branches where no release has been tagged yet, and only in rare cases back-ported to release branches with published releases. An example for a feature branch would be feature/zotero, which may contain the code for an improved Zotero support. Names for bug report-related branches are bugs/bugsystemnumber (for example bugs/kde338375) , where bugsystem would be kde or the name of a Linux distribution and number the actual bug number. Feature branches start with feature/ followed by a short descriptive name for this feature (all lowercase, no spaces). Merged branches will be delete after some time.

Compiling the Code

The following instructions provide information how to compile KBibTeX on the command line. Instructions are similar but differ slightly between KDE4-based builds (e.g. branch kbibtex/0.5) and KDE Frameworks 5-based builds (e.g. branch master). When compiling KBibTeX from inside of an IDE like KDevelop or Qt Creator, those settings have to be applied as well.

Running CMake

KBibTeX is configured using CMake. There are a few options relevant for the configuration of this project:

  1. CMAKE_INSTALL_PREFIX:PATH specifies the installation location. There are a number of choices available for this option:
    1. The location of your KDE installation, for example /usr. The commands kde4-config --prefix (compiling for KDE4) or kf5-config --prefix (compiling for KDE Frameworks 5) print this location. Requires root permissions (e. g. via sudo). Caution: This choice will interfere with the package management.
    2. A directory outside the package management's control, for example /usr/local. Requires setting some environment variables as explained below. This installation stays available across reboots and is available to all users. Requires root permissions (e. g. via sudo).
    3. A user-writable directory like /tmp/usr or ~/usr. Similar to above choice, it requires setting some environment variables, but no root permissions. Many distributions are configured to clean /tmp on reboot.
  2. CMAKE_BUILD_TYPE determines the amount of debug information included in the final code. Regular users may set it to release, developers to debug, and for step-by-step debugging debugfull works best. All available options are discussed in the CMake documentation in TechBase.

A complete example looks like this:

cmake -DCMAKE_INSTALL_PREFIX:PATH=/tmp/usr -DCMAKE_BUILD_TYPE=debug ../kbibtex

Compiling

GNU Make is the default choice for source code compilation. The number of parallel processes should be specified to shorten the time to finish on multi-core systems. The priority of the compilation tasks may get reduced.

nice -n 16 make -j$(nproc)

To make use of of ninja, the cmake statement above has to include the argument -GNinja. Combining both cmake and ninja may look like this:

cmake -GNinja -DCMAKE_INSTALL_PREFIX:PATH=/tmp/usr -DCMAKE_BUILD_TYPE=debug ../kbibtex && ninja

Installation

KBibTeX uses KDE's KParts technology, which requires you to install some libraries. KBibTeX may not run properly if the following steps are omitted.

Running

make install

will install KBibTeX into the directory as specified as installation prefix earlier.

Unless the installation prefix equals the KDE install directory, the following environment variables have to be specified:

  1. Only for KDE4: Set variable KDEDIRS to include the KDE installation directory and KBibTeX's installation directory, for example /usr:/tmp/usr
  2. Only for KF5: Set variable QT_PLUGIN_PATH to include the plugin directory inside the library directory of KBibTeX's installation directory, for example /usr/lib/plugins:/usr/lib/qt5/plugins:/tmp/usr/lib64/plugins/
  3. Set variable LD_LIBRARY_PATH to the library directory inside KBibTeX's installation directory, for example /tmp/usr/lib64
  4. Set variable XDG_DATA_DIRS to include the shared data directories of the KDE installation directory, KBibTeX's installation directory, and other relevant prefixes, for example /usr/share:/usr/local/share:/tmp/usr/share

Run kbuildsycoca4 (KDE4) or kbuildsycoca5 (KDE Frameworks 5) to make the KDE subsystem aware of the new libraries.

Now KBibTeX can be started, like shown in this example:

/tmp/usr/bin/kbibtex

Git cookbook

A number of pages in TechBase, UserBase, and Community discuss using Git for source code management. This section shows some examples how Git is used for KBibTeX.

Create a Feature or Bug Branch

In below example, replace xxxx with a short and concise name for a feature to be developed (as discussed above). Branches for bugs are created similarly, but follow the scheme bugs/kdeNNNN, where NNNN is the bug number in KDE's bug tracker. Bugs in other bug trackers such as Gna! or your distribution may use a different prefix such as bugs/gnaNNNN or bugs/gentooNNNN.

git branch --track feature/xxxx origin/master && git checkout feature/xxxx

Pushing a Local Feature or Bug Branch

To minimize polluting the official KBibTeX repository or when you do not have write access, you may push your local branches to another Git repository to allow others to inspect your changes. In below example, personalpublicclone is your personal, public Git repository where you want to push to.

To publish you changes, use a command like this:

git push personalpublicclone feature/xxxx:feature/xxxx

Others can add your repository to their local clone of KBibTeX's git and clone your branch (assuming in this example it is located on KDE's Git server):

git remote add someonespublicclone git@git.kde.org:clones/kbibtex/NAME/kbibtex # run once
git fetch someonespublicclone feature/xxxx && git checkout feature/xxxx # every time to get updates
git remote rm someonespublicclone && git checkout master && git branch -D feature/xxxx # to erase branch

Create Release Branches and Tags

To create a release branch from master and push it to origin, run

git checkout -b kbibtex/0.6 master && git push origin kbibtex/0.6

To tag a release in a release branch, run the following commands:

git checkout kbibtex/0.6 # be in right branch
git pull --ff-only # get latest changes from origin
git status # just check that everything is ok
git tag -s -u GPGKEY -m "Tagging 0.6" v0.6 # actual tagging, GnuPG signed
git push --tags # explicitly push tag to origin

Creating a Release

Dialog-information.png
 
Information
This section describes how to create releases based on KDE4 (kdelibs4). It will not work for KDE Frameworks 5.


To create a release, use the Ruby scripts from the git.kde.org:releaseme.git repository. KBibTeX's package generation is configured through files kbibtex.rb and kbibtexrc. Configure those files or invoke kbibtex.rb with the correct arguments, such as:

./kbibtex.rb --src=file:///${HOME}/git/kbibtex --version=0.6.0 --no-doc --no-l10n

Fetching documentation and translation files is the most time-consuming part of this process.

Detached cryptographic hashes can be created and signed like this:

sha512sum kbibtex-0.6.0.tar.xz >kbibtex-0.6.0.tar.xz.sha512
gpg --default-key GPGKEY --output kbibtex-0.6.0.tar.xz.sha512.asc --detach-sign --armor kbibtex-0.6.0.tar.xz.sha512
gpg --default-key GPGKEY --output kbibtex-0.6.0.tar.xz.asc --detach-sign --armor kbibtex-0.6.0.tar.xz

Content is available under Creative Commons License SA 4.0 unless otherwise noted.