From: Thibault Saunier <tsaunier@igalia.com>
Date: Thu, 16 May 2019 17:57:05 +0000 (-0400)
Subject: Update the readme now that plugins doc cache is manually built
X-Git-Tag: 1.19.3~489^2~148
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=4a44f037e2df0fc4f79c4d7b00af63e2c8e7c69a;p=platform%2Fupstream%2Fgstreamer.git

Update the readme now that plugins doc cache is manually built

See https://gitlab.freedesktop.org/gstreamer/gst-docs/issues/36
---

diff --git a/README.md b/README.md
index 8d52cf8..bbaef17 100644
--- a/README.md
+++ b/README.md
@@ -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`