summaryrefslogtreecommitdiff
path: root/HACKING.md
diff options
context:
space:
mode:
authorVille Skyttä <ville.skytta@iki.fi>2020-12-31 10:01:28 +0200
committerDavid Faure <faure@kde.org>2020-12-31 19:48:54 +0000
commitc1d1c70684dac11ce6c14a5089b5cb0b64a7dc27 (patch)
treef1e0aecfcce717b38b76f5c7ff32c2661c2d37ba /HACKING.md
parentc268d1c8c2e6e100dbb8df46d17df20bfd9be2fc (diff)
downloadshared-mime-info-c1d1c70684dac11ce6c14a5089b5cb0b64a7dc27.tar.gz
xdgmime: configure as submodule
So that we can bind it to a specific revision, and help with keeping clones up to date. GitLab CI instructs to use a relative path to submodules on the same GitLab server [0], but doing so causes a meson/ninja dist failure [1]. Configure using a full https URL for now, as it appears to work with GitLab just fine. [0] https://docs.gitlab.com/ce/ci/git_submodules.html [1] https://github.com/mesonbuild/meson/issues/8144
Diffstat (limited to 'HACKING.md')
-rw-r--r--HACKING.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/HACKING.md b/HACKING.md
index 2f4b9b51..eb001b27 100644
--- a/HACKING.md
+++ b/HACKING.md
@@ -35,9 +35,14 @@ more test files to be added to the test suite.
Test suite
----------
-You need to have xdgmime checked out [1] and compiled. By default, the build
-system will expect the source directory to be in the shared-mime-info
-directory. `./xdgmime/src/test-mime-data` will be run against
+You need to have xdgmime [1] checked out and compiled. In the shared-mime-info
+git repository, getting xdgmime is taken care of by using a git submodule; run
+`git submodule update --init` after cloning the shared-mime-info repo. If
+you wish to keep the submodule automatically up to date on pull, `git config
+submodule.recurse true` in the shared-mime-info dir helps with that.
+
+By default, the build system will expect the xdgmime directory to be in the
+shared-mime-info directory. `./xdgmime/src/test-mime-data` is run against
`tests/mime-detection/list`. An alternate path to xdgmime can be passed by
using the `xdgmime-path` meson option such as `-Dxdgmime-path=/path/to/xdgmime`.