From 3847cdab5280ffa948a918b96ead5595d5a0fa6d Mon Sep 17 00:00:00 2001 From: Andrew Dunbar Date: Mon, 30 Sep 2024 12:59:40 +0700 Subject: [PATCH 1/3] GhidraSleighEditor docs stated wrong directory for `build_README.txt` As confirmed [in this discussion](https://github.com/NationalSecurityAgency/ghidra/discussions/6961#discussioncomment-10774377), the `build_README.txt` file is not located in the `ghidra.xtext.sleigh.feature` directory but in the `ghidra.xtext.sleigh` directory. This corrects the docs to give the correct directory for the build README. --- .../ghidra.xtext.sleigh/GhidraSleighEditor_README.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GhidraBuild/EclipsePlugins/GhidraSleighEditor/ghidra.xtext.sleigh/GhidraSleighEditor_README.html b/GhidraBuild/EclipsePlugins/GhidraSleighEditor/ghidra.xtext.sleigh/GhidraSleighEditor_README.html index b8ba8ea9e5..c51376da47 100644 --- a/GhidraBuild/EclipsePlugins/GhidraSleighEditor/ghidra.xtext.sleigh/GhidraSleighEditor_README.html +++ b/GhidraBuild/EclipsePlugins/GhidraSleighEditor/ghidra.xtext.sleigh/GhidraSleighEditor_README.html @@ -83,7 +83,7 @@ plugins are installed. From Eclipse:

    To build the Sleigh Editor, follow the instructions in ghidra/DevGuide.md to setup eclipse for development. Then follow the directions in - ghidra/GhidraBuild/EclipsePlugins/GhidraSleighEditor/ghidra.xtext.sleigh.feature/build_README.txt.

    + ghidra/GhidraBuild/EclipsePlugins/GhidraSleighEditor/ghidra.xtext.sleigh/build_README.txt.

Uninstalling

From f69515f9bcf9145d869490326cba894411d11b13 Mon Sep 17 00:00:00 2001 From: Andrew Dunbar Date: Mon, 30 Sep 2024 18:17:49 +1000 Subject: [PATCH 2/3] These flags are typically have -> These flags typically have --- GhidraDocs/languages/html/sleigh_definitions.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GhidraDocs/languages/html/sleigh_definitions.html b/GhidraDocs/languages/html/sleigh_definitions.html index 1b615ac82b..eff04dd1a4 100644 --- a/GhidraDocs/languages/html/sleigh_definitions.html +++ b/GhidraDocs/languages/html/sleigh_definitions.html @@ -234,7 +234,7 @@ Many processors define registers that either consist of a single bit or otherwise don't use an integral number of bytes. A recurring example in many processors is the status register which is further subdivided into the overflow and result flags for the arithmetic -instructions. These flags are typically have labels like ZF for the +instructions. These flags typically have labels like ZF for the zero flag or CF for the carry flag and can be considered logical registers contained within the status register. SLEIGH allows registers to be defined like this using From b63b5aabba85fc88baa1a3f90414a0f77bd99c36 Mon Sep 17 00:00:00 2001 From: Andrew Dunbar Date: Mon, 30 Sep 2024 18:39:29 +1000 Subject: [PATCH 3/3] attempt to clarify hard-to-read sentence --- GhidraDocs/languages/html/sleigh_symbols.html | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/GhidraDocs/languages/html/sleigh_symbols.html b/GhidraDocs/languages/html/sleigh_symbols.html index 2022555fb4..70598b7310 100644 --- a/GhidraDocs/languages/html/sleigh_symbols.html +++ b/GhidraDocs/languages/html/sleigh_symbols.html @@ -194,10 +194,10 @@ We list all of the symbols that are predefined by SLEIGH.

The most important of these to be aware of are inst_start -and inst_next. These are family symbols which map -in the context of particular instruction to the integer offset of -either the address of the instruction or the address of the next -instruction respectively. These are used in any relative branching +and inst_next. These are family +symbols that map to the integer offset of either the instruction's +address or the next instruction's address, depending on the context +of a particular instruction. These are used in any relative branching situation. The inst_next2 is intended for conditional skip instruction situations. The remaining symbols are rarely used. The const and unique