diff options
| author | Jeff Johnston | 2018-03-06 22:16:48 +0000 |
|---|---|---|
| committer | Jeff Johnston | 2018-03-07 17:15:56 +0000 |
| commit | d468345bc3ecaab157fbc7a423ec9b22740f22af (patch) | |
| tree | 1ba3d5c100850dd2e4c02a3a5e294521f8c5bf3c | |
| parent | 13b1894c4c5003a8b7697b90ca1208b047c9798e (diff) | |
| download | org.eclipse.cdt-d468345bc3ecaab157fbc7a423ec9b22740f22af.tar.gz org.eclipse.cdt-d468345bc3ecaab157fbc7a423ec9b22740f22af.tar.xz org.eclipse.cdt-d468345bc3ecaab157fbc7a423ec9b22740f22af.zip | |
Add Meson docs plug-in
Change-Id: I9153edd6f2708de475855ca3dbdb6323432e37ac
33 files changed, 812 insertions, 1 deletions
diff --git a/build/org.eclipse.cdt.meson-feature/feature.xml b/build/org.eclipse.cdt.meson-feature/feature.xml index 352177769da..4554e196376 100644 --- a/build/org.eclipse.cdt.meson-feature/feature.xml +++ b/build/org.eclipse.cdt.meson-feature/feature.xml @@ -2,7 +2,7 @@ <feature id="org.eclipse.cdt.meson" label="%featureName" - version="9.4.0.qualifier" + version="9.5.0.qualifier" provider-name="%providerName" license-feature="org.eclipse.license" license-feature-version="0.0.0"> @@ -34,6 +34,12 @@ unpack="false"/> <plugin + id="org.eclipse.cdt.meson.docs" + download-size="0" + install-size="0" + version="0.0.0"/> + + <plugin id="org.eclipse.cdt.meson.ui.editor" download-size="0" install-size="0" diff --git a/build/org.eclipse.cdt.meson.docs/.project b/build/org.eclipse.cdt.meson.docs/.project new file mode 100644 index 00000000000..51a8504127b --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/.project @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>org.eclipse.cdt.meson.docs</name> + <comment></comment> + <projects> + </projects> + <buildSpec> + <buildCommand> + <name>org.eclipse.pde.ManifestBuilder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.pde.SchemaBuilder</name> + <arguments> + </arguments> + </buildCommand> + </buildSpec> + <natures> + <nature>org.eclipse.pde.PluginNature</nature> + </natures> +</projectDescription> diff --git a/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Building.html b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Building.html new file mode 100644 index 00000000000..051e4aa5a4d --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Building.html @@ -0,0 +1,77 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Meson Plug-in User Guide - Building</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Building</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Configuration.html" title="Configuration"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Updating-This-Document.html" title="Updating This Document"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Configuration</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Updating This Document</td> + </tr> + </table><hr class="navigation-separator"/> + <h1 id="Building">Building</h1> + <p>There are a number of ways to build the Meson project.</p> + <p>Using the Launch bar, just hit the hammer: + <img border="0" src="images/MesonHammerIcon.png"/> icon and the project will be built appropriately for the launch type. If the project is unconfigured, any options specified in the Property Page are used to run the <i>meson</i> command. Otherwise, just the buildtype is defaulted according to the launch target in the Launch bar (run = release, debug = debug). + </p> + <p>If any errors occur during the <i>meson</i> stage, they are reported and the build is stopped. Otherwise, the <i>ninja</i> command is run and the results output to the build console.</p> + <p> + <img border="0" src="images/MesonLaunchbarBuild.png"/> + </p> + <p>The build can also be started using the Eclipse hammer: + <img border="0" src="images/MesonHammerIcon.png"/> icon or via Project -> Build. + </p> + <p>Cleaning the project is done using Project -> Clean. The clean operation performs a <i>meson clean</i> command for the active configuration.</p> + <p> + <img border="0" src="images/MesonCleanBuild.png"/> + </p> + <p>If the user needs to build a different target (e.g. <i>install</i>) or specify environment variables to ninja, then they must use the <b>Run ninja</b> context menu item that is available when right-clicking on a project or file in the project in the Project Explorer View. This brings up the <i>Run Ninja</i> dialog.</p> + <p> + <img border="0" src="images/MesonRunNinja.png"/> + </p><hr class="navigation-separator"/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Configuration.html" title="Configuration"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="User-Guide.html" title="Meson Plug-in User Guide"> + <img alt="Meson Plug-in User Guide" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Updating-This-Document.html" title="Updating This Document"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Configuration</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Updating This Document</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Configuration.html b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Configuration.html new file mode 100644 index 00000000000..9ac8b9d418e --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Configuration.html @@ -0,0 +1,75 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Meson Plug-in User Guide - Configuration</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Configuration</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Creating-a-Meson-Project.html" title="Creating a Meson Project"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Building.html" title="Building"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Creating a Meson Project</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Building</td> + </tr> + </table><hr class="navigation-separator"/> + <h1 id="Configuration">Configuration</h1> + <p>To specify configuration options, go to Project -> Properties -> Meson</p> + <p>The <b>meson</b> command without arguments can only be run for a build directory once. After it has been run once, a user may use the <b>meson configure</b> command to change some parameters of the configuration. Thus, there are two UI pages presented to the user:</p> + <ol> + <li>specifying options for meson prior to the first configuration/build</li> + <li>specifying options for meson configure after the project has been configured at least once</li> + </ol> + <p>Before the first configuration, the Meson plug-ins use the output of the <i>meson -h</i> command and parses the output to create the UI page.</p> + <p> + <img border="0" src="images/MesonUnconfiguredPropertyPage.png"/> + </p> + <p>Parameters that have a set of values are presented as a combo, boolean options are presented as a checkbox, and string options are presented as text boxes. In addition, the user may specify Project specific options and Environment variables. Project specified options are created in a special file called <b>meson_options.txt</b> and are set like a compiler flag (-Dname[=value]). The project specified options are not parsed by the Meson plug-ins so the user must know what is possible ahead of configuration. Environment variables are specified as NAME=VALUE pairs and are used during the <i>meson</i> command (e.g. CC=/my/dir/gcc).</p> + <p>By default, the meson buildtype parameter is set based on the active configuration launch type (run = release, debug = debug). The user can override this prior to configuration and change the build type as needed (e.g. debugoptimized or plain). Likewise, the user can simply change the launch type using the Launch bar.</p> + <p>After configuration, the Meson plug-in uses the output of <i>meson configure</i> to get the set of options that can be changed and parses them to create the UI page. Project options are returned as part of the output and are parsed like any other option (presented either as a combo, checkbox, or text entry).</p> + <p> + <img border="0" src="images/MesonConfigurePropertyPage.png"/> + </p> + <p>Hitting the <b>Apply</b> or <b>Apply and Close</b> buttons will end up running the <i>meson configure</i> command immediately with any options that have been changed in the dialog.</p><hr class="navigation-separator"/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Creating-a-Meson-Project.html" title="Creating a Meson Project"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="User-Guide.html" title="Meson Plug-in User Guide"> + <img alt="Meson Plug-in User Guide" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Building.html" title="Building"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Creating a Meson Project</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Building</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Creating-a-Meson-Project.html b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Creating-a-Meson-Project.html new file mode 100644 index 00000000000..6081f2e315f --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Creating-a-Meson-Project.html @@ -0,0 +1,68 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Meson Plug-in User Guide - Creating a Meson Project</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Creating a Meson Project</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Supported-Environments.html" title="Supported Environments"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Configuration.html" title="Configuration"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Supported Environments</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Configuration</td> + </tr> + </table><hr class="navigation-separator"/> + <h1 id="Creating_a_Meson_Project">Creating a Meson Project</h1> + <p>To create a Meson project, use File -> New -> C/C++ Project Either find the Meson projects in the list of all projects or click on <b>Meson</b> in the left-hand column to filter out non-Meson projects.</p> + <p> + <img border="0" src="images/MesonNewProjectDialog.png"/> + </p> + <p>There are two choices: Empty Project or Meson Project. Since Meson projects configure whether they support C, C++, or both, there is no need to specify a language as is done for the old Managed Build projects. The Empty Project template means that no files will be supplied to the new project while the Meson Project is a sample C hello world program that uses Meson for configuring the build. </p> + <p>To use a Meson project you have checked out in your system, choose the Empty Project template and then change the location of the project to point to where the project exists on your system.</p> + <p> + <img border="0" src="images/MesonExistingProject.png"/> + </p> + <p>The Meson plug-ins will perform builds in the <b>build</b> directory with a separate directory per configuration. (e.g. {$Project}/build/default). By default, there are two basic configurations, <b>run</b> and <b>debug</b>. </p><hr class="navigation-separator"/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Supported-Environments.html" title="Supported Environments"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="User-Guide.html" title="Meson Plug-in User Guide"> + <img alt="Meson Plug-in User Guide" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Configuration.html" title="Configuration"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Supported Environments</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Configuration</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Supported-Environments.html b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Supported-Environments.html new file mode 100644 index 00000000000..058e5274c2d --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Supported-Environments.html @@ -0,0 +1,59 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Meson Plug-in User Guide - Supported Environments</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Supported Environments</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="User-Guide.html" title="Meson Plug-in User Guide"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Creating-a-Meson-Project.html" title="Creating a Meson Project"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Meson Plug-in User Guide</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Creating a Meson Project</td> + </tr> + </table><hr class="navigation-separator"/> + <h1 id="Supported_Environments">Supported Environments</h1> + <p>The Meson plug-ins work on all the platforms that CDT supports.</p><hr class="navigation-separator"/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="User-Guide.html" title="Meson Plug-in User Guide"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="User-Guide.html" title="Meson Plug-in User Guide"> + <img alt="Meson Plug-in User Guide" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Creating-a-Meson-Project.html" title="Creating a Meson Project"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Meson Plug-in User Guide</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Creating a Meson Project</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Updating-This-Document.html b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Updating-This-Document.html new file mode 100644 index 00000000000..c18c44a58b1 --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/Updating-This-Document.html @@ -0,0 +1,54 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Meson Plug-in User Guide - Updating This Document</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Updating This Document</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Building.html" title="Building"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"></td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Building</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top"></td> + </tr> + </table><hr class="navigation-separator"/> + <h1 id="Updating_This_Document">Updating This Document</h1> + <p>This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit + + <a href="http://wiki.eclipse.org/CDT/Meson/User_Guide">http://wiki.eclipse.org/CDT/Meson/User_Guide</a> + </p><hr class="navigation-separator"/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Building.html" title="Building"> + <img alt="Previous" border="0" src="../../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="User-Guide.html" title="Meson Plug-in User Guide"> + <img alt="Meson Plug-in User Guide" border="0" src="../../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"></td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Building</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top"></td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/User-Guide.html b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/User-Guide.html new file mode 100644 index 00000000000..caa7687d8dd --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/User-Guide.html @@ -0,0 +1,61 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Meson Plug-in User Guide</title> + <link type="text/css" rel="stylesheet" href="../../../book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Meson Plug-in User Guide</th> + </tr> + <tr> + <td style="width: 20%" align="left"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Supported-Environments.html" title="Supported Environments"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Supported Environments</td> + </tr> + </table><hr class="navigation-separator"/> + <h1 id="Introduction">Introduction</h1> + <p>The Meson feature for Eclipse is an optional feature of the CDT (C/C++ Development Tools) that adds support for maintaining and + building C/C++ projects that use the Meson build system. The Meson build system is akin to Autotools in that a project is configured before building. Like Autotools, configuration involves testing the build system and toolsets supported. Once configured, the project is built by a second tool, akin to the Make tool used in Autotools. While Meson supports more than one Make-like tool to build the project, the CDT Meson plug-ins currently only have support for "ninja".</p> + <p>The configuration data for the project is stored in a file called: "meson.build". This file contains directives that are interpreted by the <b>meson</b> command. Directives include which languages are used, what executables/targets are created, sources, special configuration options, and any special build-time tests among other things. Many tests are automatic so the configuration file does not require much.</p> + <p>The following is a sample <i>meson.build</i> file:</p> + <p><code> + project('hello', 'c') + <br/> + executable('hello', 'hello.c') +</code> + </p> + <p>This file tells <i>meson</i> that the project name hello is a C project and that it creates a single executable called <i>hello</i> which is formed from <i>hello.c</i>. Meson will find the C compiler, etc.. needed to build this project on this build machine.</p> + <p>Running meson in the directory containing <i>meson.build</i> will create a <i>ninja.build</i> file in the <b>build</b> directory (or specified build directory).</p> + <p>For more details see: + <a href="http://mesonbuild.com/">http://mesonbuild.com/</a> + </p><hr class="navigation-separator"/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Supported-Environments.html" title="Supported Environments"> + <img alt="Next" border="0" src="../../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top"></td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Supported Environments</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonCleanBuild.png b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonCleanBuild.png Binary files differnew file mode 100644 index 00000000000..96a006327c9 --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonCleanBuild.png diff --git a/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonConfigurePropertyPage.png b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonConfigurePropertyPage.png Binary files differnew file mode 100644 index 00000000000..6b3a115741b --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonConfigurePropertyPage.png diff --git a/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonExistingProject.png b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonExistingProject.png Binary files differnew file mode 100644 index 00000000000..08e90130c74 --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonExistingProject.png diff --git a/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonHammerIcon.png b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonHammerIcon.png Binary files differnew file mode 100644 index 00000000000..c0272bb5d88 --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonHammerIcon.png diff --git a/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonLaunchbarBuild.png b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonLaunchbarBuild.png Binary files differnew file mode 100644 index 00000000000..f6438393996 --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonLaunchbarBuild.png diff --git a/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonNewProjectDialog.png b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonNewProjectDialog.png Binary files differnew file mode 100644 index 00000000000..1f92260cbd5 --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonNewProjectDialog.png diff --git a/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonRunNinja.png b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonRunNinja.png Binary files differnew file mode 100644 index 00000000000..7617b99772b --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonRunNinja.png diff --git a/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonUnconfiguredPropertyPage.png b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonUnconfiguredPropertyPage.png Binary files differnew file mode 100644 index 00000000000..70c4049f15a --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/CDT/Meson/User_Guide/images/MesonUnconfiguredPropertyPage.png diff --git a/build/org.eclipse.cdt.meson.docs/META-INF/MANIFEST.MF b/build/org.eclipse.cdt.meson.docs/META-INF/MANIFEST.MF new file mode 100644 index 00000000000..6c630fc0f2c --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/META-INF/MANIFEST.MF @@ -0,0 +1,9 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: %bundleName +Bundle-SymbolicName: org.eclipse.cdt.meson.docs;singleton:=true +Bundle-Version: 1.0.0.qualifier +Bundle-Vendor: %provider +Bundle-Localization: plugin +Require-Bundle: org.eclipse.help, + org.eclipse.ui.cheatsheets diff --git a/build/org.eclipse.cdt.meson.docs/about.html b/build/org.eclipse.cdt.meson.docs/about.html new file mode 100644 index 00000000000..c258ef55d83 --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/about.html @@ -0,0 +1,28 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/> +<title>About</title> +</head> +<body lang="EN-US"> +<h2>About This Content</h2> + +<p>June 5, 2006</p> +<h3>License</h3> + +<p>The Eclipse Foundation makes available all content in this plug-in ("Content"). Unless otherwise +indicated below, the Content is provided to you under the terms and conditions of the +Eclipse Public License Version 1.0 ("EPL"). A copy of the EPL is available +at <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>. +For purposes of the EPL, "Program" will mean the Content.</p> + +<p>If you did not receive this Content directly from the Eclipse Foundation, the Content is +being redistributed by another party ("Redistributor") and different terms and conditions may +apply to your use of any object code in the Content. Check the Redistributor's license that was +provided with the Content. If no such license exists, contact the Redistributor. Unless otherwise +indicated below, the terms and conditions of the EPL still apply to any source code in the Content +and such source code may be obtained at <a href="http://www.eclipse.org/">http://www.eclipse.org</a>.</p> + +</body> +</html>
\ No newline at end of file diff --git a/build/org.eclipse.cdt.meson.docs/book.css b/build/org.eclipse.cdt.meson.docs/book.css new file mode 100644 index 00000000000..797473964ab --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/book.css @@ -0,0 +1,59 @@ +/* following font face declarations need to be removed for DBCS */ + + +body, h1, h2, h3, h4, p, table, td, caption, th, ul, ol, dl, li, dd, dt {font-family: Arial, sans-serif; color: #000000} +pre { font-family: Courier, monospace} + +/* end font face declarations */ + +/* following font size declarations should be OK for DBCS */ +body, h1, h2, h3, h4, p, table, td, caption, th, ul, ol, dl, li, dd, dt {font-size: 12pt; } +pre { font-size: 12pt} + +/* end font size declarations */ + +body { background: #FFFFFF} +h1 { font-size: 18pt; margin-top: 5; margin-bottom: 1 } +h2 { font-size: 14pt; margin-top: 25; margin-bottom: 3 } +h3 { font-size: 11pt; margin-top: 20; margin-bottom: 3 } +h4 { font-size: 10pt; margin-top: 20; margin-bottom: 3; font-style: italic } +h5 { font size: 13.5pt; } +p { font-size: 12pt; } +pre { margin-left: 6; font-size: 9pt } + +a:link { color: #006699 } +a:visited { color: #996699 } +a:hover { color: #006699 } + +ul { margin-top: 0; margin-bottom: 10 } +li { margin-top: 0; margin-bottom: 0 } +li p { margin-top: 0; margin-bottom: 0 } +ol { margin-top: 0; margin-bottom: 10 } +dl { margin-top: 0; margin-bottom: 10 } +dt { margin-top: 0; margin-bottom: 0; font-weight: bold } +dd { margin-top: 0; margin-bottom: 0 } +strong { font-weight: bold} +em { font-style: italic} +var { font-style: italic} +div.revision { border-left-style: solid; border-left-width: thin; + border-left-color: #7B68EE; padding-left:5 } +th { font-weight: bold } +.hidden { + display: none; +} + +/* Mike Behm's addition to the style sheet */ +.userinput { font-family: monospace; } +.guitab, .important, .guibutton, .selectblue, .guimenu, .guilabel, +.notetitle { + color: #000000; + font-family: helvetica, arial, sans-serif; + font-weight: bold; + } +div.linux {display:none;} +.firsterm {font-style:italic;} + +.typewriter {font-family:monospace;} +.bold {font-weight:600;} +.linethrough {text-decoration: line-through;} +.underline {text-decoration: underline;} diff --git a/build/org.eclipse.cdt.meson.docs/build-helper.xml b/build/org.eclipse.cdt.meson.docs/build-helper.xml new file mode 100644 index 00000000000..fd6cd2d544f --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/build-helper.xml @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Copyright (c) 2018 Red Hat, Inc. + All rights reserved. This program and the accompanying materials + are made available under the terms of the Eclipse Public License v1.0 + which accompanies this distribution, and is available at + http://www.eclipse.org/legal/epl-v10.html + + Contributors: + Red Hat - initial API and implementation + --> +<project name="org.eclipse.cdt.meson.docs" default="all"> + <description> + Generate Eclipse help content for the CDT meson user guide + </description> + + <property name="meson.help.doc.url.base" value="http://wiki.eclipse.org"/> + <property name="meson.wiki.url.base" value="${meson.help.doc.url.base}/CDT/Meson"/> + <property name="imageFolder" value="images"/> + + <target name="all" description="Generate Eclipse help content for the CDT Meson user guide"> + <mediawiki-to-eclipse-help wikiBaseUrl="${meson.help.doc.url.base}" title="Meson Plug-in User Guide" formatoutput="true" dest="." templateExcludes="*eclipseproject*"> + + <path name="CDT/Meson/User_Guide" title="Meson Plug-in User Guide" generateToc="false"/> + <stylesheet url="book.css" /> + <pageAppendum> += Updating This Document = + +This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit +http://wiki.eclipse.org/CDT/Meson/User_Guide + </pageAppendum> + </mediawiki-to-eclipse-help> + <replace file="CDT/Meson/User_Guide/User-Guide.html" token="{{#eclipseproject:tools.cdt}}" value=""/> + <antcall target="test" /> + </target> + + <target name="test" description="verify that all of the HTML files are well-formed XML"> + <echo level="info"> +Validating help content XML and HTML files: The Eclipse help system expects well-formed XML + +If validation fails it is because either: + +* the userguide source code is poorly formed, or +* the WikiText MediaWiki parser has a bug + +Problems with userguide source are usually caused by improper use of HTML markup in the MediaWiki source, +or inadvertently starting a line with a space character (in MediaWiki this starts a preformatted block) + </echo> + + <!-- + Don't bother with DTD validation: we only care if the files are well-formed. + We therefore provide an empty DTD + --> + <echo file="tmp/__empty.dtd" message="" /> + <xmlvalidate lenient="true"> + <fileset dir="CDT"> + <include name="**/*.html" /> + </fileset> + <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location="${basedir}/tmp/__empty.dtd" /> + </xmlvalidate> + <delete dir="tmp"/> + </target> +</project> diff --git a/build/org.eclipse.cdt.meson.docs/build-index.xml b/build/org.eclipse.cdt.meson.docs/build-index.xml new file mode 100644 index 00000000000..71f98cae282 --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/build-index.xml @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Copyright (c) 2012 Marc-Andre Laperle, Inc. and others + All rights reserved. This program and the accompanying materials + are made available under the terms of the Eclipse Public License v1.0 + which accompanies this distribution, and is available at + http://www.eclipse.org/legal/epl-v10.html + + Contributors: + Marc-Andre Laperle - initial API and implementation + --> +<project> + <target name="build.index" description="Builds search index" if="eclipse.running"> + <help.buildHelpIndex manifest="plugin.xml" destination="."/> + </target> +</project> diff --git a/build/org.eclipse.cdt.meson.docs/build.properties b/build/org.eclipse.cdt.meson.docs/build.properties new file mode 100644 index 00000000000..28bb7eca7cd --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/build.properties @@ -0,0 +1,12 @@ +bin.includes = META-INF/,\ + plugin.xml,\ + toc.xml,\ + about.html,\ + plugin.properties,\ + doc/,\ + index/,\ + images/,\ + book.css,\ + CDT/ +jars.compile.order = . + diff --git a/build/org.eclipse.cdt.meson.docs/doc/notices.html b/build/org.eclipse.cdt.meson.docs/doc/notices.html new file mode 100644 index 00000000000..ec4caca1584 --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/doc/notices.html @@ -0,0 +1,22 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html> +<head> + +<meta name="copyright" content="© Copyright 2018 Eclipse Linux Tools project committers and others. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > + + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <LINK REL="STYLESHEET" HREF="book.css" CHARSET="ISO-8859-1" TYPE="text/css"> + <title>Legal Notices</title> +</head> +<body> + +<h3> +<a NAME="Notices"></a>Notices</h3> +<p> +The material in this guide is © Copyright 2018 Eclipse Linux Tools project committers and others. +</p> +<p> +<a href="../about.html">Terms and conditions regarding the use of this guide.</a> +</p> +</body> +</html> diff --git a/build/org.eclipse.cdt.meson.docs/extract-markup.xsl b/build/org.eclipse.cdt.meson.docs/extract-markup.xsl new file mode 100644 index 00000000000..4c4e731948b --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/extract-markup.xsl @@ -0,0 +1,9 @@ +<?xml version="1.0" encoding="UTF-8"?> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:mw="http://www.mediawiki.org/xml/export-0.3/"> + <xsl:output method="text"/> + + <xsl:template match="/"> + <xsl:value-of select="//mw:text"/> + </xsl:template> +</xsl:stylesheet> diff --git a/build/org.eclipse.cdt.meson.docs/images/home.gif b/build/org.eclipse.cdt.meson.docs/images/home.gif Binary files differnew file mode 100644 index 00000000000..4472e8ce5b3 --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/images/home.gif diff --git a/build/org.eclipse.cdt.meson.docs/images/next.gif b/build/org.eclipse.cdt.meson.docs/images/next.gif Binary files differnew file mode 100644 index 00000000000..e2f8c3e1fee --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/images/next.gif diff --git a/build/org.eclipse.cdt.meson.docs/images/prev.gif b/build/org.eclipse.cdt.meson.docs/images/prev.gif Binary files differnew file mode 100644 index 00000000000..4fb41501036 --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/images/prev.gif diff --git a/build/org.eclipse.cdt.meson.docs/plugin.properties b/build/org.eclipse.cdt.meson.docs/plugin.properties new file mode 100644 index 00000000000..f40affe515b --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/plugin.properties @@ -0,0 +1,13 @@ +################################################################################# +# Copyright (c) 2018 Red Hat, Inc. +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Eclipse Public License v1.0 +# which accompanies this distribution, and is available at +# http://www.eclipse.org/legal/epl-v10.html +# +# Contributors: +# Red Hat Incorporated - initial API and implementation +################################################################################# +bundleName=Meson Documentation +provider=Eclipse CDT +AutotoolsCheatSheetName=Creating a GNU Meson Project diff --git a/build/org.eclipse.cdt.meson.docs/plugin.xml b/build/org.eclipse.cdt.meson.docs/plugin.xml new file mode 100644 index 00000000000..21481e1702b --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/plugin.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8"?> +<?eclipse version="3.0"?> +<plugin> + <extension + point="org.eclipse.help.toc"> + <toc + file="toc.xml" + primary="true"/> + <index path="index"/> + </extension> + +</plugin> + diff --git a/build/org.eclipse.cdt.meson.docs/pom.xml b/build/org.eclipse.cdt.meson.docs/pom.xml new file mode 100644 index 00000000000..2865873a5a5 --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/pom.xml @@ -0,0 +1,126 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" + xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.eclipse.cdt</groupId> + <artifactId>cdt-parent</artifactId> + <version>9.5.0-SNAPSHOT</version> + <relativePath>../../pom.xml</relativePath> + </parent> + + <version>1.0.0-SNAPSHOT</version> + <artifactId>org.eclipse.cdt.meson.docs</artifactId> + <packaging>eclipse-plugin</packaging> + + <profiles> + <profile> + <id>build-doc</id> + <activation> + <property> + <name>!skipDoc</name> + </property> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.eclipse.tycho.extras</groupId> + <artifactId>tycho-eclipserun-plugin</artifactId> + <version>${tycho-extras-version}</version> + <configuration> + <appArgLine>-application org.eclipse.ant.core.antRunner -buildfile build-index.xml build.index</appArgLine> + <dependencies> + <dependency> + <artifactId>org.apache.ant</artifactId> + <type>eclipse-plugin</type> + </dependency> + <dependency> + <artifactId>org.eclipse.help.base</artifactId> + <type>eclipse-plugin</type> + </dependency> + <dependency> + <artifactId>org.eclipse.ant.core</artifactId> + <type>eclipse-plugin</type> + </dependency> + </dependencies> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-run</goal> + </goals> + <phase>compile</phase> + </execution> + </executions> + </plugin> + </plugins> + </build> + </profile> + <profile> + <id>regenHelp</id> + <build> + <plugins> + <plugin> + <artifactId>maven-antrun-plugin</artifactId> + <executions> + <execution> + <id>helpdocs</id> + <phase>generate-resources</phase> + <configuration> + <target> + <taskdef classpathref="maven.plugin.classpath" + resource="org/eclipse/mylyn/wikitext/mediawiki/ant/tasks.properties" /> + <taskdef classpathref="maven.plugin.classpath" + resource="org/eclipse/mylyn/wikitext/ant/tasks.properties" /> + <ant antfile="build-helper.xml" target="all" /> + </target> + </configuration> + <goals> + <goal>run</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.ant</artifactId> + <version>3.0.23</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> + </profile> + <profile> + <id>fake-doc</id> + <activation> + <property> + <name>skipDoc</name> + </property> + </activation> + <build> + <plugins> + <plugin> + <artifactId>maven-antrun-plugin</artifactId> + <version>1.8</version> + <executions> + <execution> + <phase>compile</phase> + <configuration> + <target> + <touch file="index/indexed_docs" mkdirs="true"/> + </target> + </configuration> + <goals> + <goal>run</goal> + </goals> + </execution> + </executions> + </plugin> + </plugins> + </build> + </profile> + </profiles> +</project> diff --git a/build/org.eclipse.cdt.meson.docs/toc.xml b/build/org.eclipse.cdt.meson.docs/toc.xml new file mode 100644 index 00000000000..9866b812767 --- /dev/null +++ b/build/org.eclipse.cdt.meson.docs/toc.xml @@ -0,0 +1,11 @@ +<?xml version='1.0' encoding='utf-8' ?> +<toc topic="CDT/Meson/User_Guide/User-Guide.html" label="Meson Plug-in User Guide"> + <topic href="CDT/Meson/User_Guide/User-Guide.html" label="Meson Plug-in User Guide"> + <topic href="CDT/Meson/User_Guide/User-Guide.html" label="Introduction"></topic> + <topic href="CDT/Meson/User_Guide/Supported-Environments.html" label="Supported Environments"></topic> + <topic href="CDT/Meson/User_Guide/Creating-a-Meson-Project.html" label="Creating a Meson Project"></topic> + <topic href="CDT/Meson/User_Guide/Configuration.html" label="Configuration"></topic> + <topic href="CDT/Meson/User_Guide/Building.html" label="Building"></topic> + <topic href="CDT/Meson/User_Guide/Updating-This-Document.html" label="Updating This Document"></topic> + </topic> +</toc>
\ No newline at end of file @@ -75,6 +75,7 @@ <module>build/org.eclipse.cdt.cmake-feature</module> <module>build/org.eclipse.cdt.meson.core</module> + <module>build/org.eclipse.cdt.meson.docs</module> <module>build/org.eclipse.cdt.meson.ui</module> <module>build/org.eclipse.cdt.meson.ui.editor</module> <module>build/org.eclipse.cdt.meson-feature</module> @@ -571,6 +572,7 @@ <configuration> <excludes> <plugin id="org.eclipse.cdt.autotools.docs"/> + <plugin id="org.eclipse.cdt.meson.docs"/> <plugin id="org.eclipse.cdt.core.linux.ppc64le"/> <plugin id="org.eclipse.cdt.core.linux.ppc64"/> <plugin id="org.eclipse.cdt.core.linux.x86_64"/> diff --git a/releng/org.eclipse.cdt.repo/category.xml b/releng/org.eclipse.cdt.repo/category.xml index 6ec8b92656f..001452522f7 100644 --- a/releng/org.eclipse.cdt.repo/category.xml +++ b/releng/org.eclipse.cdt.repo/category.xml @@ -95,6 +95,12 @@ <feature url="features/org.eclipse.cdt.autotools.source_0.0.0.qualifier.jar" id="org.eclipse.cdt.autotools.source" version="0.0.0"> <category name="extra"/> </feature> + <feature url="features/org.eclipse.cdt.meson_0.0.0.qualifier.jar" id="org.eclipse.cdt.meson" version="0.0.0"> + <category name="extra"/> + </feature> + <feature url="features/org.eclipse.cdt.meson.source_0.0.0.qualifier.jar" id="org.eclipse.cdt.meson.source" version="0.0.0"> + <category name="extra"/> + </feature> <feature url="features/org.eclipse.cdt.docker.launcher_0.0.0.qualifier.jar" id="org.eclipse.cdt.docker.launcher" version="0.0.0"> <category name="extra"/> </feature> |
