GP-4895: Fixing old mentions of $HOME/.ghidra/.ghidra_<version>

This commit is contained in:
Ryan Kurtz 2024-09-09 12:48:58 -04:00
parent c8a455e197
commit e59a6ed7ea
9 changed files with 36 additions and 26 deletions

View File

@ -57,12 +57,16 @@
<em>source bundle</em>. When enabled, its Java contents are compiled to <em>source bundle</em>. When enabled, its Java contents are compiled to
</p> </p>
<pre> <pre>
&lt;user home&gt;/.ghidra/.ghidra-&lt;version&gt;/osgi/compiled-bundles/&lt;hash&gt;/ &lt;user settings&gt;/osgi/compiled-bundles/&lt;hash&gt;/
</pre> </pre>
<p> <p>
where <code>&lt;hash&gt;</code> is a hash of the source bundle path. These compiled artifacts are then loaded where <code>&lt;hash&gt;</code> is a hash of the source bundle path. These compiled artifacts are then loaded
by the OSGi framework. by the OSGi framework.
</p> </p>
<p><b>NOTE: </b> The <code>&lt;user settings&gt;</code> directory is platform/configuration
specific. Its value can be found in the Ghidra Front End GUI, under <code>Help ->
Runtime Information -> Application Layout -> Settings Directory</code>
</p>
<h3>Exploded Bundles</h3> <h3>Exploded Bundles</h3>
@ -71,7 +75,7 @@
Each such subdirectory of <code>compiled-bundles/</code> is an <em>exploded Each such subdirectory of <code>compiled-bundles/</code> is an <em>exploded
jar</em> -- by compressing it, we get a standard OSGi Jar bundle:</p> jar</em> -- by compressing it, we get a standard OSGi Jar bundle:</p>
<pre> <pre>
jar cMf mybundle.jar -C $HOME/.ghidra/.ghidra_&lt;version&gt;/osgi/compiled-bundles/&lt;hash&gt; . jar cMf mybundle.jar -C &lt;user settings&gt;/osgi/compiled-bundles/&lt;hash&gt; .
</pre> </pre>
</blockquote> </blockquote>
@ -195,12 +199,12 @@
in the `Import-Package` line of the manifest generated for <code>my_ghidra_scripts</code>: in the `Import-Package` line of the manifest generated for <code>my_ghidra_scripts</code>:
</p> </p>
<pre> <pre>
&lt;user home&gt;/.ghidra/.ghidra-&lt;version&gt;/osgi/compiled-bundles/ab12cd89/META-INF/MANIFEST.MF: &lt;user settings&gt;/osgi/compiled-bundles/ab12cd89/META-INF/MANIFEST.MF:
Manifest-Version: 1.0 Manifest-Version: 1.0
Bundle-ManifestVersion: 2 Bundle-ManifestVersion: 2
Export-Package: mylib Export-Package: mylib
Import-Package: ghidra.app.script,yourlib,ghidra.app.plugin.core.osgi Import-Package: ghidra.app.script,yourlib,ghidra.app.plugin.core.osgi
Require-Capability: osgi.ee;filter:="(&(osgi.ee=JavaSE)(version=11))" Require-Capability: osgi.ee;filter:="(&(osgi.ee=JavaSE)(version=21))"
Bundle-SymbolicName: ab12cd89 Bundle-SymbolicName: ab12cd89
Bundle-Version: 1.0 Bundle-Version: 1.0
Bundle-Name: ab12cd89 Bundle-Name: ab12cd89
@ -211,12 +215,12 @@
The manifest generated for <code>your_ghidra_scripts</code> is as follows: The manifest generated for <code>your_ghidra_scripts</code> is as follows:
</p> </p>
<pre> <pre>
&lt;user home&gt;/.ghidra/.ghidra-&lt;version&gt;/osgi/compiled-bundles/ef34ab56/META-INF/MANIFEST.MF: &lt;user settings&gt;/osgi/compiled-bundles/ef34ab56/META-INF/MANIFEST.MF:
Manifest-Version: 1.0 Manifest-Version: 1.0
Bundle-ManifestVersion: 2 Bundle-ManifestVersion: 2
Export-Package: yourlib Export-Package: yourlib
Import-Package: ghidra.app.plugin.core.osgi Import-Package: ghidra.app.plugin.core.osgi
Require-Capability: osgi.ee;filter:="(&(osgi.ee=JavaSE)(version=11))" Require-Capability: osgi.ee;filter:="(&(osgi.ee=JavaSE)(version=21))"
Bundle-SymbolicName: ef34ab56 Bundle-SymbolicName: ef34ab56
Bundle-Version: 1.0 Bundle-Version: 1.0
Bundle-Name: ef34ab56 Bundle-Name: ef34ab56
@ -284,7 +288,7 @@
<blockquote> <blockquote>
<p>When Ghidra builds a source bundle, the results are written to the <p>When Ghidra builds a source bundle, the results are written to the
directory <br> directory <br>
&nbsp;&nbsp;&nbsp;&nbsp;<code>&lt;user home&gt;/.ghidra/.ghidra-&lt;version&gt;/osgi/compiled-bundles/&lt;hash&gt;</code>. <br> &nbsp;&nbsp;&nbsp;&nbsp;<code>&lt;user settings&gt;/osgi/compiled-bundles/&lt;hash&gt;</code>. <br>
These files can then be loaded by the OSGi framework.</p> These files can then be loaded by the OSGi framework.</p>
<p>A <em>clean</em> deactivates then wipes this subdirectory for each selected bundle and <p>A <em>clean</em> deactivates then wipes this subdirectory for each selected bundle and

View File

@ -158,7 +158,7 @@
<P><IMG src="help/shared/note.png" border="0">When you click on the <P><IMG src="help/shared/note.png" border="0">When you click on the
<B>Apply</FONT></B> or <B>OK</FONT></B> button, your <B>Apply</FONT></B> or <B>OK</FONT></B> button, your
<code>preferences</code> file in your <code>preferences</code> file in your
<code>&lt;home&gt;/.ghidra/.ghidra-&lt;version&gt;</code> <code>&lt;user settings&gt;</code>
folder is updated immediately.</P> folder is updated immediately.</P>
</BLOCKQUOTE> </BLOCKQUOTE>

View File

@ -46,7 +46,7 @@
<LI style="list-style: none"> <LI style="list-style: none">
<UL> <UL>
<LI><I>[user dir]/.ghidra/.ghidra_[version]/Extensions</I> - Installed/uninstalled from <LI><I>[user settings]/Extensions</I> - Installed/uninstalled from
this dialog</LI> this dialog</LI>
<LI><I>[installation dir]/Ghidra/Extensions/</I> - Installed/uninstalled from <LI><I>[installation dir]/Ghidra/Extensions/</I> - Installed/uninstalled from

View File

@ -78,7 +78,7 @@
<BLOCKQUOTE> <BLOCKQUOTE>
<P>The Tool Chest shows the tools that you currently have in your <P>The Tool Chest shows the tools that you currently have in your
<b>&lt;user home dir&gt;/.ghidra/.ghidra-&lt;version&gt;/tools</b> folder. <b>&lt;user settings&gt;/tools</b> folder.
The tools are placed there when you initially install Ghidra.&nbsp; The tools are placed there when you initially install Ghidra.&nbsp;
These tools are always available to your currently open project. See <A href= These tools are always available to your currently open project. See <A href=
"help/topics/Tool/Ghidra_Tool_Administration.htm">Ghidra Tool Administration</A> for "help/topics/Tool/Ghidra_Tool_Administration.htm">Ghidra Tool Administration</A> for
@ -960,8 +960,8 @@
other IDE),&nbsp; you will see standard output and errors in your IDE's console as well as other IDE),&nbsp; you will see standard output and errors in your IDE's console as well as
the Ghidra console.</P> the Ghidra console.</P>
<P>Errors and other informational messages are logged to a file in &lt;user <P>Errors and other informational messages are logged to a file in
home&gt;/.ghidra/<I><B>ghidraUser.log</B></I>.&nbsp; Messages are appended to the file every &lt;user settings&gt;/<I><B>ghidraUser.log</B></I>.&nbsp; Messages are appended to the file every
time you launch Ghidra.&nbsp; Once the log file has reached 500KB in size, however, it will time you launch Ghidra.&nbsp; Once the log file has reached 500KB in size, however, it will
be rolled to a backup file named <I><B>ghidraUser.log.0</B></I>.&nbsp; Older backup files are be rolled to a backup file named <I><B>ghidraUser.log.0</B></I>.&nbsp; Older backup files are
similarly rolled to another file with a one-up digit suffix as well.&nbsp; Ghidra stores a similarly rolled to another file with a one-up digit suffix as well.&nbsp; Ghidra stores a

View File

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
* You may obtain a copy of the License at * You may obtain a copy of the License at
* *
* http://www.apache.org/licenses/LICENSE-2.0 * http://www.apache.org/licenses/LICENSE-2.0
* *
* Unless required by applicable law or agreed to in writing, software * Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, * distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@ -138,8 +138,8 @@ public class GhidraSourceBundle extends GhidraBundle {
} }
/** /**
* Source bundles are compiled to a path relative to the user's home: * Source bundles are compiled to a path relative to the user's settings directory:
* &nbsp;{@code $USERHOME/.ghidra/.ghidra_<ghidra version>/osgi/compiled-bundles/<sourceDirHash> } * &nbsp;{@code <user settings>/osgi/compiled-bundles/<sourceDirHash> }
* *
* @return the destination for compiled source bundles * @return the destination for compiled source bundles
* *
@ -154,7 +154,7 @@ public class GhidraSourceBundle extends GhidraBundle {
* a hash of the source directory path. * a hash of the source directory path.
* *
* <p>This hash is also used as the final path component of the compile destination: * <p>This hash is also used as the final path component of the compile destination:
* <br/>&nbsp;{@code $USERHOME/.ghidra/.ghidra_<ghidra version>/osgi/compiled-bundles/<sourceDirHash> } * <br/>&nbsp;{@code <user settings>/osgi/compiled-bundles/<sourceDirHash> }
* *
* @param sourceDir the source directory * @param sourceDir the source directory
* @return a string hash of the source directory path * @return a string hash of the source directory path

View File

@ -4,9 +4,9 @@
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
* You may obtain a copy of the License at * You may obtain a copy of the License at
* *
* http://www.apache.org/licenses/LICENSE-2.0 * http://www.apache.org/licenses/LICENSE-2.0
* *
* Unless required by applicable law or agreed to in writing, software * Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, * distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@ -204,9 +204,9 @@ public class LibraryLookupTable {
* </pre> * </pre>
* Alternatively, a user specific resource directory may be used which * Alternatively, a user specific resource directory may be used which
* is located at * is located at
* <pre> * <pre>{@code
* &lt;USER_HOME&gt;/.ghidra/&lt;.ghidraVersion&gt;/symbols/[win32|win64] * <user settings>/symbols/[win32|win64]
* </pre> * }</pre>
* The cacheMap is a static cache which always returns the same * The cacheMap is a static cache which always returns the same
* instance for a given DLL name. * instance for a given DLL name.
* *

View File

@ -155,7 +155,7 @@
<H2>Creating/Editing/Saving Themes</H2> <H2>Creating/Editing/Saving Themes</H2>
<P>New themes can be created and saved to files in the theme directory in the user's <P>New themes can be created and saved to files in the theme directory in the user's
application directory (<code>&lt;home&gt;/.ghidra/.ghidra-&lt;version&gt/themes</code>). settings directory (<code>&lt;user settings&gt;/themes</code>).
When the application is started, this directory is scanned and any When the application is started, this directory is scanned and any
<CODE>*.theme</CODE> files are loaded and available to be selected as the active theme. <CODE>*.theme</CODE> files are loaded and available to be selected as the active theme.
The <CODE>Gui</CODE> class has The <CODE>Gui</CODE> class has

View File

@ -19,10 +19,14 @@
in their home application directory</P> in their home application directory</P>
<P>Users can also edit and create their own themes using the Theme Editor. Custom themes are <P>Users can also edit and create their own themes using the Theme Editor. Custom themes are
stored in the user's <code>&lt;home&gt;/.ghidra/.ghidra-&lt;version&gt/themes</code> directory. stored in the user's <code>&lt;user settings&gt;/themes</code> directory.
These theme files are simple text files that can These theme files are simple text files that can
easily be modified using any text editor. Also, users can share themes by exporting them to a easily be modified using any text editor. Also, users can share themes by exporting them to a
file that can be given to other users who can them import them into their application.</P> file that can be given to other users who can them import them into their application.</P>
<P><b>NOTE: </b> The <code>&lt;user settings&gt;</code> directory is platform/configuration
specific. Its value can be found in the Ghidra Front End GUI, under <code>Help ->
Runtime Information -> Application Layout -> Settings Directory</code></P>
</BlOCKQUOTE> </BlOCKQUOTE>
<H2>Theme Chooser Dialog<A name="Switch_Theme"></A></H2> <H2>Theme Chooser Dialog<A name="Switch_Theme"></A></H2>
@ -243,7 +247,7 @@
<P>Theme Files are used to store saved custom themes. They are simple text files and are <P>Theme Files are used to store saved custom themes. They are simple text files and are
stored in the user's home application directory under stored in the user's home application directory under
<code>&lt;home&gt;/.ghidra/.ghidra-&lt;version&gt/themes</code>. The first three properties <code>&lt;user settings&gt;/themes</code>. The first three properties
are always the theme name, the Look and Feel name, and whether the theme uses standard are always the theme name, the Look and Feel name, and whether the theme uses standard
defaults or dark defaults. Finally, there is a list of overridden property "name = value" defaults or dark defaults. Finally, there is a list of overridden property "name = value"
lines. The format is:</P> lines. The format is:</P>

View File

@ -481,7 +481,9 @@ can be found in the <i>&lt;GhidraInstallDir&gt;</i>/Extensions directory.</p>
</li> </li>
<li> <li>
Extensions installed from the Ghidra front-end GUI get installed at Extensions installed from the Ghidra front-end GUI get installed at
<i>&lt;UserDir&gt;</i>/.ghidra/.ghidra-[version]/Extensions. <i>&lt;UserSettings&gt;</i>/Extensions, where <i>&lt;UserSettings&gt;</i> can be looked up in
the Ghidra front-end GUI under <i>Help -> Runtime Information -> Application Layout ->
Settings Directory.
</li> </li>
<li> <li>
<p>It is possible to install Ghidra extensions directly into the Ghidra installation directory. <p>It is possible to install Ghidra extensions directly into the Ghidra installation directory.