Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
Alba Mendez
gst-docs
Commits
4a44f037
Commit
4a44f037
authored
May 16, 2019
by
Thibault Saunier
🌵
Browse files
Update the readme now that plugins doc cache is manually built
See
gstreamer/gst-docs#36
parent
cf9239a4
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
4a44f037
...
...
@@ -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 th
e
g
it
repository.
Then
you need to regenerate
the
`gst_plugins_cache.json`
file
by running
the
target manually, if building from the modul
e it
self:
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`
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment