mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-07-03 21:25:54 +00:00
Code Issues 1 Projects Releases Wiki Activity

Update the readme now that plugins doc cache is manually built

Browse source 
See https://gitlab.freedesktop.org/gstreamer/gst-docs/issues/36
This commit is contained in:
Thibault Saunier 2019-05-16 13:57:05 -04:00
parent cf9239a46b
commit 4a44f037e2
1 changed files with 15 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -84,10 +84,22 @@ gst_elements = library('gstcoreelements',
plugins += [gst_elements]
```
Then when rebuilding, the `gst_plugins_cache.json` file will be updated
in the given module and this change should be commited to the git repository.
Then you need to regenerate the `gst_plugins_cache.json` file by running
the target manually, if building from the module itself:
The plugins documentation is generated exclusively based on that file to
```
ninja -C <build-dir> docs/gst_plugins_cache.json
```
if you use `gst-build` you can run the target that will rebuild all cache files:
```
ninja -C <build-dir> plugins_doc_caches`
```
NOTE: the newly generated cache should be commited to the git repos.
The plugins documentation is generated based on that file to
avoid needing to have built all plugins to get the documentation generated.
NOTE: When moving plugins from one module to another, the `gst_plugins_cache.json`