summaryrefslogtreecommitdiff
path: root/docs/development
diff options
context:
space:
mode:
authorjkoan <jkoan@gmx.de>2019-10-24 19:07:29 +0200
committerjkoan <jkoan@users.noreply.github.com>2019-10-28 11:45:46 +0100
commit0b0a073e5f4197120dccf2a8097f4f10388fafd0 (patch)
tree09b82d73efa75915f28f2aebc049d4492417701a /docs/development
parentb99187ee4d8336b4c237d1be805110d41d22a14d (diff)
downloadnavit-0b0a073e5f4197120dccf2a8097f4f10388fafd0.tar.gz
fix:doc:First set of style-fixes for reStructuredText/Read the Docs
Diffstat (limited to 'docs/development')
-rw-r--r--docs/development/android_development.rst16
-rw-r--r--docs/development/linux_development.rst31
-rw-r--r--docs/development/programming_guidelines.rst2
-rw-r--r--docs/development/wince_development.rst22
-rw-r--r--docs/development/windows_development.rst24
5 files changed, 48 insertions, 47 deletions
diff --git a/docs/development/android_development.rst b/docs/development/android_development.rst
index 722d7eb82..783a29e91 100644
--- a/docs/development/android_development.rst
+++ b/docs/development/android_development.rst
@@ -25,9 +25,9 @@ For Android
* Download the Android `SDK <http://dl.google.com/android/android-sdk_r18-linux.tgz>` and `NDK <http://dl.google.com/android/ndk/android-ndk-r8-linux-x86.tar.bz2>`
* Unzip the SDK and NDK to a directory of your choice. The following instructions assume that the SDK and NDK have been unzipped to `~/src`.
* Ensure that the following paths are on your PATH environment variable:
- `path-to-sdk/tools`
- `path-to-sdk/platform-tools`
- `path-to-ndk/toolchains/arm-linux-androideabi-4.4.3/prebuilt/linux-x86/bin`
+ `path-to-sdk/tools`
+ `path-to-sdk/platform-tools`
+ `path-to-ndk/toolchains/arm-linux-androideabi-4.4.3/prebuilt/linux-x86/bin`
* On Ubuntu you can accomplish this using the following command (assuming the SDK and NDK have been unzipped to `~/src`):
.. code-block:: bash
@@ -63,15 +63,15 @@ With cmake
cd ~/src
mkdir android-build
- * Optional: Add a `SOURCE_PATH` environment variable to your system, pointing to the directory in which you checked out a copy of Navit. You can leave out this step, but make sure you change `$SOURCE_PATH` in the next steps to the actual path of the directory. `export SOURCE_PATH=~/src/navit`
- * Step into the build directory: `cd ~/src/android-build`
- * Run CMake (ensure that you're in the build directory when you do this!):
+* Optional: Add a `SOURCE_PATH` environment variable to your system, pointing to the directory in which you checked out a copy of Navit. You can leave out this step, but make sure you change `$SOURCE_PATH` in the next steps to the actual path of the directory. `export SOURCE_PATH=~/src/navit`
+* Step into the build directory: `cd ~/src/android-build`
+* Run CMake (ensure that you're in the build directory when you do this!):
.. code-block:: bash
cmake -DCMAKE_TOOLCHAIN_FILE=$SOURCE_PATH/Toolchain/arm-eabi.cmake -DCACHE_SIZE="(20*1024*1024)" -DAVOID_FLOAT=1 -DANDROID_PERMISSIONS="CAMERA" -DANDROID_API_VERSION=8 -DXSLT_PROCESSOR=/usr/bin/saxonb-xslt $SOURCE_PATH
- * Build the apk package:
+* Build the apk package:
.. code-block:: bash
@@ -137,7 +137,7 @@ So far, two issues have been observed with the build:
* Building `vehicle/gpsd` and `map/garmin` fails on Android. As a workaround, edit `CMakeLists.txt` `, inserting the following two lines in the `if(ANDROID)` block (around line 710):
-.. code-block:: C
+.. code-block::
set_with_reason(vehicle/gpsd "Android detected" FALSE)
set_with_reason(map/garmin "Android detected" FALSE)
diff --git a/docs/development/linux_development.rst b/docs/development/linux_development.rst
index 20e613acd..e9802ea31 100644
--- a/docs/development/linux_development.rst
+++ b/docs/development/linux_development.rst
@@ -49,7 +49,7 @@ You can also try the ebuild in the overlay : [sunrise overlay](http://www.gentoo
based on the svn to have the latest version of navit.
Debian / Ubuntu dependencies
--------------------
+----------------------------
It compiles flawlessly on a Lenny (5.0) or later and on `Ubuntu 12.04 LTS` (Precise Pangolin) or later, once all dependencies installed.
@@ -59,23 +59,24 @@ Absolute minimum requirements:
.. code-block:: bash
- gcc cmake zlib1g-dev libpng12-dev libgtk2.0-dev librsvg2-bin
+ gcc cmake zlib1g-dev libpng12-dev libgtk2.0-dev librsvg2-bin
Note that not all these packages are strictly required (for example, maptool can be built without installing GTK+),
but this is the smallest practical set of packages if you want to run Navit.
- * Translations for the user interface: `gettext`
- * Maptool: `protobuf-c-compiler libprotobuf-c-dev`
- * GTK+ is included in minimum requirements. `libimlib2-dev` is needed to enable draw_image_warp function which, in turn
- allows to use raster maps as discussed in [track #1285](http://trac.navit-project.org/ticket/1285)
- * SDL: `libsdl-image1.2-dev libdevil-dev libglc-dev freeglut3-dev libxmu-dev libfribidi-dev`
- * OpenGL graphics: `libglc-dev freeglut3-dev libgl1-mesa-dev libxft-dev libglib2.0-dev libfreeimage-dev`
- * QT: `libqt4-dev` (This package will pull in all the required packages as dependencies.)
- * gpsd: `gpsd gpsd-clients libgps-dev` (optional, but certainly nice to have)
- * espeak: `espeak` (optional)
- * speechd: `libspeechd-dev` (optional, you are better off with using espeak)
- * dbus: `libdbus-glib-1-dev` (optional, you most likely don't need this.)
- * python: `python-dev` (optional, you most likely don't need this.)
- * saxon: `libsaxonb-java` (only required for android)
+
+ * Translations for the user interface: `gettext`
+ * Maptool: `protobuf-c-compiler libprotobuf-c-dev`
+ * GTK+ is included in minimum requirements. `libimlib2-dev` is needed to enable draw_image_warp function which, in turn
+ allows to use raster maps as discussed in [track #1285](http://trac.navit-project.org/ticket/1285)
+ * SDL: `libsdl-image1.2-dev libdevil-dev libglc-dev freeglut3-dev libxmu-dev libfribidi-dev`
+ * OpenGL graphics: `libglc-dev freeglut3-dev libgl1-mesa-dev libxft-dev libglib2.0-dev libfreeimage-dev`
+ * QT: `libqt4-dev` (This package will pull in all the required packages as dependencies.)
+ * gpsd: `gpsd gpsd-clients libgps-dev` (optional, but certainly nice to have)
+ * espeak: `espeak` (optional)
+ * speechd: `libspeechd-dev` (optional, you are better off with using espeak)
+ * dbus: `libdbus-glib-1-dev` (optional, you most likely don't need this.)
+ * python: `python-dev` (optional, you most likely don't need this.)
+ * saxon: `libsaxonb-java` (only required for android)
Everything in one command:
diff --git a/docs/development/programming_guidelines.rst b/docs/development/programming_guidelines.rst
index 0232697d8..3aecabcf7 100644
--- a/docs/development/programming_guidelines.rst
+++ b/docs/development/programming_guidelines.rst
@@ -89,7 +89,7 @@ use
struct mystruct m={0,};
- * Use `/*` and `*/` for comments instead of `//`
+* Use `/*` and `*/` for comments instead of `//`
.. note::
diff --git a/docs/development/wince_development.rst b/docs/development/wince_development.rst
index d08fbe8ae..423139460 100644
--- a/docs/development/wince_development.rst
+++ b/docs/development/wince_development.rst
@@ -4,13 +4,13 @@ WinCE Development
This is a tutorial for Navit on WinCE/WinMobile. If want just want to download a cab file see [[WinCE]].
-This page explains how to build Navit for WinCE/WinMobile with `cegcc <http://cegcc.sourceforge.net>`_.
+This page explains how to build Navit for WinCE/WinMobile with `cegcc <http://cegcc.sourceforge.net>`.
In November 2009 versions compiled using arm-cegcc-gcc (both revision 1214 and release 0.59.1) had problems (threw exception_datatype_misalignment and caused access violations).
Using the variant arm-mingw32ce of CeGCC 0.59.1 it was possible to build a working executable which can be debugged.
-The automatic builds from the subversion repository seem to use an adjusted? version arm-wince-mingw32ce (see `build logs <http://download.navit-project.org/logs/navit/wince/svn>`_).
+The automatic builds from the subversion repository seem to use an adjusted? version arm-wince-mingw32ce (see `build logs <http://download.navit-project.org/logs/navit/wince/svn>`).
Building using arm-mingw32ce
============================
@@ -81,7 +81,7 @@ Building using arm-cegcc
Building cegcc
--------------
-Set the install path to where you want to install `cegcc <http://cegcc.sourceforge.net cegcc>`_:
+Set the install path to where you want to install `cegcc <http://cegcc.sourceforge.net cegcc>`:
.. code-block:: bash
@@ -144,7 +144,7 @@ The current versions of these libs don't need many changes, but they all don't k
| -openstep* | -oskit* | -conix* | -pw32* | -nonstopux* \
zlib
-''''
+^^^^
.. code-block:: bash
@@ -157,7 +157,7 @@ zlib
make install
libiconv
-''''''''
+^^^^^^^^
.. code-block:: bash
@@ -171,7 +171,7 @@ libiconv
make install
gettext
-'''''''
+^^^^^^^
workaround for `plural-eval.h:50: error: expected '=', ',', ';', 'asm' or '__attribute__' before 'sigfpe_exit'`
extend gettext-tools/src/plural-eval.h line 32 to `#if defined _MSC_VER || defined __MINGW32__ || defined __CEGCC__`
@@ -189,7 +189,7 @@ dito for gettext-tools/gnulib-lib/wait-process.c line 31
make install
libpng
-''''''
+^^^^^^
.. code-block:: bash
@@ -202,9 +202,9 @@ libpng
make install
libtiff
-'''''''
+^^^^^^^
-.. code-block:: bash
+.. code-block::
libtool: link: CURRENT `' must be a nonnegative integer
@@ -220,9 +220,9 @@ libtiff
make install
glib
-''''
+^^^^
-.. code-block:: bash
+.. code-block::
gatomic.c:570: Error: no such instruction: `swp %eax,%eax,[%esi]'
diff --git a/docs/development/windows_development.rst b/docs/development/windows_development.rst
index 511f261c1..1c5248605 100644
--- a/docs/development/windows_development.rst
+++ b/docs/development/windows_development.rst
@@ -189,19 +189,19 @@ Downloads
---------
In order to compile the win32 version of Navit, you need the following software development tools
- * GTK+ toolkit for win32 from `SourceForgeDownload: Glade/GTK+ <http://sourceforge.net/project/showfiles.php?group_id=98754>`_ (select gtk+-win32-devel)
+ * GTK+ toolkit for win32 from `SourceForgeDownload: Glade/GTK+ <http://sourceforge.net/project/showfiles.php?group_id=98754>` (select gtk+-win32-devel)
* MinGW from `SourceForgeDownload: MinGW <http://sourceforge.net/project/showfiles.php?group_id=2435>`_ (select Automated MinGW installer)
- * MSYS from `SourceForgeDownload: MSYS Base System <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=2496>`_
- * msysCORE from `SourceForgeDownload: MSYS Base System <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=24963>`_
- * diffutils from `SourceForgeDownload: MSYS Base System <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=24963>`_
- * autoconf from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>`_
- * autogen from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>`_
- * automake from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>`_
- * gettext from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>`_
- * libtool from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>`_
- * libiconv from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/downloads/mingw/MinGW/libiconv>`_
-
-Probably the easiest way to obtain and install all the MSYS packages is to follow the instructions `here <http://www.mingw.org/wiki/msys>`_
+ * MSYS from `SourceForgeDownload: MSYS Base System <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=2496>`
+ * msysCORE from `SourceForgeDownload: MSYS Base System <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=24963>`
+ * diffutils from `SourceForgeDownload: MSYS Base System <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=24963>`
+ * autoconf from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>`
+ * autogen from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>`
+ * automake from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>`
+ * gettext from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>`
+ * libtool from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=67879>`
+ * libiconv from `SourceForgeDownload: MSYS Supplementary Tools <http://sourceforge.net/downloads/mingw/MinGW/libiconv>`
+
+Probably the easiest way to obtain and install all the MSYS packages is to follow the instructions `here <http://www.mingw.org/wiki/msys>`
For speech support, one option is to use the "cmdline" speech type (refer to [[Configuration]]) and a utility such as a Windows port of `Say <http://krolik.net/wsvn/wsvn/public/Say%2B%2B/>`_