Dirk:
A small patch to update the user manual to reflect the changes necessary
to build smtk2ssfr import tool. Mostly based on the instructions
provided by Salva...
Cheers:
Pedro
>From 2ab7e644db5af6ead0461464b35ac2105002465c Mon Sep 17 00:00:00 2001
From: Pedro Neves <[email protected]>
Date: Sat, 18 Nov 2017 13:19:33 +0000
Subject: [PATCH] Updated User Manual section on how to build smtk2ssrf
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Updated section 5.3.4 of the User Manual to reflect changes on how the smtk2ssrf
is built (based on comments by Salvador Cuñat).
Signed-off-by: Pedro Neves <[email protected]>
---
Documentation/user-manual.txt | 57 +++++++++++++++++++++++++++++++++++--------
1 file changed, 47 insertions(+), 10 deletions(-)
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index a74d1bd50..f3afc9868 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -1109,6 +1109,17 @@ generated by SmartTrak to Subsurface's _.xml_ format. It can be built together
with _Subsurface_ for Linux systems. Two dependencies need to be installed in
your system before building: _libglib2.0_ and _libmdb2_.
+In Debian and Ubuntu,
+
+ $ sudo apt update && sudo apt install mdbtools-dev
+
+should bring all of them, if not, add libglib2.0-dev to the apt install command.
+In Fedora (and probably Centos and friends) needed packages are named glib2-devel and mdbtools-devel so:
+
+ $ dnf -y install mdbtools-devel
+
+should be enough. Mdbtools is, in fact, optional. If it's not installed, the script will download and build what's needed.
+
In addition, a web service is available for divelog convertions from SmartTrak to _Subsurface_ (see below).
Feel free to contact the _Subsurface_ development team on mailto:[email protected][our mailing list]
@@ -1116,18 +1127,44 @@ for assistance in importing _SmartTrak_ dive logs.
===== Building _smtk2ssrf_
-Assuming the above dependencies
-have been installed and the _Subsurface_ source tree is in the directory _~/src/subsurface_, then:
+There is a script for building smtk2ssrf, located in ~/src/subsurface/scripts.
+
+Assuming the above dependencies have been installed and the _Subsurface_ source tree is in the
+directory _~/src/subsurface_, then move to the src directory and run:
+
+ $ smtk2ssrf-build.sh
+
+This will build an smtk2ssrf binary from subsurface's latest master
+with the default options: Release, no commandline only, and -j4.
+The binary will be located in
+ src/subsurface/smtk-import/build
+
+[icon="images/icons/warning2.png"]
+[WARNING]
+
+If you normally build _Subsurface_ from source, your regular subsurface's binary has just blown away,
+substituted with a bare minimum version. You should simply rebuild subsurface as
+normally.
+
+The building script for smtk2ssrf supports some flags. The most interesting, from
+a user from a user point of
+view, are -c (--cli) and -t (--tag).
+
+-c Builds a "just command line" version without GUI capabilities. It's
+the version used on the smtk2ssrf web service (see below). Remember the full version
+can also run in command line mode if you pass the file names to import.
+
+-t Forces building the provided tag, for both, the subsurface stripped
+version and smtk2ssrf. E.g.
+ -t v4.7.1
+would build subsurface library and smtk2ssrf as they were in 4.7.1
+release, without later improvements.
+
+It is recommended that a user run the smtk2ssrf build script without any flags.
-- Move to the source tree directory.
-- Run " $ ccmake build " and set SMARTTRAK_IMPORT option to *on* (off by
- default).
-- Generate with [c] and save and exit with [g].
-- Build as you prefer, using the _build.sh_ script (recomended) or moving to build
- directory and running _make_.
-- After a successful build, there will be an executable named _smtk2ssrf_ in the
+After a successful build, there will be an executable named _smtk2ssrf_ in the
_subsurface/build_ directory.
- Copy or move it to a directory in your $PATH, e.g. _~/bin_.
+Copy or move it to a directory in your $PATH, e.g. _~/bin_.
===== Running
--
2.15.0
_______________________________________________
subsurface mailing list
[email protected]
http://lists.subsurface-divelog.org/cgi-bin/mailman/listinfo/subsurface
