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

Bug 564349 - Update docs, UI strings and bundle descriptions

Browse source 
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
Show stats Download patch file Download diff file Expand all files Collapse all files

2
cmake/org.eclipse.cdt.jsoncdb.arm/plugin.properties
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-Vendor = Eclipse CDT
Bundle-Copyright = 2019 Martin Weber\n\ Bundle-Copyright = 2019 Martin Weber\n\

7
cmake/org.eclipse.cdt.jsoncdb.core.doc/doc/html/builtins-detection.xhtml
View file

@ -17,12 +17,7 @@ td {
</head> </head>
<body> <body>
<h1>Compiler Built-ins Detection Support Overview</h1> <h1>Compiler Built-ins Detection Support Overview</h1>
<p>CDT CMake support can detect compiler-built-in include paths and preprocessor macros.<br/> <p>JSON Compilation Database Parser support can detect compiler-built-in include paths and preprocessor macros.
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> </p>
<h2>Invariant Built-ins Detection Support</h2> <h2>Invariant Built-ins Detection Support</h2>

8
cmake/org.eclipse.cdt.jsoncdb.core.doc/doc/html/supported-compilers.xhtml
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"> <!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"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head> <head>
<title>Available Compiler Support for the Indexer</title> <title>Available Compiler Support for the JSON Compilation Database Parser</title>
<style type="text/css"> <style type="text/css">
table, th, td { table, th, td {
border: 1px solid black; 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 <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. macro definitions and to browse through include files.
</P> </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"> <table id="overview_table" style="border-collapse:collapse">
<thead> <thead>
<tr> <tr>
@ -115,8 +115,8 @@ th, td {
<!-- extra compilers go here --> <!-- extra compilers go here -->
<anchor id="extra_detection_participant_list"/> <anchor id="extra_detection_participant_list"/>
<h2>CDT CMake build integration Compiler Built-ins detection</h2> <h2>JSON Compilation Database Parser Compiler Built-ins detection</h2>
<p>This feature also invokes tries to get the include paths and preprocessor macros <p>This feature also tries to get the include paths and preprocessor macros
<strong>built-in to the compiler</strong>.<br/> <strong>built-in to the compiler</strong>.<br/>
Note that this works only for compilers that supporting it. Note that this works only for compilers that supporting it.
See <a href="builtins-detection.xhtml">built-ins detection</a> for supported compilers. See <a href="builtins-detection.xhtml">built-ins detection</a> for supported compilers.

2
cmake/org.eclipse.cdt.jsoncdb.core.doc/doc/toc.xml
View file

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

2
cmake/org.eclipse.cdt.jsoncdb.core.doc/doc/topics_Tasks.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?> <?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 label="Build">
</topic> </topic>
<topic href="doc/html/supported-compilers.xhtml" label="Syntax Highlighting Support"> <topic href="doc/html/supported-compilers.xhtml" label="Syntax Highlighting Support">

4
cmake/org.eclipse.cdt.jsoncdb.core.doc/plugin.properties
View file

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

4
cmake/org.eclipse.cdt.jsoncdb.core.ui/OSGI-INF/l10n/bundle.properties
View file

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

2
cmake/org.eclipse.cdt.jsoncdb.core.ui/src/org/eclipse/cdt/jsoncdb/core/ui/internal/IndexerSupportPreferencePage.java
View file

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

9
cmake/org.eclipse.cdt.jsoncdb.core/plugin.properties
View file

@ -1,5 +1,6 @@
bundleName=CMake CDT indexer support bundleName=JSON Compilation Database Parser
bundleDescription= CMake support for CDT Indexer (Provides preprocessor macros & include paths) 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-Vendor = Eclipse CDT
Bundle-Copyright = 2013 Martin Weber\n\ 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\ which is available at https://www.eclipse.org/legal/epl-2.0/\n\
\n\ \n\
SPDX-License-Identifier: EPL-2.0 SPDX-License-Identifier: EPL-2.0
extension-point.name = Detection Participant extension-point.name = Tool Detection Participant
CompileCommandsJsonParserMarker.name = CMake compile_commands.json parser CompileCommandsJsonParserMarker.name = JSON compilation database

4
cmake/org.eclipse.cdt.jsoncdb.core/schema/participant.exsd
View file

@ -7,7 +7,9 @@
</appinfo> </appinfo>
<documentation> <documentation>
Allows plug-ins to contribute to detection of compiler include paths and preprocessor defines from a command-line text. 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;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; &lt;/p&gt;
</documentation> </documentation>

2
cmake/org.eclipse.cdt.jsoncdb.hpenonstop/plugin.properties
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-Vendor = Eclipse CDT
Bundle-Copyright = 2019 Martin Weber\n\ Bundle-Copyright = 2019 Martin Weber\n\

2
cmake/org.eclipse.cdt.jsoncdb.intel/plugin.properties
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-Vendor = Eclipse CDT
Bundle-Copyright = 2020 Martin Weber\n\ Bundle-Copyright = 2020 Martin Weber\n\

2
cmake/org.eclipse.cdt.jsoncdb.microsoft/plugin.properties
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-Vendor = Eclipse CDT
Bundle-Copyright = 2020 Martin Weber\n\ Bundle-Copyright = 2020 Martin Weber\n\

2
cmake/org.eclipse.cdt.jsoncdb.nvidia/plugin.properties
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-Vendor = Eclipse CDT
Bundle-Copyright = 2019 Martin Weber\n\ Bundle-Copyright = 2019 Martin Weber\n\