github/ghidra
1
1
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2026-01-09 22:17:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch

Browse Source 
'origin/GP-6228_d-millar_protobuf_docs--SQUASHED' (Closes #8774)
This commit is contained in:
Ryan Kurtz
2025-12-18 13:03:22 -05:00
parent 07d21713b6 314225b920
commit b535637fa0
8 changed files with 7 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Ghidra/Debug/Debugger-agent-dbgeng/src/main/help/help/topics/dbgeng/dbgeng.html
View File

@@ -48,7 +48,7 @@
<UL style="list-style-type: none"> <UL style="list-style-type: none">
<LI> <LI>
<PRE> <PRE>
python3 -m pip install pybag protobuf==3.20.3 python3 -m pip install pybag protobuf>=3.20.3
</PRE> </PRE>
</LI> </LI>
</UL> </UL>

2
Ghidra/Debug/Debugger-agent-gdb/src/main/help/help/topics/gdb/gdb.html
View File

@@ -38,7 +38,7 @@
<UL style="list-style-type: none"> <UL style="list-style-type: none">
<LI> <LI>
<PRE> <PRE>
python3 -m pip install psutil protobuf==3.20.3 python3 -m pip install psutil protobuf>=3.20.3
</PRE> </PRE>
</LI> </LI>
</UL> </UL>

2
Ghidra/Debug/Debugger-agent-lldb/src/main/help/help/topics/lldb/lldb.html
View File

@@ -38,7 +38,7 @@
<UL style="list-style-type: none"> <UL style="list-style-type: none">
<LI> <LI>
<PRE> <PRE>
python3 -m pip install psutil protobuf==3.20.3 python3 -m pip install psutil protobuf>=3.20.3
</PRE> </PRE>
</LI> </LI>
</UL> </UL>

2
Ghidra/Debug/Debugger-rmi-trace/DEVNOTES.txt
View File

@@ -117,8 +117,6 @@ That said, for unit testing, I've had to incorporate package installation as a @
There's probably a better way, and that way may also help with out-of-the-box support. There's probably a better way, and that way may also help with out-of-the-box support.
Something like setting PYTHON_PATH before invoking the debugger? Something like setting PYTHON_PATH before invoking the debugger?
There's still the issue of installing protobuf, though. There's still the issue of installing protobuf, though.
And the version we use is not the latest, which may put users who already have protobuf in dependency hell.
We use version 3.20, while the latest is 4.something.
According to protobuf docs, major versions are not guaranteed backward compatible. According to protobuf docs, major versions are not guaranteed backward compatible.
To upgrade, we'd also have to upgrade the Java side. To upgrade, we'd also have to upgrade the Java side.

2
Ghidra/Debug/Debugger-rmi-trace/src/main/help/help/topics/TraceRmiLauncherServicePlugin/TraceRmiLauncherServicePlugin.html
View File

@@ -134,7 +134,7 @@
<UL style="list-style-type: none"> <UL style="list-style-type: none">
<LI> <LI>
<PRE> <PRE>
python3 -m pip install protobuf==3.20.3 python3 -m pip install protobuf>=3.20.3
</PRE> </PRE>
</LI> </LI>
</UL> </UL>

2
GhidraDocs/GettingStarted.md
View File

@@ -165,7 +165,7 @@ The Debugger now uses Python to connect to the host platform's native debuggers.
a [supported](#minimum-requirements) version of Python and some additional packages. These packages a [supported](#minimum-requirements) version of Python and some additional packages. These packages
are included in the distribution, but you may still install them from PyPI if you prefer: are included in the distribution, but you may still install them from PyPI if you prefer:
* psutil * psutil
* protobuf==3.20.3 * protobuf>=3.20.3
* Pybag>=2.2.12 (for WinDbg support) * Pybag>=2.2.12 (for WinDbg support)
Different native debuggers have varying requirements, so you do not necessarily have to install all Different native debuggers have varying requirements, so you do not necessarily have to install all

2
GhidraDocs/GhidraClass/Debugger/B1-RemoteTargets.html
View File

@@ -287,7 +287,7 @@ the Python source over and add it to your <code>PYTHONPATH</code>.</p>
<p>Double-check that you have installed all the required packages and <p>Double-check that you have installed all the required packages and
their dependencies. A common forgotten or incorrectly-versioned their dependencies. A common forgotten or incorrectly-versioned
dependency is <code>protobuf</code>. We developed using dependency is <code>protobuf</code>. We developed using
<code>protobuf==3.20.3</code>. Its “sdist” package is distributed with <code>protobuf==3.20.3</code>, newer versions generally work fine. Its “sdist” package is distributed with
Ghidra under <code>Debugger-rmi-trace/pypkg/dist</code> for your Ghidra under <code>Debugger-rmi-trace/pypkg/dist</code> for your
convenience.</p> convenience.</p>
<p>It is also possible that <code>gdb</code> has embedded a different <p>It is also possible that <code>gdb</code> has embedded a different

2
GhidraDocs/GhidraClass/Debugger/B1-RemoteTargets.md
View File

@@ -126,7 +126,7 @@ If that doesn't work, then in the worst case, copy the Python source over and ad
Double-check that you have installed all the required packages and their dependencies. Double-check that you have installed all the required packages and their dependencies.
A common forgotten or incorrectly-versioned dependency is `protobuf`. A common forgotten or incorrectly-versioned dependency is `protobuf`.
We developed using `protobuf==3.20.3`. We developed using `protobuf==3.20.3`, newer versions generally work fine.
Its "sdist" package is distributed with Ghidra under `Debugger-rmi-trace/pypkg/dist` for your convenience. Its "sdist" package is distributed with Ghidra under `Debugger-rmi-trace/pypkg/dist` for your convenience.
It is also possible that `gdb` has embedded a different version of the interpreter than the one that `python3` provides. It is also possible that `gdb` has embedded a different version of the interpreter than the one that `python3` provides.