[gedit] docs: install: add more details
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gedit] docs: install: add more details
- Date: Wed, 28 Aug 2019 04:43:27 +0000 (UTC)
commit 712923cd4d918bf4476b3e3550fb0ad54400a028
Author: Sébastien Wilmet <swilmet gnome org>
Date: Wed Aug 28 04:56:37 2019 +0200
docs: install: add more details
The content from the Build section of
gedit-development-getting-started.md is moved to install.md.
And write many more explanations.
docs/gedit-development-getting-started.md | 19 ++-----
docs/install.md | 92 +++++++++++++++++++++++++++----
2 files changed, 85 insertions(+), 26 deletions(-)
---
diff --git a/docs/gedit-development-getting-started.md b/docs/gedit-development-getting-started.md
index fff96013e..69dc5689a 100644
--- a/docs/gedit-development-getting-started.md
+++ b/docs/gedit-development-getting-started.md
@@ -57,21 +57,10 @@ gedit core provides:
There is a class diagram of gedit core in the file `class-diagram.dia` (but it
may be outdated, see the Git log for that file).
-Build
------
-
-To compile the gedit source code from the Git repository, plus all the GNOME
-dependencies from Git as well, it is recommended to use one of the following
-build tool:
-- [Jhbuild](https://developer.gnome.org/jhbuild/unstable/)
-- Or [BuildStream](https://buildstream.build/)
-- Or [Flatpak](https://flatpak.org/)
-
-Jhbuild tips:
-- Try `ignore_suggests = True` in your jhbuildrc to have fewer dependencies to
- build (see the difference with "jhbuild list gedit"). Another solution is to
- put some modules in the skip variable in jhbuildrc.
-- Build also the dconf module to get preferences saved.
+Build/Installation
+------------------
+
+See the file `install.md`.
First contribution
------------------
diff --git a/docs/install.md b/docs/install.md
index 07dcf402b..3d9b04949 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -1,23 +1,93 @@
gedit installation by building the source code
==============================================
-gedit uses the [Meson](https://mesonbuild.com/) build system.
+Recommendation to install in a separate prefix
+----------------------------------------------
+
+Once you have built gedit from source, you cannot run the application from its
+build directory: you need to install it with `ninja install`. For this reason it
+is highly recommended that you install in a separate prefix instead of
+overwriting your system binaries.
+
+Note however that when running gedit from a custom prefix you will need to set
+many environment variables accordingly, for instance `PATH` and `XDG_DATA_DIR`.
+
+There exists several tools that GNOME developers use to take care of all of
+this. See the _Tools_ section below.
+
+Installation of the dependencies
+--------------------------------
+
+You need to have all gedit dependencies installed, with recent enough versions.
+If a dependency is missing or is too old, the build configuration fails (you can
+try to run the build configuration command for gedit until it succeeds, see the
+procedure below).
+
+You can install the dependencies by installing packages provided by your
+operating system, for example on Fedora:
+```
+# dnf builddep gedit
+```
+
+But if your version of gedit provided by the OS differs too much from the
+version of gedit you want to build from source, you'll need to install the new
+dependencies from source too, and it can become a complicated task if you do it
+manually.
+
+Also, during gedit development, gedit may depend on a not-yet-released
+development version of a GNOME dependency. So certain GNOME dependencies may
+need to be installed from Git.
-### Installation from Git
+That's why if you have difficulties installing recent enough versions of the
+dependencies, it is usually easier to use one of the tools explained in the next
+section.
-During gedit development, gedit may depend on a development version of a GNOME
-dependency. To install gedit plus its GNOME dependencies all from Git, see the
-file `docs/gedit-development-getting-started.md`.
+Tools
+-----
-### Installation from a tarball for a stable version
+There are several tools available that take care of the following:
+- Install in a separate prefix.
+- Build or install dependencies.
+- Plus, for some tools: run in a container/sandbox.
-Simple procedure to install gedit onto the system:
+GNOME developers usually use one of these tools:
+- [Jhbuild](https://developer.gnome.org/jhbuild/unstable/)
+- Or [BuildStream](https://buildstream.build/)
+- Or [Flatpak](https://flatpak.org/)
+
+Jhbuild tips:
+- Try `ignore_suggests = True` in your jhbuildrc to have fewer dependencies to
+ build (see the difference with "jhbuild list gedit"). Another solution is to
+ put some modules in the skip variable in jhbuildrc.
+- Build also the dconf module to get preferences saved.
+
+Building the gedit module manually
+----------------------------------
+
+If you use one of the above tools, you don't need all the explanations in this
+section. But it can be instructive.
+
+gedit uses the [Meson](https://mesonbuild.com/) build system.
+
+Once the dependencies are installed, here are simple procedures to finally build
+the gedit module from source.
+
+### Installation onto the system
+
+**Warning**: this procedure doesn't install in a separate prefix, so it may
+overwrite your system binaries.
```
-$ meson builddir && cd builddir # Build configuration
-$ ninja # Build
+$ mkdir build && cd build/
+$ meson # Build configuration
+$ ninja # Build
[ Become root if necessary ]
-$ ninja install # Installation
+$ ninja install # Installation
```
-If certain dependencies are too old, see the procedure to install from Git.
+### Installation in a separate prefix
+
+Just change the above `meson` command by:
+```
+$ meson --prefix YOUR_PREFIX
+```
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]