Improve all the arch plugin descriptions ##arch

radareorg · Dec 1, 2024 · 8d09448 · 8d09448
1 parent 6526d78
commit 8d09448
Show file tree

Hide file tree

Showing 58 changed files with 96 additions and 95 deletions.
diff --git a/libr/arch/p/6502/plugin.c b/libr/arch/p/6502/plugin.c
@@ -984,7 +984,7 @@ const RArchPlugin r_arch_plugin_6502 = {
 	.meta = {
 		.name = "6502",
 		.author = "condret,riq,pancake",
-		.desc = "6502/NES analysis plugin",
+		.desc = "Disassembler for the 6502 microprocessor family (NES, c64, ..)",
 		.license = "LGPL-3.0-only",
 	},
 	.arch = "6502",

diff --git a/libr/arch/p/6502_cs/plugin.c b/libr/arch/p/6502_cs/plugin.c
@@ -255,7 +255,7 @@ static bool fini(RArchSession *s) {
 const RArchPlugin r_arch_plugin_6502_cs = {
 	.meta = {
 		.name = "6502.cs",
-		.desc = "Capstone mos65xx analysis plugin",
+		.desc = "Capstone mos65xx 8 bit microprocessors",
 		.author = "pancake,Sylvain Pelissier",
 		.license = "LGPL-3.0-only",
 	},
@@ -276,12 +276,12 @@ R_API RLibStruct radare_plugin = {
 };
 #endif
 #else
-//  empty plugin
+// empty plugin
 const RArchPlugin r_arch_plugin_6502_cs = {
 	.meta = {
 		.name = "6502.cs",
 		.author = "pancake,Sylvain Pelissier",
-		.desc = "Capstone mos65xx analysis plugin (not supported)",
+		.desc = "Capstone mos65xx (not supported)",
 		.license = "LGPL-3.0-only",
 	},
 	.arch = "6502",

diff --git a/libr/arch/p/8051/plugin.c b/libr/arch/p/8051/plugin.c
@@ -1149,7 +1149,7 @@ const RArchPlugin r_arch_plugin_8051 = {
 	.meta = {
 		.name = "8051",
 		.author = "pancake,dkreuter,astuder",
-		.desc = "8051 CPU code analysis plugin",
+		.desc = "8051 microcontroller (also known as MCS-51)",
 		.license = "LGPL-3.0-only",
 	},
 	.arch = "8051",

diff --git a/libr/arch/p/alpha/plugin.c b/libr/arch/p/alpha/plugin.c
@@ -140,7 +140,7 @@ static int info(RArchSession *s, ut32 q) {
 const RArchPlugin r_arch_plugin_alpha = {
 	.meta = {
 		.name = "alpha",
-		.desc = "ALPHA architecture plugin",
+		.desc = "ALPHA architecture disassembler based on GNU binutils",
 		.license = "GPL-3.0-only",
 	},
 	.arch = "alpha",

diff --git a/libr/arch/p/any_as/plugin.c b/libr/arch/p/any_as/plugin.c
@@ -1,4 +1,4 @@
-/* Copyright (C) 2008-2023 - pancake */
+/* Copyright (C) 2008-2024 - pancake */
 
 #include <r_arch.h>
 #include "binutils_as.c"
@@ -81,7 +81,7 @@ static bool as_encode(RArchSession *s, RAnalOp *op, RArchEncodeMask mask) {
 const RArchPlugin r_arch_plugin_any_as = {
 	.meta = {
 		.name = "any.as",
-		.desc = "Uses system gnu/clang 'as' assembler",
+		.desc = "Use system's gnu/clang 'as' assembler",
 		.author = "pancake",
 		.license = "LGPL-3.0-only",
 	},

diff --git a/libr/arch/p/any_vasm/plugin.c b/libr/arch/p/any_vasm/plugin.c
@@ -1,4 +1,4 @@
-/* radare - LGPL - Copyright 2021-2022 - pancake */
+/* radare - LGPL - Copyright 2021-2024 - pancake */
 
 #include <r_arch.h>
 
@@ -22,12 +22,10 @@ static bool encode(RArchSession *as, RAnalOp *op, RArchEncodeMask mask) {
 	return false;
 }
 
-#define DESC "Use -a arm.vasm, 6502.vasm, 6809, c16x, jagrisc, m68k, pdp11, ppc, qnice, tr3200, vidcore, x86, z80"
-
 const RArchPlugin r_arch_plugin_any_vasm = {
 	.meta = {
 		.name = "any.vasm",
-		.desc = DESC,
+		.desc = "Use asm.cpu=6502, 6809, c16x, jagrisc, m68k, pdp11, ppc,qnice, tr3200, vidcore, x86, z80",
 		.author = "http://sun.hasenbraten.de/vasm/ (r2pm -ci vasm)",
 		.license = "MIT",
 	},

diff --git a/libr/arch/p/arc/plugin.c b/libr/arch/p/arc/plugin.c
@@ -1,4 +1,4 @@
-/* radare - LGPL - Copyright 2012-2023 - pancake */
+/* radare - LGPL - Copyright 2012-2024 - pancake */
 
 #include <r_lib.h>
 #include <r_arch.h>
@@ -1230,10 +1230,10 @@ const RArchPlugin r_arch_plugin_arc = {
 		.name = "arc",
 		.author = "pancake",
 		.license = "LGPL-3.0-only",
-		.desc = "ARC code analysis plugin",
+		.desc = "ARC processor instruction decoder",
 	},
 	.arch = "arc",
-	.bits = 16 | 32,
+	.bits = R_SYS_BITS_PACK2 (16, 32),
 	.decode = decode,
 	.info = archinfo,
 	.regs = regs

diff --git a/libr/arch/p/arm/plugin.c b/libr/arch/p/arm/plugin.c
@@ -143,7 +143,7 @@ static int archinfo(RArchSession *a, ut32 q) {
 const RArchPlugin r_arch_plugin_arm = {
 	.meta = {
 		.name = "arm.nz",
-		.desc = "custom thumb, arm32 and arm64 assembler",
+		.desc = "Custom thumb, arm32 and arm64 assembler",
 		.author = "pancake",
 		.license = "LGPL-3.0-only",
 	},

diff --git a/libr/arch/p/avr/plugin.c b/libr/arch/p/avr/plugin.c
@@ -2402,7 +2402,7 @@ const RArchPlugin r_arch_plugin_avr = {
 	.meta = {
 		.name = "avr",
 		.author = "pancake,rvalles,condret,killabyte",
-		.desc = "AVR code analysis plugin",
+		.desc = "AVR microcontroller CPU by Atmel",
 		.license = "LGPL-3.0-only",
 	},
 	.arch = "avr",

diff --git a/libr/arch/p/bf/plugin.c b/libr/arch/p/bf/plugin.c
@@ -1,4 +1,4 @@
-/* radare2 - LGPL - Copyright 2011-2023 - pancake */
+/* radare2 - LGPL - Copyright 2011-2024 - pancake */
 
 #include <r_arch.h>
 
@@ -318,7 +318,7 @@ static int archinfo(RArchSession *as, ut32 q) {
 const RArchPlugin r_arch_plugin_bf = {
 	.meta = {
 		.name = "bf",
-		.desc = "brainfuck code analysis plugin",
+		.desc = "brainfuck architecture",
 		.license = "LGPL-3.0-only",
 		.author = "pancake"
 	},

diff --git a/libr/arch/p/bpf/plugin.c b/libr/arch/p/bpf/plugin.c
@@ -1226,7 +1226,7 @@ static bool esilcb(RArchSession *as, RArchEsilAction action) {
 const RArchPlugin r_arch_plugin_bpf = {
 	.meta = {
 		.name = "bpf.mr",
-		.desc = "Classic BPF analysis plugin",
+		.desc = "BPF the Berkeley Packet Filter bytecode",
 		.license = "LGPL-3.0-only",
 		.author = "mrmacete"
 	},

diff --git a/libr/arch/p/bpf_cs/plugin.c b/libr/arch/p/bpf_cs/plugin.c
@@ -673,7 +673,7 @@ static bool fini(RArchSession *s) {
 const RArchPlugin r_arch_plugin_bpf_cs = {
 	.meta = {
 		.name = "bpf",
-		.desc = "Capstone BPF plugin",
+		.desc = "Capstone BPF bytecode",
 		.license = "BSD-3-Clause",
 		.author = "terorie,aemmitt",
 	},

diff --git a/libr/arch/p/chip8/plugin.c b/libr/arch/p/chip8/plugin.c
@@ -230,7 +230,7 @@ const RArchPlugin r_arch_plugin_chip8 = {
 	.meta = {
 		.name = "chip8",
 		.author = "maijin",
-		.desc = "CHIP8 analysis plugin",
+		.desc = "CHIP8 virtual CPU architecture",
 		.license = "LGPL-3.0-only",
 	},
 	.arch = "chip8",

diff --git a/libr/arch/p/dalvik/plugin.c b/libr/arch/p/dalvik/plugin.c
@@ -1711,7 +1711,7 @@ const RArchPlugin r_arch_plugin_dalvik = {
 	.meta = {
 		.name = "dalvik",
 		.author = "pancake",
-		.desc = "Dalvik (Android VM) bytecode analysis plugin",
+		.desc = "Dalvik (Android VM) bytecode",
 		.license = "LGPL-3.0-only",
 	},
 	.arch = "dalvik",

diff --git a/libr/arch/p/evm/plugin.c b/libr/arch/p/evm/plugin.c
@@ -391,7 +391,7 @@ const RArchPlugin r_arch_plugin_evm = {
 	.meta = {
 		.name = "evm",
 		.author = "pancake,Sylvain Pelissier",
-		.desc = "EthereumVM plugin",
+		.desc = "EthereumVM bytecode (EVM)",
 		.license = "BSD-3-Clause",
 	},
 	.arch = "evm",

diff --git a/libr/arch/p/fslsp/plugin.c b/libr/arch/p/fslsp/plugin.c
@@ -1,4 +1,4 @@
-/* radare - LGPL-3.0-only - Copyright 2023 - eibachd, pancake */
+/* radare - LGPL-3.0-only - Copyright 2023-2024 - eibachd, pancake */
 
 /*
  * QorIQ platform's trust architecture 3.0 Service processor (SP) provides
@@ -7,28 +7,28 @@
  * PBI (Pre-Boot Initialization) Command Summary
  *
  * Command 						| Number | Size(bytes) | Description
- * ### Configuration Write Commands
- * CCSR Write 						-		8 			32-byte write to a CCSR register
- * Alternate Configuration Write	-		variable	variable size write to offset from current value of ALTCFG_BAR
- * ### Block Copy Commands
- * Block Copy						0x00	16			Copy data from any of the available memory interfaces to a RAM
- * CCSR Write from Address			0x02				Update large number of CCSR register consecutively from random accessible memory(OCRAM, SPRAM).
+ * ### Configuration Write Command
+ * CCSR Write 				-	8 		32-byte write to a CCSR register
+ * Alternate Configuration Write		variable	variable size write to offset from current value of ALTCFG_BAR
+ * ### Block Copy Command
+ * Block Copy				0x00	16		Copy data from any of the available memory interfaces to a RAM
+ * CCSR Write from Address		0x02			Update large number of CCSR register consecutively from random accessible memory(OCRAM, SPRAM).
  * ### Special Load commands
- * Load RCW with Checksum			0x10	136			Read Reset Configuration Word, perform simple 32-bit checksum, and update RCW registers
- * Load RCW w/o Checksum			0x11	136			Read Reset Configuration Word and update RCW registers without performing checksum
- * Load Alternate Config Window		0x12	4			Read in condition 14-bit base pointer for alternate configuration space
- * Load Condition 					0x14	12			Read in condition information for subsequent Conditional Jump
- * Load Security Header				0x20	84			Read CSF Header for authentication of PBI Image
- * Load Boot 1 CSF Header Ptr		0x22	8			Read in a pointer to CSF header for authentication of Boot 1 code
- * CCSR Read, Modify and Write		0x42				Reads a CCSR register and changes (SET/CLEAR ) its bits as per mask specified in the command
+ * Load RCW with Checksum		0x10	136		Read Reset Configuration Word, perform simple 32-bit checksum, and update RCW registers
+ * Load RCW w/o Checksum		0x11	136		Read Reset Configuration Word and update RCW registers without performing checksum
+ * Load Alternate Config Window		0x12	4		Read in condition 14-bit base pointer for alternate configuration space
+ * Load Condition 			0x14	12		Read in condition information for subsequent Conditional Jump
+ * Load Security Header			0x20	84		Read CSF Header for authentication of PBI Image
+ * Load Boot 1 CSF Header Ptr		0x22	8		Read in a pointer to CSF header for authentication of Boot 1 code
+ * CCSR Read, Modify and Write		0x42			Reads a CCSR register and changes (SET/CLEAR ) its bits as per mask specified in the command
  * ### Control Commands
- * Poll Short						0x80	16			Poll a specified address for a specified address for a specified value
- * Poll Long						0x81
- * Wait								0x82	4			Pause PBI sequence for specified number of iteration of a FOR loop
- * Jump								0x84	8			Unconditional jump forward in PBI command sequence
- * Jump Conditional					0x85	12			Conditional jump forward in PBI boot sequence
- * CRC and Stop						0x8F	8			Stop the PBI sequence and indicate the expected CRC value
- * Stop								0xFF	8			Stop the PBI sequence
+ * Poll Short				0x80	16		Poll a specified address for a specified address for a specified value
+ * Poll Long				0x81
+ * Wait					0x82	4		Pause PBI sequence for specified number of iteration of a FOR loop
+ * Jump					0x84	8		Unconditional jump forward in PBI command sequence
+ * Jump Conditional			0x85	12		Conditional jump forward in PBI boot sequence
+ * CRC and Stop				0x8F	8		Stop the PBI sequence and indicate the expected CRC value
+ * Stop					0xFF	8		Stop the PBI sequence
  */
 
 #include <r_arch.h>
@@ -246,7 +246,7 @@ const RArchPlugin r_arch_plugin_fslsp = {
 	.meta = {
 		.name = "fslsp",
 		.author = "eibachd",
-		.desc = "Freescale QorIQ service processor analysis plugin",
+		.desc = "Freescale QorIQ service processor",
 		.license = "LGPL-3.0-only",
 	},
 	.arch = "fslsp",

diff --git a/libr/arch/p/gb/plugin.c b/libr/arch/p/gb/plugin.c
@@ -1574,7 +1574,7 @@ const RArchPlugin r_arch_plugin_gb = {
 	.meta = {
 		.name = "gb",
 		.author = "condret",
-		.desc = "Gameboy CPU code analysis plugin",
+		.desc = "Gameboy CPU analysis (modified Z80)",
 		.license = "LGPL-3.0-only",
 	},
 	.arch = "z80",

diff --git a/libr/arch/p/h8300/plugin.c b/libr/arch/p/h8300/plugin.c
@@ -745,11 +745,11 @@ const RArchPlugin r_arch_plugin_h8300 = {
 	.meta = {
 		.name = "h8300",
 		.author = "pancake,Fedor Sakharov,Bhootravi",
-		.desc = "H8300 code analysis plugin",
+		.desc = "H8300 High Speed 8-bit cpu with internal 16 bit architecture",
 		.license = "LGPL-3.0-only",
 	},
 	.arch = "h8300",
-	.bits = R_SYS_BITS_PACK1 (16),
+	.bits = R_SYS_BITS_PACK2 (8, 16),
 	.decode = &decode,
 	.regs = regs,
 	.info = archinfo,

diff --git a/libr/arch/p/i4004/plugin.c b/libr/arch/p/i4004/plugin.c
@@ -357,7 +357,7 @@ const RArchPlugin r_arch_plugin_i4004 = {
 	.meta = {
 		.name = "i4004",
 		.author = "pancake,condret",
-		.desc = "i4004 decoder plugin",
+		.desc = "The classic Intel 4004",
 		.license = "LGPL-3.0-only",
 	},
 	.arch = "i4004",

diff --git a/libr/arch/p/i8080/plugin.c b/libr/arch/p/i8080/plugin.c
@@ -62,7 +62,7 @@ const RArchPlugin r_arch_plugin_i8080 = {
 	.meta = {
 		.name = "i8080",
 		.author = "pancake",
-		.desc = "I8080 CPU code arch plugin",
+		.desc = "Intel 8080 CPU",
 		.license = "LGPL-3.0-only",
 	},
 	.arch = "i8080",

diff --git a/libr/arch/p/java/plugin.c b/libr/arch/p/java/plugin.c
@@ -366,7 +366,7 @@ static int archinfo(RArchSession *as, ut32 q) {
 const RArchPlugin r_arch_plugin_java = {
 	.meta = {
 		.name = "java",
-		.desc = "Java bytecode analysis plugin",
+		.desc = "Java bytecode",
 		.author = "dso",
 		.license = "Apache-2.0",
 	},

diff --git a/libr/arch/p/jdh8/plugin.c b/libr/arch/p/jdh8/plugin.c
@@ -21,7 +21,7 @@ const RArchPlugin r_arch_plugin_jdh8 = {
 	.meta = {
 		.name = "jdh8",
 		.author = "slowhand99,condret",
-		.desc = "jdh-8 toy architecture",
+		.desc = "JDK-8 toy architecture",
 		.license = "LGPL-3.0-only",
 	},
 	.arch = "jdh8",

diff --git a/libr/arch/p/lh5801/plugin.c b/libr/arch/p/lh5801/plugin.c
@@ -74,7 +74,7 @@ const RArchPlugin r_arch_plugin_lh5801 = {
 		.name = "lh5801",
 		.author = "jn",
 		.license = "LGPL-3.0-only",
-		.desc = "SHARP LH5801 disassembler",
+		.desc = "SHARP LH5801 microprocessor",
 	},
 	.arch = "LH5801",
 	.bits = R_SYS_BITS_PACK1 (8),

diff --git a/libr/arch/p/lm32/plugin.c b/libr/arch/p/lm32/plugin.c
@@ -478,7 +478,7 @@ static char *get_reg_profile(RArchSession *as) {
 const RArchPlugin r_arch_plugin_lm32 = {
 	.meta = {
 		.name = "lm32",
-		.desc = "disassembly plugin for Lattice Micro 32 ISA",
+		.desc = "Lattice Micro 32 ISA",
 		.author = "Felix Held",
 		.license = "BSD-3-Clause",
 	},

diff --git a/libr/arch/p/loongarch/plugin.c b/libr/arch/p/loongarch/plugin.c
@@ -1,4 +1,4 @@
-/* radare - LGPL - Copyright 2021-2023 - [email protected];[email protected] love lanhy*/
+/* radare - LGPL - Copyright 2021-2024 - [email protected];[email protected] love lanhy*/
 
 #include <r_arch.h>
 #include "../../include/disas-asm.h"
@@ -1409,7 +1409,7 @@ const RArchPlugin r_arch_plugin_loongarch_gnu = {
 	.meta = {
 		.name = "loongarch",
 		.author = "junchao82,zhaojunchao",
-		.desc = "loongson loongarch code analysis plugin",
+		.desc = "Loongson / loongarch architecture",
 		.license = "LGPL-3.0-only",
 	},
 	.arch = "loongarch",

diff --git a/libr/arch/p/lua/plugin.c b/libr/arch/p/lua/plugin.c
@@ -276,7 +276,7 @@ static bool fini(RArchSession *as) {
 const RArchPlugin r_arch_plugin_lua = {
 	.meta = {
 		.name = "lua",
-		.desc = "LUA Bytecode arch plugin",
+		.desc = "LUA Bytecode (5.3)",
 		.license = "MIT",
 		.author = "pancake",
 	},

diff --git a/libr/arch/p/m680x_cs/plugin.c b/libr/arch/p/m680x_cs/plugin.c
@@ -679,7 +679,7 @@ static char *mnemonics(RArchSession *as, int id, bool json) {
 const RArchPlugin r_arch_plugin_m680x_cs = {
 	.meta = {
 		.name = "m680x",
-		.desc = "Capstone M680X analysis plugin",
+		.desc = "Capstone M680X",
 		.license = "Apache-2.0",
 	},
 	.arch = "m680x",
@@ -696,7 +696,7 @@ const RArchPlugin r_arch_plugin_m680x_cs = {
 const RArchPlugin r_anal_plugin_m680x_cs = {
 	.meta = {
 		.name = "m680x (unsupported)",
-		.desc = "Capstone M680X analyzer (unsupported)",
+		.desc = "Capstone M680X (unsupported)",
 		.license = "Apache-2.0",
 	},
 	.arch = "m680x",

diff --git a/libr/arch/p/m68k_cs/plugin.c b/libr/arch/p/m68k_cs/plugin.c
@@ -926,7 +926,7 @@ static bool encode(RArchSession *s, RAnalOp *op, ut32 mask) {
 const RArchPlugin r_arch_plugin_m68k_cs = {
 	.meta = {
 		.name = "m68k",
-		.desc = "Capstone M68K analyzer",
+		.desc = "Capstone M68K architecture",
 		.license = "BSD-3-Clause",
 	},
 	.cpus = "68000,68010,68020,68030,68040,68060",
@@ -944,7 +944,7 @@ const RArchPlugin r_arch_plugin_m68k_cs = {
 const RArchPlugin r_arch_plugin_m68k_cs = {
 	.meta = {
 		.name = "m68k (unsupported)",
-		.desc = "Capstone M68K analyzer",
+		.desc = "Capstone M68K architecture",
 		.license = "BSD-3-Clause",
 	},
 };

diff --git a/libr/arch/p/malbolge/plugin.c b/libr/arch/p/malbolge/plugin.c
@@ -67,7 +67,7 @@ const RArchPlugin r_arch_plugin_malbolge = {
 	.meta = {
 		.name = "malbolge",
 		.author = "pancake",
-		.desc = "Malbolge analysis plugin",
+		.desc = "Malbolge esotheric virtual machine",
 		.license = "LGPL-3.0-only",
 	},
 	.arch = "malbolge",