-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add help to more queries. Task-Url: https://bugs.eclipse.org/bugs/show_bug.cgi?id=582486 Change-Id: I260db5c306fa31dd02392406cb25bb2ba1a424ea
- Loading branch information
Showing
14 changed files
with
295 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
66 changes: 66 additions & 0 deletions
66
plugins/org.eclipse.mat.ui.help/reference/inspections/find_strings.dita
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!-- | ||
| Copyright (c) 2023 IBM Corporation. | ||
| All rights reserved. This program and the accompanying materials | ||
| are made available under the terms of the Eclipse Public License 2.0 | ||
| which accompanies this distribution, and is available at | ||
| https://www.eclipse.org/legal/epl-2.0/ | ||
| SPDX-License-Identifier: EPL-2.0 | ||
| Contributors: | ||
| IBM Corporation - initial implementation | ||
| --> | ||
| <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd" > | ||
| <reference id="ref_system_properties" xml:lang="en-us"> | ||
| <title>System Properties</title> | ||
| <shortdesc>Find strings which match a regular expression. | ||
| </shortdesc> | ||
| <prolog> | ||
| <copyright> | ||
| <copyryear year=""></copyryear> | ||
| <copyrholder> | ||
| Copyright (c) 2023 IBM Corporation. | ||
| All rights reserved. This program and the accompanying materials | ||
| are made available under the terms of the Eclipse Public License 2.0 | ||
| which accompanies this distribution, and is available at | ||
| https://www.eclipse.org/legal/epl-2.0/ | ||
| </copyrholder> | ||
| </copyright> | ||
| </prolog> | ||
|
|
||
| <refbody> | ||
| <section> | ||
| <title>Motivation</title> | ||
| Sometimes it is useful to see find strings which match a regular expression. | ||
| For example, to see where there is a string which matches a desired file name. | ||
| There may then be references to that string by objects of interest. | ||
| </section> | ||
| <section> | ||
| <title>Arguments</title> | ||
| <simpletable> | ||
| <sthead> | ||
| <stentry>Argument</stentry> | ||
| <stentry>Description</stentry> | ||
| </sthead> | ||
| <strow> | ||
| <stentry>objects</stentry> | ||
| <stentry>Optionally limit the search to Strings in this object set. | ||
| Note that this query does not have to operate on Strings; it will operate on an object | ||
| which for which Eclipse Memory Analyzer can resolve a class specific name, for example | ||
| StringBuilder, Integer, URL, etc. | ||
| </stentry> | ||
| </strow> | ||
| <strow> | ||
| <stentry>pattern</stentry> | ||
| <stentry>A regular expression defining which strings match and should be returned by this query.</stentry> | ||
| </strow> | ||
| </simpletable> | ||
| </section> | ||
| <section id="result"> | ||
| <title>Result</title> | ||
| <p>A table showing the strings that match the regular expression. | ||
| </p> | ||
| </section> | ||
| </refbody> | ||
| </reference> |
74 changes: 74 additions & 0 deletions
74
plugins/org.eclipse.mat.ui.help/reference/inspections/find_strings.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| <?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" xml:lang="en-us" lang="en-us"> | ||
| <head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> | ||
|
|
||
| <meta name="generator" content="DITA-OT" /><meta name="DC.type" content="reference" /> | ||
| <meta name="DC.title" content="System Properties" /> | ||
| <meta name="abstract" content="Find strings which match a regular expression." /> | ||
| <meta name="description" content="Find strings which match a regular expression." /> | ||
| <meta name="copyright" content="Copyright (c) 2023 IBM Corporation. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" /> | ||
| <meta name="DC.rights.owner" content="Copyright (c) 2023 IBM Corporation. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" /> | ||
| <meta name="DC.format" content="XHTML" /> | ||
| <meta name="DC.identifier" content="ref_system_properties" /> | ||
| <meta name="DC.language" content="en-us" /> | ||
| <link rel="stylesheet" type="text/css" href="../../styles/commonltr.css" /> | ||
| <title>System Properties</title> | ||
| </head> | ||
| <body id="ref_system_properties"> | ||
|
|
||
| <h1 class="title topictitle1" id="ariaid-title1">System Properties</h1> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <div class="body refbody"><p class="shortdesc">Find strings which match a regular expression. | ||
| </p> | ||
|
|
||
| <div class="section"><h2 class="title sectiontitle">Motivation</h2> | ||
|
|
||
| Sometimes it is useful to see find strings which match a regular expression. | ||
| For example, to see where there is a string which matches a desired file name. | ||
| There may then be references to that string by objects of interest. | ||
| </div> | ||
|
|
||
| <div class="section"><h2 class="title sectiontitle">Arguments</h2> | ||
|
|
||
| <table cellpadding="4" cellspacing="0" summary="" border="1" class="simpletable"><col style="width:50%" /><col style="width:50%" /><thead><tr class="sthead"> | ||
| <th style="vertical-align:bottom;text-align:left;" id="d17036e44" class="stentry">Argument</th> | ||
|
|
||
| <th style="vertical-align:bottom;text-align:left;" id="d17036e47" class="stentry">Description</th> | ||
|
|
||
| </tr> | ||
| </thead><tbody><tr class="strow"> | ||
| <td style="vertical-align:top;" headers="d17036e44" class="stentry">objects</td> | ||
|
|
||
| <td style="vertical-align:top;" headers="d17036e47" class="stentry">Optionally limit the search to Strings in this object set. | ||
| Note that this query does not have to operate on Strings; it will operate on an object | ||
| which for which Eclipse Memory Analyzer can resolve a class specific name, for example | ||
| StringBuilder, Integer, URL, etc. | ||
| </td> | ||
|
|
||
| </tr> | ||
| <tr class="strow"> | ||
| <td style="vertical-align:top;" headers="d17036e44" class="stentry">pattern</td> | ||
|
|
||
| <td style="vertical-align:top;" headers="d17036e47" class="stentry">A regular expression defining which strings match and should be returned by this query.</td> | ||
|
|
||
| </tr> | ||
| </tbody></table> | ||
|
|
||
| </div> | ||
|
|
||
| <div class="section" id="ref_system_properties__result"><h2 class="title sectiontitle">Result</h2> | ||
|
|
||
| <p class="p">A table showing the strings that match the regular expression. | ||
| </p> | ||
|
|
||
| </div> | ||
|
|
||
| </div> | ||
|
|
||
| </body> | ||
| </html> |
60 changes: 60 additions & 0 deletions
60
plugins/org.eclipse.mat.ui.help/reference/inspections/system_properties.dita
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!-- | ||
| Copyright (c) 2023 IBM Corporation. | ||
| All rights reserved. This program and the accompanying materials | ||
| are made available under the terms of the Eclipse Public License 2.0 | ||
| which accompanies this distribution, and is available at | ||
| https://www.eclipse.org/legal/epl-2.0/ | ||
| SPDX-License-Identifier: EPL-2.0 | ||
| Contributors: | ||
| IBM Corporation - initial implementation | ||
| --> | ||
| <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd" > | ||
| <reference id="ref_system_properties" xml:lang="en-us"> | ||
| <title>System Properties</title> | ||
| <shortdesc>The Java system properties available to the application. | ||
| </shortdesc> | ||
| <prolog> | ||
| <copyright> | ||
| <copyryear year=""></copyryear> | ||
| <copyrholder> | ||
| Copyright (c) 2023 IBM Corporation. | ||
| All rights reserved. This program and the accompanying materials | ||
| are made available under the terms of the Eclipse Public License 2.0 | ||
| which accompanies this distribution, and is available at | ||
| https://www.eclipse.org/legal/epl-2.0/ | ||
| </copyrholder> | ||
| </copyright> | ||
| </prolog> | ||
|
|
||
| <refbody> | ||
| <section> | ||
| <title>Motivation</title> | ||
| Sometimes it is useful to see the values of system properties which were available to the application. | ||
| </section> | ||
| <section> | ||
| <title>Arguments</title> | ||
| <simpletable> | ||
| <sthead> | ||
| <stentry>Argument</stentry> | ||
| <stentry>Description</stentry> | ||
| </sthead> | ||
| <strow> | ||
| <stentry>None</stentry> | ||
| <stentry>No arguments are supplied to this query</stentry> | ||
| </strow> | ||
| </simpletable> | ||
| </section> | ||
| <section id="result"> | ||
| <title>Result</title> | ||
| <p>A table with three columns, one the Java collection holding the properties, | ||
| then the key and value. The key and value are Java Strings, so the resolved | ||
| value is shown. | ||
| The collection, key and value items are all Java objects, and the investigation can | ||
| be continued by using the context menu to select a further query to run on the item. | ||
| </p> | ||
| </section> | ||
| </refbody> | ||
| </reference> |
Oops, something went wrong.