mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-03-13 07:02:53 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: Move all references to gst-indent-1.0

Browse source 
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/5192>
This commit is contained in:
L. E. Segovia 2025-01-22 13:14:03 -03:00
parent 3213e641ec
commit 2e11649264
1 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
subprojects/gst-docs/markdown/contribute/index.md
View file

@ -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: