[Pkg-erlang-devel] Erlang documentation chunks

Lukas Larsson lukas at erlang.org
Mon Dec 13 10:54:03 GMT 2021


Hello!

Since Erlang/OTP 23 it has been possible to build documentation chunks for
use by IDE's to fetch documentation about an Erlang function.

I noticed that the debian Erlang packages installs these chunks
in /usr/share/doc/erlang-doc/lib/stdlib-*/doc/chunks/.

The EEP (https://www.erlang.org/eeps/eep-0048#part-1-the-docsstorage)
specifies that the files should be located under app/doc/chunks in the
source tree, which for debian would mean
/usr/lib/erlang/stdlib-*/doc/chunks/.

Can the chunk files be moved to the correct place? And also, I think it
would be beneficial for everyone if the chunk files could be installed as
part of the erlang-base package instead of the erlang-docs package as then
IDEs and similar tools would always have access to them without having to
install additional packages.

In order to build and install only the documentation chunks you can use
this make command:

make install-docs DOC_TARGETS=chunks

Lukas
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://alioth-lists.debian.net/pipermail/pkg-erlang-devel/attachments/20211213/ce433576/attachment.htm>


More information about the Pkg-erlang-devel mailing list