diff --git a/Ghidra/Features/Base/src/main/help/help/topics/BundleManager/BundleManager.htm b/Ghidra/Features/Base/src/main/help/help/topics/BundleManager/BundleManager.htm index 2d29ba0156..fb0f17988b 100644 --- a/Ghidra/Features/Base/src/main/help/help/topics/BundleManager/BundleManager.htm +++ b/Ghidra/Features/Base/src/main/help/help/topics/BundleManager/BundleManager.htm @@ -57,12 +57,16 @@ source bundle. When enabled, its Java contents are compiled to

-        <user home>/.ghidra/.ghidra-<version>/osgi/compiled-bundles/<hash>/
+        <user settings>/osgi/compiled-bundles/<hash>/
     

where <hash> is a hash of the source bundle path. These compiled artifacts are then loaded by the OSGi framework.

+

NOTE: The <user settings> directory is platform/configuration + specific. Its value can be found in the Ghidra Front End GUI, under Help -> + Runtime Information -> Application Layout -> Settings Directory +

Exploded Bundles

@@ -71,7 +75,7 @@ Each such subdirectory of compiled-bundles/ is an exploded jar -- by compressing it, we get a standard OSGi Jar bundle:

-            jar cMf mybundle.jar -C $HOME/.ghidra/.ghidra_<version>/osgi/compiled-bundles/<hash>  .
+            jar cMf mybundle.jar -C <user settings>/osgi/compiled-bundles/<hash>  .
     
@@ -195,12 +199,12 @@ in the `Import-Package` line of the manifest generated for my_ghidra_scripts:

-    <user home>/.ghidra/.ghidra-<version>/osgi/compiled-bundles/ab12cd89/META-INF/MANIFEST.MF:
+     <user settings>/osgi/compiled-bundles/ab12cd89/META-INF/MANIFEST.MF:
         Manifest-Version: 1.0
         Bundle-ManifestVersion: 2
         Export-Package: mylib
         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-Version: 1.0
         Bundle-Name: ab12cd89
@@ -211,12 +215,12 @@
     The manifest generated for your_ghidra_scripts is as follows:
     

-    <user home>/.ghidra/.ghidra-<version>/osgi/compiled-bundles/ef34ab56/META-INF/MANIFEST.MF:
+     <user settings>/osgi/compiled-bundles/ef34ab56/META-INF/MANIFEST.MF:
         Manifest-Version: 1.0
         Bundle-ManifestVersion: 2
         Export-Package: yourlib
         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-Version: 1.0
         Bundle-Name: ef34ab56
@@ -284,7 +288,7 @@
     

When Ghidra builds a source bundle, the results are written to the directory
-     <user home>/.ghidra/.ghidra-<version>/osgi/compiled-bundles/<hash>.
+     <user settings>/osgi/compiled-bundles/<hash>.
These files can then be loaded by the OSGi framework.

A clean deactivates then wipes this subdirectory for each selected bundle and diff --git a/Ghidra/Features/Base/src/main/help/help/topics/FrontEndPlugin/Edit_Plugin_Path.htm b/Ghidra/Features/Base/src/main/help/help/topics/FrontEndPlugin/Edit_Plugin_Path.htm index 7cc8d0105b..2c053f63a9 100644 --- a/Ghidra/Features/Base/src/main/help/help/topics/FrontEndPlugin/Edit_Plugin_Path.htm +++ b/Ghidra/Features/Base/src/main/help/help/topics/FrontEndPlugin/Edit_Plugin_Path.htm @@ -158,7 +158,7 @@

When you click on the Apply or OK button, your preferences file in your - <home>/.ghidra/.ghidra-<version> + <user settings> folder is updated immediately.

diff --git a/Ghidra/Features/Base/src/main/help/help/topics/FrontEndPlugin/Extensions.htm b/Ghidra/Features/Base/src/main/help/help/topics/FrontEndPlugin/Extensions.htm index 43863e93b7..98ca7125c4 100644 --- a/Ghidra/Features/Base/src/main/help/help/topics/FrontEndPlugin/Extensions.htm +++ b/Ghidra/Features/Base/src/main/help/help/topics/FrontEndPlugin/Extensions.htm @@ -46,7 +46,7 @@
    • -
    • [user dir]/.ghidra/.ghidra_[version]/Extensions - Installed/uninstalled from +
    • [user settings]/Extensions - Installed/uninstalled from this dialog
    • [installation dir]/Ghidra/Extensions/ - Installed/uninstalled from diff --git a/Ghidra/Features/Base/src/main/help/help/topics/FrontEndPlugin/Ghidra_Front_end.htm b/Ghidra/Features/Base/src/main/help/help/topics/FrontEndPlugin/Ghidra_Front_end.htm index 589cbfa956..56dce2da44 100644 --- a/Ghidra/Features/Base/src/main/help/help/topics/FrontEndPlugin/Ghidra_Front_end.htm +++ b/Ghidra/Features/Base/src/main/help/help/topics/FrontEndPlugin/Ghidra_Front_end.htm @@ -78,7 +78,7 @@

      The Tool Chest shows the tools that you currently have in your - <user home dir>/.ghidra/.ghidra-<version>/tools folder. + <user settings>/tools folder. The tools are placed there when you initially install Ghidra.  These tools are always available to your currently open project. See Ghidra Tool Administration for @@ -960,8 +960,8 @@ other IDE),  you will see standard output and errors in your IDE's console as well as the Ghidra console.

      -

      Errors and other informational messages are logged to a file in <user - home>/.ghidra/ghidraUser.log.  Messages are appended to the file every +

      Errors and other informational messages are logged to a file in + <user settings>/ghidraUser.log.  Messages are appended to the file every time you launch Ghidra.  Once the log file has reached 500KB in size, however, it will be rolled to a backup file named ghidraUser.log.0.  Older backup files are similarly rolled to another file with a one-up digit suffix as well.  Ghidra stores a diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/osgi/GhidraSourceBundle.java b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/osgi/GhidraSourceBundle.java index e108d13817..6a1538effb 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/osgi/GhidraSourceBundle.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/osgi/GhidraSourceBundle.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * 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: - *  {@code $USERHOME/.ghidra/.ghidra_/osgi/compiled-bundles/ } + * Source bundles are compiled to a path relative to the user's settings directory: + *  {@code /osgi/compiled-bundles/ } * * @return the destination for compiled source bundles * @@ -154,7 +154,7 @@ public class GhidraSourceBundle extends GhidraBundle { * a hash of the source directory path. * *

      This hash is also used as the final path component of the compile destination: - *
       {@code $USERHOME/.ghidra/.ghidra_/osgi/compiled-bundles/ } + *
       {@code /osgi/compiled-bundles/ } * * @param sourceDir the source directory * @return a string hash of the source directory path diff --git a/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/LibraryLookupTable.java b/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/LibraryLookupTable.java index 1eaa8f695a..13cc9933c1 100644 --- a/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/LibraryLookupTable.java +++ b/Ghidra/Features/Base/src/main/java/ghidra/app/util/opinion/LibraryLookupTable.java @@ -4,9 +4,9 @@ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -204,9 +204,9 @@ public class LibraryLookupTable { *

  • * Alternatively, a user specific resource directory may be used which * is located at - *
    -	 *   <USER_HOME>/.ghidra/<.ghidraVersion>/symbols/[win32|win64]
    -	 * 
    + *
    {@code
    +	 *   /symbols/[win32|win64]
    +	 * }
    * The cacheMap is a static cache which always returns the same * instance for a given DLL name. * diff --git a/Ghidra/Framework/Docking/src/main/help/help/topics/Theming/ThemingInternals.html b/Ghidra/Framework/Docking/src/main/help/help/topics/Theming/ThemingInternals.html index 0cae3798a4..2d0f135e5c 100644 --- a/Ghidra/Framework/Docking/src/main/help/help/topics/Theming/ThemingInternals.html +++ b/Ghidra/Framework/Docking/src/main/help/help/topics/Theming/ThemingInternals.html @@ -155,7 +155,7 @@

    Creating/Editing/Saving Themes

    New themes can be created and saved to files in the theme directory in the user's - application directory (<home>/.ghidra/.ghidra-<version>/themes). + settings directory (<user settings>/themes). When the application is started, this directory is scanned and any *.theme files are loaded and available to be selected as the active theme. The Gui class has diff --git a/Ghidra/Framework/Docking/src/main/help/help/topics/Theming/ThemingUserDocs.html b/Ghidra/Framework/Docking/src/main/help/help/topics/Theming/ThemingUserDocs.html index 0b3ce4947e..a6f79f7820 100644 --- a/Ghidra/Framework/Docking/src/main/help/help/topics/Theming/ThemingUserDocs.html +++ b/Ghidra/Framework/Docking/src/main/help/help/topics/Theming/ThemingUserDocs.html @@ -19,10 +19,14 @@ in their home application directory

    Users can also edit and create their own themes using the Theme Editor. Custom themes are - stored in the user's <home>/.ghidra/.ghidra-<version>/themes directory. + stored in the user's <user settings>/themes directory. 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 file that can be given to other users who can them import them into their application.

    + +

    NOTE: The <user settings> directory is platform/configuration + specific. Its value can be found in the Ghidra Front End GUI, under Help -> + Runtime Information -> Application Layout -> Settings Directory

    Theme Chooser Dialog

    @@ -243,7 +247,7 @@

    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 - <home>/.ghidra/.ghidra-<version>/themes. The first three properties + <user settings>/themes. The first three properties 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" lines. The format is:

    diff --git a/GhidraDocs/InstallationGuide.html b/GhidraDocs/InstallationGuide.html index 7cbfd2e0c4..181304a075 100644 --- a/GhidraDocs/InstallationGuide.html +++ b/GhidraDocs/InstallationGuide.html @@ -481,7 +481,9 @@ can be found in the <GhidraInstallDir>/Extensions directory.

  • Extensions installed from the Ghidra front-end GUI get installed at - <UserDir>/.ghidra/.ghidra-[version]/Extensions. + <UserSettings>/Extensions, where <UserSettings> can be looked up in + the Ghidra front-end GUI under Help -> Runtime Information -> Application Layout -> + Settings Directory.
  • It is possible to install Ghidra extensions directly into the Ghidra installation directory.