mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-26 19:51:11 +00:00
Code Issues 1 Projects Releases Wiki Activity

RELEASE_README: add disk usage considerations section

Browse source 
Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-docs/-/merge_requests/95>
This commit is contained in:
Mathieu Duponchelle 2020-06-21 00:47:24 +02:00 committed by Tim-Philipp Müller
parent 4b37c27858
commit 059f092ca4
1 changed files with 24 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
scripts/RELEASE_README.md
View file

@ -1,10 +1,32 @@
# GStreamer documentation
This is the released version of the [GStreamer documentation](https://cgit.freedesktop.org/gstreamer/gst-docs), it contains
This is the released version of the [GStreamer documentation](https://gitlab.freedesktop.org/gstreamer/gst-docs), it contains
two folders:
* html/: The static website documentation which can be hosted anywhere and
read in any web browser.
* devhelp/: The documentation to be browsed with [devhelp](https://wiki.gnome.org/Apps/Devhelp).
The content of that folder should be installed in `/usr/share/gtk-doc/html/GStreamer-@GST_API_VERSION@/`
by documentation packages.
by documentation packages.
## Disk usage considerations
Both folders contain a "search" folder made up of a large amount
of very small files (50 K+). This can cause the unpacked size of both
these folders to grow up to 500 MB+ on filesystems that weren't
configured for such a use case (eg `mkfs.ext4 -Tnews`).
It is safe to remove these search folders, this will simply cause
the search box to be hidden when viewing the documentation.
If packages are produced both for the devhelp and html folders,
one may choose to remove the search folders for devhelp, as
devhelp exposes a (more limited) search feature, and keep the
search folder in the html package, so that users of the package
can replicate the behaviour of the online documentation with
the offline version.
Choosing to strip the search folders in both, either or neither
package is ultimately left to the packagers' discretion, users
of most distributions should usually have enough disk space
to accomodate these.