Difference between revisions of "Tracking Dependencies"

From Inkscape Wiki
Jump to navigation Jump to search
(Remove EOL’d Ubuntu 19.10, unsupported since the 17th of July.)
(281 intermediate revisions by 19 users not shown)
Line 1: Line 1:
(stub contents in need of filling out)
== Overview ==
== Overview ==


We need help getting our basic lib dependencies listed out and kept up to date. Also we need to track which versions of which distros have the needed dependencies.
We need help getting our basic lib dependencies listed out and kept up to date. Also we need to track which versions of which distros have the needed dependencies.


To get glib and GTK+ dependencies figured out, people can go through the API documentation and look for the 'since' entries saying when calls were added. Then look for those calls in our source. Voila! we'll have base minimum dependencies figured out.


To get glib and GTK+ dependencies figured out, people can go through the API documentation and look for the 'since' entries saying when calls were added. Then look for those calls in our source. Voila! we'll have base minimum dependencies figured out.
== Compilers ==
 
For C++11 features, see [[C++11]]


=== gcc ===
=== clang ===


== Libs ==
== Libs ==


{| class="wikitable" border="1"
C++ bindings are not included, since their required versions match those of the C counterparts.
 
{| class="wikitable"
|-
|-
! Library
! Library
! v 0.45
! v 0.92
! v 0.46
! v 1.0
! v 0.47
! master
|-
|-
| boehmgc
| Boehm-GC
| ?
| 7.2
| ?
| 7.2
| ?
|
|-
| Cairo
| 1.14
| 1.14 (1.15.4 required for PDF links)
| 1.16*
|-
| double-conversion [https://github.com/google/double-conversion]<br/>''(lib2geom dependency)''
| ''(not required)''
| any
|
|-
|-
| cairo2
| GDL
| ?
| N/A<br />(3.4)
| ?
| 3.4
| ?
| 3.6
|-
|-
| cairomm
| Glib
| ?
| 2.28
| ?
| 2.48
| ?
| 2.56 or 2.62*
|-
|-
| gdk
| GTK+
| ?
| 2.24<br />(3.8)
| ?
| 3.22
| ?
| 3.24*
|-
|-
| gdkmm
| GNU Scientific Library
| ?
| ?
| ?
| ?
| 2.4
|
|-
|-
| glib2
| libsigc++
| ?
| ''2.0.12*''
| ?
| ''2.0.12*''
| ?
| 2.10*
|-
|-
| glibmm
| libSoup
| ?
| ''(not required)''
| ?
| (any)
| 2.4
|
|-
|-
| gtk+2.0
| libpotrace
| 2.8.0
| ''(not required)''
| 2.10.0
| (any)
| ?
|
|-
|-
| gtkmm
| libxml
| ?
| ''2.6.11*''
| ?
| ''2.6.11*''
| 2.10.0
|
|-
|-
| gsl
| libxslt
| X
| ''1.0.15*''
| X
| ''1.0.15*''
| ?
|-
|-
| lcms
| LittleCMS
| ?
| 1.13
| ?
| 1.13
| 1.13
|
|-
| Pango
| 1.24
| 1.24 (1.41.1 required for variable fonts)
| 1.42*
|-
| Poppler
| 0.20.0
| 0.20.0
| 0.71*
|-
| [https://formulae.brew.sh/formula/gtk-mac-integration gtk-mac-integration]<br>[https://www.macports.org/ports.php?by=library&substr=gtk-osx-application-gtk3 gtk-osx-application-gtk3]
| N/A
| 2.0.8 ([[CompilingMacOsX|macOS only]])
|
|}
''* Tentative dependency''
== Distros ==
Note: This table is not relevant to (non-fink) MacOS X, where we ship the desired version with Inkscape.
"Inkscape" column is default or distro version / oldest that builds - latest that builds. If no latest is given then that means trunk is expected to build on the given platform.
e.g. for a distro that ships with 0.48 but should support building of trunk you might get:
0.48 / 0.47-
'''General rules:'''
* Support last Debian Stable
* Support last Ubuntu LTS
* Support last CentOS/Redhat (as best effort).
* Support last two Fedora releases.
* Don't break ''point'' releases.
{| class="wikitable"
|-
|-
| libxml2
! Distro
| ?
! Inkscape
| ?
! gcc
| 2.6.11
! clang
! cairo
! cairomm
! glib
! glibmm
! gtk+
! gtkmm
! pango
! poppler
! gdl
! lcms2
! libsigc++
! libgc <!-- Fedora rpm: gc -->
! libsoup
|-
|-
| libxslt
| Windows MSYS2 (2018-11-08)<br/>([https://github.com/Alexpux/MINGW-packages mingw-w64 packages] from MSYS2 project)
| ?
  <!-- see http://quodlibet.duckdns.org/msys2/base for list of latest package versions -->
| ?
| -
| 1.0.15
| 8.2.0
| <abbr title="compiles but fails to link due to long path issue (help welcome)">(7.0.0)</abbr>
| 1.16.0
| 1.12.2
| 2.58.1
| 2.58.0
| 2.24.32<br />3.24.1
| 2.24.5<br />3.22.3
| 1.42.4
| 0.69.0
| 3.28.0
| 1.19<br />2.9
| 2.10.1
| 7.6.8
| 2.64.2
|-
|-
| pango
| Debian 10 (Buster, <i>stable</i>) <small>EOL 2024-06</small>
| ?
| 0.92.4
| ?
| 8.3.0
| ?
| 7.0
| 1.16
| 1.12.2
| 2.58.3
| 2.58.0
| 2.24.32<br />3.24.5
| 2.24.5<br />3.24.0
| 1.42.4
| 0.71.0
| 3.28.0
| 2.9
| 2.10.1
| 7.6.4
| 2.64.2
|-
|-
| pangomm
| style="background:Violet;"|(RHEL) / CentOS 8.1 <small>EOFS 2024-05</small><br/>Based on Centros 8.1 package list
| ?
| 0.92.3
| ?
| 8.3.1
| ?
| 8.0.1
| 1.15.12
| 1.12.0
| 2.56.4
| 2.56.0
| 2.24.32<br />3.22.30
| 2.24.5<br />3.22.2
| 1.42.4
| 0.66.0
| style="background:Violet;"|?
| 2.9
| 2.10.0
| 7.6.4
| 2.62.3
|-
|-
| poppler
| Ubuntu 18.04 LTS (Bionic) <small>EOL 2023-04</small>
| ?
| 0.92.3
| ?
| 7.3
| 0.5.9
| 6.0
| 1.15.10
| 1.12.2
| 2.56.1
| 2.56.0
| 2.24.32<br />3.22.30
| 2.24.5<br />3.22.2
| 1.40.14
| 0.62.0
| 3.28.0
| 2.9
| 2.10.0
| 7.4.2
| 2.62.1
|-
|-
| sigc++
| Ubuntu 20.04 LTS (Focal Fossa) <small>EOL 2025-04</small>
| ?
| 0.92.5
| ?
| 10
| 2.0.12
| 10
| 1.16
| 1.12.2
| 2.64.1
| 2.64.2
| 2.24.32<br />3.24.17
| 2.24.5<br />3.24.2
| 1.44.7
| 0.86.1
| 3.34.0
| 2.9.4
| 2.10.2
| 10
| 2.70.0
|}
|}


== Functions Used ==
{| class="wikitable"
 
|-
{| class="wikitable" border="1"
! Legend
|-
|-
! Function
| style="background:Orange;"| Inkscape 1.0.x unsupported
! Lib
! Since
! Required
|-
|-
| g_timeout_add_seconds
| style="background:Violet;"| GTK+ 3 builds unsupported
| glib2
| 2.14
| ?
|}
|}


== Distros ==
* Agreed to at Saarbrücken hackfest.
 
== Getting and Installing Source packages ==
 
If your distro does not have some packages available (like many don't, ie, Fedora Core 2), you must often download
source packages and build and install them yourself.  Actually this is not that hard, and is similar to
doing a Gentoo 'emerge.'
 
* Usually you download a file with a name like somepackage-1.0.tar.gz.  Unpack it with
 
    $ tar zxf somepackage-1.0.tar.gz
    or
    $ tar jxf somepackage-1.0.tar.bz2
 
* Then 'cd' into the new directory.
 
* Configure it with the command:
 
    $ ./configure
 
* Build it with:
 
    $ make
 
* As the 'root' user,  install it with:
 
    # make install
 
=== Boehm-GC ===
 
Website: http://www.hboehm.info/gc/
 
GitHub Project: https://github.com/ivmai/bdwgc
 
Binaries:  If searching for a package for GC, the name of it is sometimes:
 
* gc
* libgc
* gc-devel
* libgc-devel
* boehm-gc  (on Gentoo)
* debian/ubuntu:  sudo apt-get install libgc-dev
 
=== libSigc++ ===
 
Source: http://ftp.gnome.org/pub/GNOME/sources/libsigc++/2.2/libsigc++-2.2.3.tar.bz2
 
With this file, and for GlibMM and GtkMM below, it is usually desirable for us developers to
build this C++ library statically.  This removes a dependency that might be difficult for an
end-user during installation.  Configure it with:
 
    ./configure --enable-static --disable-shared
 
=== GlibMM ===
Try to match your Glib2 version with GlibMM's version. For example, if your Glib2 is 2.16.6, download glibmm-2.16.4.tar.bz2.
 
Latest source: http://ftp.gnome.org/pub/GNOME/sources/glibmm/
 
=== GtkMM ===
Usually you can try the latest version of GtkMM, but if you get version mismatch errors, try older releases.
 
Source: http://ftp.gnome.org/pub/GNOME/sources/gtkmm/2.12/gtkmm-2.12.7.tar.bz2
 
=== cairomm ===
 
if you got prompted about cairomm, try first solve your cairo version, so you can grab [http://www.cairographics.org/releases/ there] a compatible version.
 
 
=== Boost ===
 
Many users have reported when building from source that after installing the above dependencies, the configure script still requires a "boost" package. It can be found below, but even after installing, you will need to create a symlink to allow the configure script to find it:
 
    ln -s /usr/local/include/boost_1_xx_x/boost /usr/local/include/boost
 
Source: http://www.boost.org/users/download/
 
=== Poppler ===
 
Source: http://poppler.freedesktop.org/
 
Poppler is required for PDF import. There are several potential issues:
* Some Linux distributions do not ship the Xpdf headers required by Inkscape. In such cases, you need to recompile Poppler, passing --enable-xpdf-headers on the configure line or install the libpoppler-private-dev package. See [https://bugs.launchpad.net/inkscape/+bug/254849 this wishlist bug]. This typically manifests in error messages like this:
<pre>In file included from extension/internal/pdfinput/svg-builder.cpp:19:
extension/internal/pdfinput/svg-builder.h:32:23: error: CharTypes.h: No such file or directory
...
make[2]: *** [extension/internal/pdfinput/svg-builder.o] Error 1
make[2]: Leaving directory `/tmp/build/inkscape-0.46/src'
make[1]: *** [all-recursive] Error 1
make[1]: Leaving directory `/tmp/build/inkscape-0.46'
make: *** [all] Error 2</pre>
* Inkscape 0.47 does not compile with Poppler >= 0.12.2. If you need to compile Inkscape on such systems, use the development version from Bazaar, where this bug is fixed. See [https://bugs.launchpad.net/inkscape/+bug/487038 the bug report] for details and a minimal patch.
* Inkscape compiled with Poppler <= 0.12.1 will run on systems with Poppler >= 0.12.2, but the PDF import function will crash instantly. This problem does not concern Windows users, since the correct Poppler version is contained in the Windows installer package. This cannot be fixed on Inkscape's side: those two versions of Poppler are not ABI compatible, yet share the same soname. See [https://bugs.launchpad.net/inkscape/+bug/258504 this bug] for more details.
* Poppler's Xpdf headers are not guaranteed to be API-compatible between releases. It's likely that future Poppler versions will break PDF import in some way. PDF import works at least up to 0.12.4 but might not work with later versions.
 
== Optional Dependencies ==
 
Inkscape will still compile without these, but some features may be missing if they are absent during compilation:


{| class="wikitable" border="1"
{| class="wikitable"
|-
|-
! Distro
! scope="col"| Library
! cairo2
! scope="col"| Needed for
! glib2
! scope="col"| Default
! gtk+
|-
! pango
|aspell
|Dictionaries for spell checking
|On
|-
|libcdr
|Open Corel Draw files
|On
|-
|gettext/msgformat
|Translation support
|On
|-
|-
| Fedora 7
|gtest/gmock
| ?
|Automatted testing
| 2.12
|Off
| 2.10.14
| ?
|-
|-
| Fedora 8
|gspell
| ?
|Spell checking
| 2.14
|On
| 2.12.8
| ?
|-
|-
| Fedora 9
|imagemagick
| ?
|Bitmap editing extensions, bitmap import resolution
| 2.16
|On
| 2.12.10
| ?
|-
|-
| Open SuSE 10.3
|jpeg
| 1.4.14
|jpeg import?
| 2.14.1
|On
| 2.12.0
| 1.18.2
|-
|-
| Open SuSE 11.0
|lcms
| ?
|Color management
| ?
|On
| 2.12.9
| ?
|-
|-
| OS X 10.4.x
|OpenMP
| ?
|Multi-threaded filter rendering
| ?
|On
| ?
| ?
|-
|-
| OS X 10.5.x
|scour
| ?
|Save as Optimized SVG
| ?
|(not needed during compiling, Python)
| ?
| ?
|-
|-
| Ubuntu 7.10
|libvisio
| ?
|Open Visio Files, use Visio stencils
| ?
|On
| 2.12.0
| ?
|-
|-
| Ubuntu 8.04 LTS
|libwpg
| ?
|Open WordPerfect Graphics
| ?
|On
| ?
| ?
|-
|-
| Xandros
| 1.2.4
| 2.12.4
| 2.8.20
| 1.14.8
|}
|}
[[Category:About Inkscape]]
[[Category:Developer Documentation]]

Revision as of 12:33, 30 July 2020

Overview

We need help getting our basic lib dependencies listed out and kept up to date. Also we need to track which versions of which distros have the needed dependencies.

To get glib and GTK+ dependencies figured out, people can go through the API documentation and look for the 'since' entries saying when calls were added. Then look for those calls in our source. Voila! we'll have base minimum dependencies figured out.

Compilers

For C++11 features, see C++11

gcc

clang

Libs

C++ bindings are not included, since their required versions match those of the C counterparts.

Library v 0.92 v 1.0 master
Boehm-GC 7.2 7.2
Cairo 1.14 1.14 (1.15.4 required for PDF links) 1.16*
double-conversion [1]
(lib2geom dependency)
(not required) any
GDL N/A
(3.4)
3.4 3.6
Glib 2.28 2.48 2.56 or 2.62*
GTK+ 2.24
(3.8)
3.22 3.24*
GNU Scientific Library ? ?
libsigc++ 2.0.12* 2.0.12* 2.10*
libSoup (not required) (any)
libpotrace (not required) (any)
libxml 2.6.11* 2.6.11*
libxslt 1.0.15* 1.0.15*
LittleCMS 1.13 1.13
Pango 1.24 1.24 (1.41.1 required for variable fonts) 1.42*
Poppler 0.20.0 0.20.0 0.71*
gtk-mac-integration
gtk-osx-application-gtk3
N/A 2.0.8 (macOS only)

* Tentative dependency

Distros

Note: This table is not relevant to (non-fink) MacOS X, where we ship the desired version with Inkscape.

"Inkscape" column is default or distro version / oldest that builds - latest that builds. If no latest is given then that means trunk is expected to build on the given platform.

e.g. for a distro that ships with 0.48 but should support building of trunk you might get:

0.48 / 0.47-

General rules:

  • Support last Debian Stable
  • Support last Ubuntu LTS
  • Support last CentOS/Redhat (as best effort).
  • Support last two Fedora releases.
  • Don't break point releases.
Distro Inkscape gcc clang cairo cairomm glib glibmm gtk+ gtkmm pango poppler gdl lcms2 libsigc++ libgc libsoup
Windows MSYS2 (2018-11-08)
(mingw-w64 packages from MSYS2 project)
- 8.2.0 (7.0.0) 1.16.0 1.12.2 2.58.1 2.58.0 2.24.32
3.24.1
2.24.5
3.22.3
1.42.4 0.69.0 3.28.0 1.19
2.9
2.10.1 7.6.8 2.64.2
Debian 10 (Buster, stable) EOL 2024-06 0.92.4 8.3.0 7.0 1.16 1.12.2 2.58.3 2.58.0 2.24.32
3.24.5
2.24.5
3.24.0
1.42.4 0.71.0 3.28.0 2.9 2.10.1 7.6.4 2.64.2
(RHEL) / CentOS 8.1 EOFS 2024-05
Based on Centros 8.1 package list
0.92.3 8.3.1 8.0.1 1.15.12 1.12.0 2.56.4 2.56.0 2.24.32
3.22.30
2.24.5
3.22.2
1.42.4 0.66.0 ? 2.9 2.10.0 7.6.4 2.62.3
Ubuntu 18.04 LTS (Bionic) EOL 2023-04 0.92.3 7.3 6.0 1.15.10 1.12.2 2.56.1 2.56.0 2.24.32
3.22.30
2.24.5
3.22.2
1.40.14 0.62.0 3.28.0 2.9 2.10.0 7.4.2 2.62.1
Ubuntu 20.04 LTS (Focal Fossa) EOL 2025-04 0.92.5 10 10 1.16 1.12.2 2.64.1 2.64.2 2.24.32
3.24.17
2.24.5
3.24.2
1.44.7 0.86.1 3.34.0 2.9.4 2.10.2 10 2.70.0
Legend
Inkscape 1.0.x unsupported
GTK+ 3 builds unsupported
  • Agreed to at Saarbrücken hackfest.

Getting and Installing Source packages

If your distro does not have some packages available (like many don't, ie, Fedora Core 2), you must often download source packages and build and install them yourself. Actually this is not that hard, and is similar to doing a Gentoo 'emerge.'

  • Usually you download a file with a name like somepackage-1.0.tar.gz. Unpack it with
   $ tar zxf somepackage-1.0.tar.gz
   or
   $ tar jxf somepackage-1.0.tar.bz2
  • Then 'cd' into the new directory.
  • Configure it with the command:
   $ ./configure
  • Build it with:
   $ make
  • As the 'root' user, install it with:
   # make install

Boehm-GC

Website: http://www.hboehm.info/gc/

GitHub Project: https://github.com/ivmai/bdwgc

Binaries: If searching for a package for GC, the name of it is sometimes:

  • gc
  • libgc
  • gc-devel
  • libgc-devel
  • boehm-gc (on Gentoo)
  • debian/ubuntu: sudo apt-get install libgc-dev

libSigc++

Source: http://ftp.gnome.org/pub/GNOME/sources/libsigc++/2.2/libsigc++-2.2.3.tar.bz2

With this file, and for GlibMM and GtkMM below, it is usually desirable for us developers to build this C++ library statically. This removes a dependency that might be difficult for an end-user during installation. Configure it with:

   ./configure --enable-static --disable-shared

GlibMM

Try to match your Glib2 version with GlibMM's version. For example, if your Glib2 is 2.16.6, download glibmm-2.16.4.tar.bz2.

Latest source: http://ftp.gnome.org/pub/GNOME/sources/glibmm/

GtkMM

Usually you can try the latest version of GtkMM, but if you get version mismatch errors, try older releases.

Source: http://ftp.gnome.org/pub/GNOME/sources/gtkmm/2.12/gtkmm-2.12.7.tar.bz2

cairomm

if you got prompted about cairomm, try first solve your cairo version, so you can grab there a compatible version.


Boost

Many users have reported when building from source that after installing the above dependencies, the configure script still requires a "boost" package. It can be found below, but even after installing, you will need to create a symlink to allow the configure script to find it:

   ln -s /usr/local/include/boost_1_xx_x/boost /usr/local/include/boost

Source: http://www.boost.org/users/download/

Poppler

Source: http://poppler.freedesktop.org/

Poppler is required for PDF import. There are several potential issues:

  • Some Linux distributions do not ship the Xpdf headers required by Inkscape. In such cases, you need to recompile Poppler, passing --enable-xpdf-headers on the configure line or install the libpoppler-private-dev package. See this wishlist bug. This typically manifests in error messages like this:
In file included from extension/internal/pdfinput/svg-builder.cpp:19:
extension/internal/pdfinput/svg-builder.h:32:23: error: CharTypes.h: No such file or directory
...
make[2]: *** [extension/internal/pdfinput/svg-builder.o] Error 1
make[2]: Leaving directory `/tmp/build/inkscape-0.46/src'
make[1]: *** [all-recursive] Error 1
make[1]: Leaving directory `/tmp/build/inkscape-0.46'
make: *** [all] Error 2
  • Inkscape 0.47 does not compile with Poppler >= 0.12.2. If you need to compile Inkscape on such systems, use the development version from Bazaar, where this bug is fixed. See the bug report for details and a minimal patch.
  • Inkscape compiled with Poppler <= 0.12.1 will run on systems with Poppler >= 0.12.2, but the PDF import function will crash instantly. This problem does not concern Windows users, since the correct Poppler version is contained in the Windows installer package. This cannot be fixed on Inkscape's side: those two versions of Poppler are not ABI compatible, yet share the same soname. See this bug for more details.
  • Poppler's Xpdf headers are not guaranteed to be API-compatible between releases. It's likely that future Poppler versions will break PDF import in some way. PDF import works at least up to 0.12.4 but might not work with later versions.

Optional Dependencies

Inkscape will still compile without these, but some features may be missing if they are absent during compilation:

Library Needed for Default
aspell Dictionaries for spell checking On
libcdr Open Corel Draw files On
gettext/msgformat Translation support On
gtest/gmock Automatted testing Off
gspell Spell checking On
imagemagick Bitmap editing extensions, bitmap import resolution On
jpeg jpeg import? On
lcms Color management On
OpenMP Multi-threaded filter rendering On
scour Save as Optimized SVG (not needed during compiling, Python)
libvisio Open Visio Files, use Visio stencils On
libwpg Open WordPerfect Graphics On