From ab2cce050ad2c338c6a66133fa27877f7477882d Mon Sep 17 00:00:00 2001 From: Anil Madhavapeddy Date: Mon, 3 Jun 2019 17:59:59 +0100 Subject: [PATCH] doc: clarify the section semantics for file installation This is distilled from the opam manual and worth duplicating here since it describes a metadata format that can be used independently of opam. Closes #2198 Signed-off-by: Anil Madhavapeddy --- doc/dune-files.rst | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/dune-files.rst b/doc/dune-files.rst index 0a16e4bf126..ce2a8c616f9 100644 --- a/doc/dune-files.rst +++ b/doc/dune-files.rst @@ -664,20 +664,20 @@ The syntax is as follows: ``
`` is the installation section, as described in the opam manual. The following sections are available: -- ``lib`` -- ``lib_root`` -- ``libexec`` -- ``libexec_root`` -- ``bin`` -- ``sbin`` -- ``toplevel`` -- ``share`` -- ``share_root`` -- ``etc`` -- ``doc`` -- ``stublibs`` -- ``man`` -- ``misc`` +- ``lib`` installs to ``/lib//`` +- ``lib_root`` installs to ``/lib/`` +- ``libexec`` installs to ``/lib//``` with the executable bit set +- ``libexec_root`` installs to ``/lib/`` with the executable bit set +- ``bin`` installs to ``/bin/`` with the executable bit set +- ``sbin`` installs to ``/sbin/`` with the executable bit set +- ``toplevel`` installs to ``/lib/toplevel/`` +- ``share`` installs to ``/share//`` +- ``share_root`` installs to ``/share/`` +- ``etc`` installs to ``/etc//`` +- ``doc`` installs to ``/doc//`` +- ``stublibs`` installs to ``/lib/stublibs/`` with the executable bit set +- ``man`` installs relative to ``/man`` with the destination directory extracted from the extension of the source file (so that installing ``foo.1`` is equivalent to a destination of ``man1/foo.1`` +- ``misc`` requires files to specify an absolute destination, and the user will be prompted before the installation is done via opam. Only use this for advanced cases. ```` is the list of files to install. Each element in the list must be either a literal filename or a S-expression of the form: