summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2021-11-23 21:19:17 (GMT)
committerCraig Scott <craig.scott@crascit.com>2021-11-23 21:20:04 (GMT)
commit699d4a98e291b48f54b5a1996cda69b78e7c7d4f (patch)
tree0b51d6c156b04b0c4d07ca98469f88e13970c469 /Help
parent9f07f1939ba604e4bb47493bb0165c848b9be9c4 (diff)
downloadCMake-699d4a98e291b48f54b5a1996cda69b78e7c7d4f.zip
CMake-699d4a98e291b48f54b5a1996cda69b78e7c7d4f.tar.gz
CMake-699d4a98e291b48f54b5a1996cda69b78e7c7d4f.tar.bz2
Help: Use definition list for allowed values of CMAKE_INSTALL_MODE
Clean up the wording as well for improved consistency and clarity.
Diffstat (limited to 'Help')
-rw-r--r--Help/envvar/CMAKE_INSTALL_MODE.rst35
1 files changed, 27 insertions, 8 deletions
diff --git a/Help/envvar/CMAKE_INSTALL_MODE.rst b/Help/envvar/CMAKE_INSTALL_MODE.rst
index 37db0d7..be617cc 100644
--- a/Help/envvar/CMAKE_INSTALL_MODE.rst
+++ b/Help/envvar/CMAKE_INSTALL_MODE.rst
@@ -19,14 +19,33 @@ symbolic links instead.
The following values are allowed for ``CMAKE_INSTALL_MODE``:
-* empty, unset or ``COPY``: default behavior, duplicate the file at its destination
-* ``ABS_SYMLINK``: create an *absolute* symbolic link to the source file at the destination *or fail*
-* ``ABS_SYMLINK_OR_COPY``: like ``ABS_SYMLINK`` but silently copy on error
-* ``REL_SYMLINK``: create an *relative* symbolic link to the source file at the destination *or fail*
-* ``REL_SYMLINK_OR_COPY``: like ``REL_SYMLINK`` but silently copy on error
-* ``SYMLINK``: try as if through ``REL_SYMLINK`` and fall back to ``ABS_SYMLINK`` if the referenced
- file cannot be expressed using a relative path. Fail on error.
-* ``SYMLINK_OR_COPY``: like ``SYMLINK`` but silently copy on error
+``COPY``, empty or unset
+ Duplicate the file at its destination. This is the default behavior.
+
+``ABS_SYMLINK``
+ Create an *absolute* symbolic link to the source file at the destination.
+ Halt with an error if the link cannot be created.
+
+``ABS_SYMLINK_OR_COPY``
+ Like ``ABS_SYMLINK`` but fall back to silently copying if the symlink
+ couldn't be created.
+
+``REL_SYMLINK``
+ Create a *relative* symbolic link to the source file at the destination.
+ Halt with an error if the link cannot be created.
+
+``REL_SYMLINK_OR_COPY``
+ Like ``REL_SYMLINK`` but fall back to silently copying if the symlink
+ couldn't be created.
+
+``SYMLINK``
+ Try as if through ``REL_SYMLINK`` and fall back to ``ABS_SYMLINK`` if the
+ referenced file cannot be expressed using a relative path.
+ Halt with an error if the link cannot be created.
+
+``SYMLINK_OR_COPY``
+ Like ``SYMLINK`` but fall back to silently copying if the symlink couldn't
+ be created.
Installing symbolic links rather than copying files can help conserve storage space because files do
not have to be duplicated on disk. However, modifications applied to the source immediately affects