mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-04-22 06:09:14 -05:00
Code Issues Packages Projects Releases Wiki Activity

Modules: Update documentation formatting

Browse Source
This commit is contained in:
Bartosz Kosiorek
2019-04-05 17:22:38 +02:00
parent 0e4fbb4a1f
commit cb33befe2d
21 changed files with 146 additions and 141 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Help/command/find_package.rst
+6 -6
View File
@@ -234,7 +234,7 @@ Each entry is meant for installation trees following Windows (``W``), UNIX
<prefix>/<name>*/(lib/<arch>|lib*|share)/<name>*/ (W/U)
<prefix>/<name>*/(lib/<arch>|lib*|share)/<name>*/(cmake|CMake)/ (W/U)
On systems supporting macOS :prop_tgt:`FRAMEWORK`s and :prop_tgt:`BUNDLE`s the
On systems supporting macOS :prop_tgt:`FRAMEWORK` and :prop_tgt:`BUNDLE`, the
following directories are searched for Frameworks or Application Bundles
containing a configuration file::
@@ -262,16 +262,16 @@ that order).
* The ``lib`` path is always searched.
If ``PATH_SUFFIXES`` is specified, the suffixes are appended to each
(W) or (U) directory entry one-by-one.
(``W``) or (``U``) directory entry one-by-one.
This set of directories is intended to work in cooperation with
projects that provide configuration files in their installation trees.
Directories above marked with (W) are intended for installations on
Directories above marked with (``W``) are intended for installations on
Windows where the prefix may point at the top of an application's
installation directory. Those marked with (U) are intended for
installation directory. Those marked with (``U``) are intended for
installations on UNIX platforms where the prefix is shared by multiple
packages. This is merely a convention, so all (W) and (U) directories
are still searched on all platforms. Directories marked with (A) are
packages. This is merely a convention, so all (``W``) and (``U``) directories
are still searched on all platforms. Directories marked with (``A``) are
intended for installations on Apple platforms. The
:variable:`CMAKE_FIND_FRAMEWORK` and :variable:`CMAKE_FIND_APPBUNDLE`
variables determine the order of preference.
Help/cpack_gen/nsis.rst
+6 -6
View File
@@ -54,7 +54,7 @@ on Windows Nullsoft Scriptable Install System.
.. variable:: CPACK_NSIS_COMPRESSOR
The arguments that will be passed to the NSIS `SetCompressor command.
The arguments that will be passed to the NSIS `SetCompressor` command.
.. variable:: CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL
@@ -71,8 +71,8 @@ on Windows Nullsoft Scriptable Install System.
.. variable:: CPACK_NSIS_DISPLAY_NAME
The display name string that appears in the Windows `Add/Remove Program`
control panel
The display name string that appears in the Windows `Apps & features`
in `Control Panel`
.. variable:: CPACK_NSIS_PACKAGE_NAME
@@ -102,15 +102,15 @@ on Windows Nullsoft Scriptable Install System.
.. variable:: CPACK_NSIS_CREATE_ICONS_EXTRA
Additional NSIS commands for creating start menu shortcuts.
Additional NSIS commands for creating `Start Menu` shortcuts.
.. variable:: CPACK_NSIS_DELETE_ICONS_EXTRA
Additional NSIS commands to uninstall start menu shortcuts.
Additional NSIS commands to uninstall `Start Menu` shortcuts.
.. variable:: CPACK_NSIS_EXECUTABLES_DIRECTORY
Creating NSIS start menu links assumes that they are in ``bin`` unless this
Creating NSIS `Start Menu` links assumes that they are in ``bin`` unless this
variable is set. For example, you would set this to ``exec`` if your
executables are in an exec directory.
Help/envvar/ASM_DIALECT.rst
+1 -1
View File
@@ -5,7 +5,7 @@ ASM<DIALECT>
Preferred executable for compiling a specific dialect of assembly language
files. ``ASM<DIALECT>`` can be ``ASM``, ``ASM_NASM`` (Netwide Assembler),
``ASM_MASM`` (Microsoft Assembler) or ``ASM-ATT`` (Asembler AT&T).
``ASM_MASM`` (Microsoft Assembler) or ``ASM-ATT`` (Assembler AT&T).
Will only be used by CMake on the first configuration to determine
``ASM<DIALECT>`` compiler, after which the value for ``ASM<DIALECT>`` is stored
in the cache as
Help/envvar/ASM_DIALECTFLAGS.rst
+3 -3
View File
@@ -7,7 +7,7 @@ Default compilation flags to be used when compiling a specific dialect of an
assembly language. ``ASM<DIALECT>FLAGS`` can be ``ASMFLAGS``, ``ASM_NASMFLAGS``,
``ASM_MASMFLAGS`` or ``ASM-ATTFLAGS``. Will only be used by CMake on the
first configuration to determine ``ASM_<DIALECT>`` default compilation
flags, after which the value for ``ASM<DIALECT>FLAGS`` is stored in the cache as
``CMAKE_ASM<DIALECT>_FLAGS <CMAKE_<LANG>_FLAGS>``. For any configuration
run (including the first), the environment variable will be ignored if the
flags, after which the value for ``ASM<DIALECT>FLAGS`` is stored in the cache
as ``CMAKE_ASM<DIALECT>_FLAGS <CMAKE_<LANG>_FLAGS>``. For any configuration
run (including the first), the environment variable will be ignored, if the
``CMAKE_ASM<DIALECT>_FLAGS <CMAKE_<LANG>_FLAGS>`` variable is defined.
Help/manual/ctest.1.rst
+4 -4
View File
@@ -369,11 +369,11 @@ is computed as::
where:
* ``raw_test_time[j,i]``: Wall-clock time for the ``i``th test
for the ``j``th label or subproject
* ``raw_test_time[j,i]``: Wall-clock time for the ``i`` test
for the ``j`` label or subproject
* ``num_processors[j,i]``: Value of the CTest :prop_test:`PROCESSORS` property
for the ``i``th test for the ``j``th label or subproject
* ``num_tests[j]``: Number of tests associated with the ``j``th label or subproject
for the ``i`` test for the ``j`` label or subproject
* ``num_tests[j]``: Number of tests associated with the ``j`` label or subproject
* ``total``: Total number of labels or subprojects that have at least one test run
Therefore, the weighted time summary for each label or subproject represents
Help/prop_sf/VS_DEPLOYMENT_CONTENT.rst
+1 -1
View File
@@ -3,7 +3,7 @@ VS_DEPLOYMENT_CONTENT
Mark a source file as content for deployment with a Windows Phone or
Windows Store application when built with a
:manual:`Visual Studio generators <cmake-generators(7)>`.
:manual:`Visual Studio generators <cmake-generators(7)>`.
The value must evaluate to either ``1`` or ``0`` and may use
:manual:`generator expressions <cmake-generator-expressions(7)>`
to make the choice based on the build configuration.
Help/variable/CMAKE_STAGING_PREFIX.rst
+1 -1
View File
@@ -6,7 +6,7 @@ be useful if the path in :variable:`CMAKE_SYSROOT` is read-only, or otherwise
should remain pristine.
The :variable:`CMAKE_STAGING_PREFIX` location is also used as a search prefix
by the ``find_*`` commands. This can be controlled by setting the
by the ``find_*`` commands. This can be controlled by setting the
:variable:`CMAKE_FIND_NO_INSTALL_PREFIX` variable.
If any ``RPATH``/``RUNPATH`` entries passed to the linker contain the
Help/variable/CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst
+1 -1
View File
@@ -5,7 +5,7 @@ Ask CPack to error out as soon as a file with absolute ``INSTALL DESTINATION``
is encountered.
The fatal error is emitted before the installation of the offending
file takes place. Some CPack generators, like :cpack_gen:`nsis`, enforce this
file takes place. Some CPack generators, like ``NSIS``, enforce this
internally. This variable triggers the definition
of :variable:`CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION` when CPack
runs.