From 2e1164926481c10f04898e04f1d2e2e4c711d500 Mon Sep 17 00:00:00 2001 From: "L. E. Segovia" Date: Wed, 22 Jan 2025 13:14:03 -0300 Subject: [PATCH] docs: Move all references to gst-indent-1.0 Part-of: --- subprojects/gst-docs/markdown/contribute/index.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/subprojects/gst-docs/markdown/contribute/index.md b/subprojects/gst-docs/markdown/contribute/index.md index d77995b9d9..4ed401fbd2 100644 --- a/subprojects/gst-docs/markdown/contribute/index.md +++ b/subprojects/gst-docs/markdown/contribute/index.md @@ -427,11 +427,11 @@ In the simplest case, you might be able to get away with just doing a `git pull #### Coding Style Try to stick to the GStreamer indentation and coding style. There is an -application called [`gst-indent`][gst-indent] which should be available +application called [`gst-indent-1.0`][gst-indent] which should be available in a GStreamer development environment and which you can run over your `.c` or `.cpp` files if you want your code auto-indented before making the patch. -Please do _not_ run `gst-indent` on header files, our header file +Please do _not_ run `gst-indent-1.0` on header files, our header file indentation is free-form. If you build GStreamer from git, a local commit hook will be installed that @@ -439,6 +439,11 @@ checks if your commit conforms to the required style. You can bypass that local indentation check hook by using `git commit -n`, but it will still be checked again later on the CI when you submit your changes through GitLab for merging. +If `gst-indent-1.0` is not found on your system at setup time, it will be +supplied from the Meson wrap in the main project; you must build GStreamer +once, and that will make `gst-indent-1.0` available to the developer +environment. + We are working on making this less hasslesome. Compiler requirements: