1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-21 21:52:10 +02:00

Bug 564349 - Update docs, UI strings and bundle descriptions

Change-Id: I00eeae3406ef83d34eba7f713b411692073ec323
Signed-off-by: Martin Weber <fifteenknots505@gmail.com>
This commit is contained in:
Martin Weber 2021-07-08 22:18:40 +02:00
parent 422835d273
commit 72bc739a29
14 changed files with 25 additions and 27 deletions

View file

@ -1,4 +1,4 @@
bundleName=C/C++ CMake Build Support for ARM C compilers
bundleName=JSON Compilation Database Parser Support for ARM C compilers
Bundle-Vendor = Eclipse CDT
Bundle-Copyright = 2019 Martin Weber\n\

View file

@ -17,12 +17,7 @@ td {
</head>
<body>
<h1>Compiler Built-ins Detection Support Overview</h1>
<p>CDT CMake support can detect compiler-built-in include paths and preprocessor macros.<br/>
Unfortunately, it has no knowledge about the generated build system structure, the <code>compile_commads.json</code>
file generated by CMake only reports source-files. To avoid the cost of running the built-ins detector for
<strong>each</strong> source-file, CDT CMake support assumes that compiler built-ins
are the same for each source-file in a CMake project. Therefore, detection is run just once
(on the first source file found per language) per Eclipse project.
<p>JSON Compilation Database Parser support can detect compiler-built-in include paths and preprocessor macros.
</p>
<h2>Invariant Built-ins Detection Support</h2>

View file

@ -2,7 +2,7 @@
<!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" lang="en">
<head>
<title>Available Compiler Support for the Indexer</title>
<title>Available Compiler Support for the JSON Compilation Database Parser</title>
<style type="text/css">
table, th, td {
border: 1px solid black;
@ -17,7 +17,7 @@ th, td {
<P>The C/C++/CUDA editors use the CDT indexer to improve syntax highlighting, allowing you to jump to
macro definitions and to browse through include files.
</P>
<p>The following table lists the compiler executables supported by the CDT CMake build integration.</p>
<p>The following table lists the compiler executables supported by the JSON Compilation Database Parser.</p>
<table id="overview_table" style="border-collapse:collapse">
<thead>
<tr>
@ -115,8 +115,8 @@ th, td {
<!-- extra compilers go here -->
<anchor id="extra_detection_participant_list"/>
<h2>CDT CMake build integration Compiler Built-ins detection</h2>
<p>This feature also invokes tries to get the include paths and preprocessor macros
<h2>JSON Compilation Database Parser Compiler Built-ins detection</h2>
<p>This feature also tries to get the include paths and preprocessor macros
<strong>built-in to the compiler</strong>.<br/>
Note that this works only for compilers that supporting it.
See <a href="builtins-detection.xhtml">built-ins detection</a> for supported compilers.

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<toc label="CDT CMake User Guide">
<toc label="JSON Compilation Database Parser User Guide">
<topic label="Tasks">
<link toc="doc/topics_Tasks.xml"/>
</topic>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<toc label="Tasks" link_to="cmake4eclipse_Tasks_Anchor" topic="doc/html/o_tasks.html">
<toc label="Tasks" link_to="jsoncdb_Tasks_Anchor" topic="doc/html/o_tasks.html">
<topic label="Build">
</topic>
<topic href="doc/html/supported-compilers.xhtml" label="Syntax Highlighting Support">

View file

@ -1,7 +1,7 @@
bundleName=CDT CMake Support user manual
bundleName=JSON Compilation Database Parser user manual
Bundle-Vendor = Eclipse CDT
Bundle-Description = CDT CMake build integration
Bundle-Description = JSON compilation database parser
Bundle-Copyright = 2013 Martin Weber\n\
\n\
This program and the accompanying materials are made\n\

View file

@ -1,5 +1,5 @@
#Properties file for org.eclipse.cdt.jsoncdb.core.ui
bundleName=CMake indexer support UI
bundleName=JSON Compilation Database Parser UI
Bundle-Vendor = Eclipse CDT
Bundle-Copyright = 2013 Martin Weber\n\
\n\
@ -9,4 +9,4 @@ which is available at https://www.eclipse.org/legal/epl-2.0/\n\
\n\
SPDX-License-Identifier: EPL-2.0\n\
page.name= Indexer Support
page.name= JSON Compilation Database Parser

View file

@ -37,7 +37,7 @@ import org.eclipse.ui.IWorkbenchPreferencePage;
import org.osgi.framework.FrameworkUtil;
/**
* Preference page for indexer support.
* Preference page for JSON Compilation Database Parser.
*/
public class IndexerSupportPreferencePage extends PreferencePage implements IWorkbenchPreferencePage {

View file

@ -1,5 +1,6 @@
bundleName=CMake CDT indexer support
bundleDescription= CMake support for CDT Indexer (Provides preprocessor macros & include paths)
bundleName=JSON Compilation Database Parser
bundleDescription= Support for parsing a JSON compilation database (usually compile_commands.json) \
as specified by https://clang.llvm.org/docs/JSONCompilationDatabase.html.
Bundle-Vendor = Eclipse CDT
Bundle-Copyright = 2013 Martin Weber\n\
@ -9,5 +10,5 @@ available under the terms of the Eclipse Public License 2.0\n\
which is available at https://www.eclipse.org/legal/epl-2.0/\n\
\n\
SPDX-License-Identifier: EPL-2.0
extension-point.name = Detection Participant
CompileCommandsJsonParserMarker.name = CMake compile_commands.json parser
extension-point.name = Tool Detection Participant
CompileCommandsJsonParserMarker.name = JSON compilation database

View file

@ -7,7 +7,9 @@
</appinfo>
<documentation>
Allows plug-ins to contribute to detection of compiler include paths and preprocessor defines from a command-line text.
&lt;p&gt;This extension point teaches the &lt;i&gt;CompileCommandsParser&lt;/i&gt; to analyze compiler-specific command-lines incl. options for a specific compiler. The detected include paths, preprocessor defines and preprocessor un-defines from the compiler command-line get passed to the CDT indexer.&lt;/p&gt;
&lt;p&gt;This extension point teaches the &lt;i&gt;JSON Compilation Database Parser&lt;/i&gt; to analyze compiler-specific command-lines incl. options for a specific compiler. The detected include paths, preprocessor defines and
preprocessor un-defines from the compiler command-line get passed to the
&lt;i&gt;JSON Compilation Database Parser&lt;/i&gt; and finally to the CDT indexer.&lt;/p&gt;
&lt;p&gt;Third party compiler vendors may use this extension point to add their compiler (or other tool) for improved syntax highlighting in the CDT&apos;s C/C++ editors.
&lt;/p&gt;
</documentation>

View file

@ -1,4 +1,4 @@
bundleName=C/C++ CMake Build Support for HPE NonStop C/C++ compilers
bundleName=JSON Compilation Database Parser Support for HPE NonStop C/C++ compilers
Bundle-Vendor = Eclipse CDT
Bundle-Copyright = 2019 Martin Weber\n\

View file

@ -1,4 +1,4 @@
bundleName=C/C++ CMake Build Support for Intel C compilers
bundleName=JSON Compilation Database Parser Support for Intel C compilers
Bundle-Vendor = Eclipse CDT
Bundle-Copyright = 2020 Martin Weber\n\

View file

@ -1,4 +1,4 @@
bundleName=C/C++ CMake Build Support for Microsoft cl C/C++ compiler
bundleName=JSON Compilation Database Parser Support for Microsoft cl C/C++ compiler
Bundle-Vendor = Eclipse CDT
Bundle-Copyright = 2020 Martin Weber\n\

View file

@ -1,4 +1,4 @@
bundleName=C/C++ CMake Build Support for NVidia CUDA compilers
bundleName=JSON Compilation Database Parser Support for NVidia CUDA compilers
Bundle-Vendor = Eclipse CDT
Bundle-Copyright = 2019 Martin Weber\n\