github/ghidra
1
1
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2026-01-07 21:24:00 -05:00
Code Issues Packages Projects Releases Wiki Activity

Remove trailing blank spaces in the manual index documentation

Browse Source
This commit is contained in:
cyrozap
2025-10-23 17:36:27 -05:00
parent 4e4a14f0d1
commit 9c7e41917a
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
GhidraDocs/languages/manual_index.txt
View File

@@ -2,7 +2,7 @@
How to Create a Processor Language Manual Index File
----------------------------------------------------
The processor manual index file (*.idx) contains list of instructions mnemonic and page
The processor manual index file (*.idx) contains list of instructions mnemonic and page
numbers into an identified PDF manual. These files along with the corresponding PDF files
are generally located within the data/manuals directory of a Ghidra module
(e.g., Ghidra/Processors/x86/data/manuals/x86.idx).
@@ -13,15 +13,15 @@ Example:
@68000.pdf [M68000 FAMILY Programmer's Reference Manual, 1992 (M68000PM/AD REV.1)]
The manual selector specifies the PDF file name followed by the manual description within
brackets [ ]. The ".pdf" file extension is assumed if not specified, and the file path is
relative to the directory containing the index file. If the manual is omitted from the
distribution due to copyright or other restrictions, the bracketed text will be helpful
The manual selector specifies the PDF file name followed by the manual description within
brackets [ ]. The ".pdf" file extension is assumed if not specified, and the file path is
relative to the directory containing the index file. If the manual is omitted from the
distribution due to copyright or other restrictions, the bracketed text will be helpful
in allowing the user to obtain the manual on there own.
The PDF manual selector is immediately followed by lines containing instruction
mnemonic, page number pairs which are contained within the specified PDF manual.
Additional PDF manuals may be referenced by repeating this pattern starting with
The PDF manual selector is immediately followed by lines containing instruction
mnemonic, page number pairs which are contained within the specified PDF manual.
Additional PDF manuals may be referenced by repeating this pattern starting with
the @ character on a new line.
Example:
@@ -34,7 +34,7 @@ NEG, 4
NOP, 7
NOT, 9
The AAA and AAD instructions will be found in Intel64_IA32_vol2a.pdf manual on
The AAA and AAD instructions will be found in Intel64_IA32_vol2a.pdf manual on
on page 74 and 76, respectively. Moreover, the NEG and NOP instructions
will be found in Intel64_IA32_vol2b.pdf on page 4 and 7 respectively. Also, the
remainder of the instructions will be found under Intel64_IA32_vol2b.pdf unless
@@ -45,9 +45,9 @@ where the index file is located. The index file should be in the module's
data/manuals directory.
The index file contains one line per instruction mnemonic or section header.
Each line of the index file for instruction mnemonics contains two strings:
Each line of the index file for instruction mnemonics contains two strings:
the mnemonic and the corresponding instruction info page number in the PDF file in
its respective section. The instruction mnemonic may only specify the start of a
its respective section. The instruction mnemonic may only specify the start of a
mnemonic if appropriate. For example a conditional branch instruction may include
a condition suffix on the mnemonic, but for simplification the suffix may be omitted
within the index file if all condition cases are handled together (e.g., index could