Nixyri/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2024-11-22 04:05:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

GP-0: removed $ from DevGuide

Browse Source
This commit is contained in:
Ryan Kurtz 2023-05-16 06:18:26 -04:00
parent 0de46bc339
commit e7e6e015ef
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
DevGuide.md
View File

@ -32,40 +32,40 @@ authors' names directly in the source code, so it is discouraged.
Download non-Maven Central dependencies. This creates a `dependencies` directory in the repository Download non-Maven Central dependencies. This creates a `dependencies` directory in the repository
root. root.
``` ```
$ gradle -I gradle/support/fetchDependencies.gradle init gradle -I gradle/support/fetchDependencies.gradle init
``` ```
Download Maven Central dependencies and setup the repository for development. By default, these Download Maven Central dependencies and setup the repository for development. By default, these
will be stored at `$HOME/.gradle/`. will be stored at `$HOME/.gradle/`.
``` ```
$ gradle prepdev gradle prepdev
``` ```
Generate nested Eclipse project files which can then be imported into Eclipse as "existing Generate nested Eclipse project files which can then be imported into Eclipse as "existing
projects". projects".
``` ```
$ gradle cleanEclipse eclipse gradle cleanEclipse eclipse
``` ```
Build native components for your current platform. Requires native tool chains to be present. Build native components for your current platform. Requires native tool chains to be present.
``` ```
$ gradle buildNatives gradle buildNatives
``` ```
Manually compile sleigh files. Ghidra will also do this at runtime when necessary. Manually compile sleigh files. Ghidra will also do this at runtime when necessary.
``` ```
$ gradle sleighCompile gradle sleighCompile
``` ```
Build Javadoc: Build Javadoc:
``` ```
$ gradle createJavadocs gradle createJavadocs
``` ```
Build Ghidra to `build/dist`. This will be a distribution intended only to run on the platform on Build Ghidra to `build/dist`. This will be a distribution intended only to run on the platform on
which it was built. which it was built.
``` ```
$ gradle buildGhidra gradle buildGhidra
``` ```
**Tip:** You may want to skip certain Gradle tasks to speed up your build, or to deal with **Tip:** You may want to skip certain Gradle tasks to speed up your build, or to deal with
@ -73,7 +73,7 @@ a problem later. For example, perhaps you added some new source files and the b
because of unresolved IP header issues. You can use the Gradle `-x <task>` command line argument to because of unresolved IP header issues. You can use the Gradle `-x <task>` command line argument to
prevent specific tasks from running: prevent specific tasks from running:
``` ```
$ gradle buildGhidra -x ip gradle buildGhidra -x ip
``` ```
## Known Issues ## Known Issues
@ -103,7 +103,7 @@ It is also included in the _Eclipse IDE for RCP and RAP Developers_. To generate
Eclipse projects, execute: Eclipse projects, execute:
``` ```
$ gradle eclipse -PeclipsePDE gradle eclipse -PeclipsePDE
``` ```
Import the newly generated GhidraDev projects into an Eclipse that supports this type of project. Import the newly generated GhidraDev projects into an Eclipse that supports this type of project.
@ -117,25 +117,25 @@ for instructions on how to build the GhidraDev plugin.
## Running tests ## Running tests
To run unit tests, do: To run unit tests, do:
``` ```
$ gradle unitTestReport gradle unitTestReport
``` ```
For more complex integration tests, do: For more complex integration tests, do:
``` ```
$ gradle integrationTest gradle integrationTest
``` ```
For running both unit and integration tests and to generate a report do: For running both unit and integration tests and to generate a report do:
``` ```
$ gradle combinedTestReport gradle combinedTestReport
``` ```
## Setup build in CI ## Setup build in CI
For running tests in headless mode on Linux, in a CI environment, or in Docker, first do: For running tests in headless mode on Linux, in a CI environment, or in Docker, first do:
``` ```
$ Xvfb :99 -nolisten tcp & Xvfb :99 -nolisten tcp &
$ export DISPLAY=:99 export DISPLAY=:99
``` ```
This is required to make AWT happy. This is required to make AWT happy.
@ -303,7 +303,7 @@ To set up your environment, in addition to the usual Gradle tasks, process the P
specification for GADP: specification for GADP:
```bash ```bash
$ gradle generateProto gradle generateProto
``` ```
If you already have an environment set up in Eclipse, please re-run `gradle prepDev eclipse` and If you already have an environment set up in Eclipse, please re-run `gradle prepDev eclipse` and
@ -320,4 +320,4 @@ import the new projects.
[apache]: https://www.apache.org/licenses/LICENSE-2.0 [apache]: https://www.apache.org/licenses/LICENSE-2.0
[fork]: https://docs.github.com/en/get-started/quickstart/fork-a-repo [fork]: https://docs.github.com/en/get-started/quickstart/fork-a-repo
[ghidra-data]: https://github.com/NationalSecurityAgency/ghidra-data [ghidra-data]: https://github.com/NationalSecurityAgency/ghidra-data
[DbgGuide]: DebuggerDevGuide.md [DbgGuide]: DebuggerDevGuide.md