summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChad Elliott <elliottc@objectcomputing.com>2022-10-26 08:00:46 -0500
committerChad Elliott <elliottc@objectcomputing.com>2022-10-26 08:00:46 -0500
commitdf6fab372ee02e9dba8232014f95e33ae8f89ca9 (patch)
tree44f71d83272275dbcb58109bffc3df858a3f5545 /docs
parent65a3e3a6c3e303057d9eb3f4124a486b741d445d (diff)
downloadMPC-df6fab372ee02e9dba8232014f95e33ae8f89ca9.tar.gz
Added information on CMake support.
Diffstat (limited to 'docs')
-rw-r--r--docs/USAGE8
-rw-r--r--docs/html/MakeProjectCreator.html30
-rw-r--r--docs/templates/cmake.txt14
3 files changed, 45 insertions, 7 deletions
diff --git a/docs/USAGE b/docs/USAGE
index 49b3c5d1..47eac0ba 100644
--- a/docs/USAGE
+++ b/docs/USAGE
@@ -24,10 +24,10 @@ Usage: mwc.pl [-global <file>] [-include <directory>] [-recurse]
[-workers <#>] [-workers_dir <dir> | -workers_port <#>]
[-language <cplusplus | csharp | java | vb>]
[-type <automake | bcb2007 | bcb2009 | bds4 | bmake | cc | cdt6 |
- cdt7 | em3 | ghs | html | iar | make | nmake | rpmspec |
- sle | uvis | vc6 | vc7 | vc71 | vc8 | vc9 | vc10 | vc11 |
- vc12 | vc14 | vs2017 | vs2019 | vs2022 | wb26 | wb30 |
- wix>]
+ cdt7 | cmake | em3 | ghs | html | iar | make | nmake |
+ rpmspec | sle | uvis | vc6 | vc7 | vc8 | vc9 | vc10 |
+ vc11 | vc12 | vc14 | vc71 | vs2017 | vs2019 | vs2022 |
+ wb26 | wb30 | wix>]
[files]
-base Add <project> as a base project to each generated
diff --git a/docs/html/MakeProjectCreator.html b/docs/html/MakeProjectCreator.html
index d62bafb7..bede62d4 100644
--- a/docs/html/MakeProjectCreator.html
+++ b/docs/html/MakeProjectCreator.html
@@ -286,6 +286,18 @@
<tr>
<td rowspan="1" colspan="1">
<p class="Tbl-Body">
+ <em class="TableCode">cmake</em>
+ </p>
+ </td>
+
+ <td rowspan="1" colspan="1">
+ <p class="Tbl-Body">Support for CMake requires user provided modules for custom commands.</p>
+ </td>
+ </tr>
+
+ <tr>
+ <td rowspan="1" colspan="1">
+ <p class="Tbl-Body">
<em class="TableCode">em3</em>
</p>
</td>
@@ -6782,7 +6794,7 @@ class="Code">specific</em> clause.
</blockquote>
<p class="Body">
- The following mpc file (<em class=
+ The following .mpc file (<em class=
"Code">RTEC_Perf.mpc</em> ) shows the simple and small number of
lines required to generate usable build tool project files.
</p>
@@ -6899,7 +6911,9 @@ class="Code">specific</em> clause.
Line five adds <em class=
"Code">TAO_RTEC_PERF_BUILD_DLL</em> to the <em class=
"Code">dllflags</em>, which defines a macro that is used by the
- <em class="Code">rtec_perf_export.h</em> header file.
+ <em class="Code">rtec_perf_export.h</em> header file when
+ building shared libraries on platforms that support symbol
+ visibility.
</p>
<blockquote>
@@ -8174,7 +8188,7 @@ class="Code">specific</em> clause.
<blockquote>
- <p class="Code">document_template.pl v1.3</p>
+ <p class="Code">document_template.pl v1.4</p>
<p class="Code">
Usage: document_template.pl &lt;template&gt;
@@ -8184,6 +8198,16 @@ class="Code">specific</em> clause.
<p class="Code">&nbsp;</p>
<p class="Code">
+ template &nbsp;&nbsp;&nbsp;- .mpd file to document. Certain MPC types don't
+ use a template,
+ </p>
+
+ <p class="Code">
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;in that case this aregument can be the Perl module.
+ </p>
+
+ <p class="Code">
html output - This defaults to the name of the
template file with the .mpd
</p>
diff --git a/docs/templates/cmake.txt b/docs/templates/cmake.txt
new file mode 100644
index 00000000..391fd72f
--- /dev/null
+++ b/docs/templates/cmake.txt
@@ -0,0 +1,14 @@
+// Current as of 10/26/2022
+// This defines the role of all the template variables specific to the
+// 'cmake' project type.
+//
+// Please try to keep this alphabetically sorted.
+//
+cmake_minimum_required = Sets the minimum required version for CMake.
+env_dllout = The value of 'dllout' with &#36;() values converted to &#36;ENV{}.
+env_exeout = The value of 'exeout' with &#36;() values converted to &#36;ENV{}.
+env_includes = The value of 'includes' with &#36;() values converted to &#36;ENV{}.
+env_libout = The value of 'libout' with &#36;() values converted to &#36;ENV{}.
+env_libpaths = The value of 'libpaths' with &#36;() values converted to &#36;ENV{}.
+packages = A list of packages to be used with the find_package() command.
+pre_find_package = A specific command or set of commands to be issued before any find_package() commands are called.