doc: fix various typos and documentation issues (#5771)
BUILDING.md: fix formatting and path typo gdb.md: fix multiple grammatical errors and typos siol.md: fix spelling errors rzshell.md: fix grammar debug-internals.md: remove internal notes and references to missing files
This commit is contained in:
Siddhartha Rajbongshi
GitHub
parent
6dd0dba9ff
commit
7c1b965937
5 changed files with 22 additions and 23 deletions
|
|
@ -255,7 +255,7 @@ If Rizin was installed using `meson`, you can run the following command from the
|
|||
same build directory where you had previously installed Rizin:
|
||||
|
||||
```
|
||||
$ sudo ninja -C uninstall # `sudo` may not be required based on how you configured the `build` directory with meson the first time```
|
||||
$ sudo ninja -C uninstall # `sudo` may not be required based on how you configured the `build` directory with meson the first time
|
||||
```
|
||||
|
||||
Furthermore, if you had installed Rizin using a distribution package, use the
|
||||
|
|
@ -273,7 +273,7 @@ $ sudo ninja -C build install # or `sudo meson install -C build`. `sudo` may not
|
|||
|
||||
If you are a developer, it might not be necessary to run the `install` step
|
||||
(the second step from above) every time you build Rizin. You can directly use
|
||||
`rizin` from `./build/binrz/rizin/rizin.`
|
||||
`rizin` from `./build/binrz/rizin/rizin`
|
||||
|
||||
If you encounter issues while re-building Rizin, try to remove the existing
|
||||
build directory (e.g. `rm -r ./build`) and clean the subproject files
|
||||
|
|
|
|||
|
|
@ -24,10 +24,9 @@ example, spawning processes under a debugger.
|
|||
## librz/reg
|
||||
|
||||
The "reg" module provides functionality for reading and writing registers as
|
||||
well as setting up profiles. (??profiles??)
|
||||
well as setting up profiles.
|
||||
|
||||
The functionality lives in the following files:
|
||||
(?? why so many files? can this be simplified??)
|
||||
|
||||
librz/reg/arena.c // ?? used by analysis and debugger
|
||||
librz/reg/cond.c // condition registers
|
||||
|
|
@ -50,11 +49,11 @@ Rizin supports a multitude of different types of breakpoints.
|
|||
(`??` is there a list? sw, hw, and trace? anything else??)
|
||||
|
||||
librz/bp/bp.c // main breakpoint management code
|
||||
librz/bp/io.c // setting and resetting(??) breakpoints
|
||||
librz/bp/parser.h // header for breakpoint parser (??)
|
||||
librz/bp/parser.c // code for breakpoint parser (??)
|
||||
librz/bp/io.c // setting and resetting breakpoints
|
||||
librz/bp/parser.h // header for breakpoint parser
|
||||
librz/bp/parser.c // code for breakpoint parser
|
||||
librz/bp/plugin.c // breakpoint plugin management
|
||||
librz/bp/traptrace.c // traptrace (??)
|
||||
librz/bp/traptrace.c // traptrace
|
||||
librz/bp/watch.c // watch points (mostly not implemented)
|
||||
|
||||
For architecture specific-handling, "bp" delegates various functionality to
|
||||
|
|
@ -76,9 +75,9 @@ The main top-level debugger functionality lives here. It aims to abstract away
|
|||
the common code flow and integration into Rizin while delegating more nuanced
|
||||
system interactions to plug-ins.
|
||||
|
||||
librz/debug/arg.c // used by the analysis engine (??)
|
||||
librz/debug/arg.c // used by the analysis engine
|
||||
librz/debug/desc.c // code for handling file descriptors inside an inferior
|
||||
librz/debug/esil.c // ESIL related debugging code (??)
|
||||
librz/debug/esil.c // ESIL related debugging code
|
||||
librz/debug/map.c // top-level API for dealing with memory maps
|
||||
librz/debug/pid.c // top-level API for dealing with processes
|
||||
librz/debug/plugin.c // top-level debugger plugin API handling
|
||||
|
|
@ -160,7 +159,7 @@ following files:
|
|||
librz/debug/p/native/linux/linux_debug.c // main linux-specific debugging code
|
||||
librz/debug/p/native/linux/linux_debug.h // including cute penguin ascii art
|
||||
|
||||
// architecture-specific register handling on Linux (?? what is this format??)
|
||||
// architecture-specific register handling on Linux
|
||||
librz/debug/p/native/linux/reg/linux-arm.h
|
||||
librz/debug/p/native/linux/reg/linux-arm64.h
|
||||
librz/debug/p/native/linux/reg/linux-mips.h
|
||||
|
|
@ -180,13 +179,13 @@ following files:
|
|||
librz/debug/p/native/maps/darwin.c // platform-specific memory map handling
|
||||
librz/debug/p/native/xnu/xnu_debug.c // main XNU-specific debugging code
|
||||
librz/debug/p/native/xnu/xnu_debug.h // including cute apple ascii art
|
||||
librz/debug/p/native/xnu/trap_arm.c // ARM family hardware bps (??)
|
||||
librz/debug/p/native/xnu/trap_x86.c // x86 family hardware bps (??)
|
||||
librz/debug/p/native/xnu/trap_arm.c // ARM family hardware bps
|
||||
librz/debug/p/native/xnu/trap_x86.c // x86 family hardware bps
|
||||
librz/debug/p/native/xnu/xnu_excthreads.c // additional XNU thread handling
|
||||
librz/debug/p/native/xnu/xnu_threads.c // XNU thread and register handling
|
||||
librz/debug/p/native/xnu/xnu_threads.h
|
||||
|
||||
// architecture-specific register handling on XNU (?? what is this format??)
|
||||
// architecture-specific register handling on XNU
|
||||
librz/debug/p/native/xnu/reg/darwin-x86.h
|
||||
librz/debug/p/native/xnu/reg/darwin-arm.h
|
||||
librz/debug/p/native/xnu/reg/darwin-ppc.h
|
||||
|
|
@ -202,17 +201,17 @@ following files:
|
|||
|
||||
A debugger plug-in that enables debugging code natively on QNX systems. Corresponding
|
||||
IO plugin is located in librz/io/p/io_qnx.c
|
||||
See doc/qnx
|
||||
<!-- TODO: Add qnx documentation -->
|
||||
|
||||
### librz/debug/p/debug_rap.c
|
||||
|
||||
See doc/rap
|
||||
<!-- TODO: Add rap documentation -->
|
||||
|
||||
### librz/debug/p/debug_winkd.c
|
||||
|
||||
A debugger plugin that enables debugging code remotely via WinDbg protocol.
|
||||
WinDbg protocol parser is located in subprojects/rzwinkd. Corresponding IO
|
||||
plugin located in librz/io/p/io_winkd.c See doc/winkd.
|
||||
plugin located in librz/io/p/io_winkd.c <!-- TODO: Add winkd documentation -->
|
||||
|
||||
## Conclusion
|
||||
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ Connecting from rizin
|
|||
|
||||
Supported implementations
|
||||
=========================
|
||||
rizin have support for connecting to remote GDB instances:
|
||||
rizin has support for connecting to remote GDB instances:
|
||||
|
||||
x86-32 x86-64 arm arm64 sh
|
||||
winedbg x x - - -
|
||||
|
|
@ -45,7 +45,7 @@ Supported Commands
|
|||
The second one is the G packet, that writes the whole register Profile at once.
|
||||
The implementation first tries to use the newer P packet and if it receives a $00# packet (that says not implemented), it tries to write through the G packet.
|
||||
|
||||
- stepping (but this is still the softstep mode and for an unknown reason it sill does not call th gdb_write_register function)
|
||||
-- stepping (but this is still the softstep mode and for an unknown reason it still does not call the gdb_write_register function)
|
||||
|
||||
Supported Packets:
|
||||
|
||||
|
|
@ -60,7 +60,7 @@ TODO
|
|||
----
|
||||
|
||||
- Implement GDBserver to allow other apps use rizin debugger
|
||||
- Fix that usese the gdb internal stepping version
|
||||
- Fix that uses the gdb internal stepping version
|
||||
- Fix softstep, that it finally recoils correct (it just have to reset the eip/rip)
|
||||
- Add Breakpoints (should be an easy add of the function, because its already implemented in the gdb lib)
|
||||
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Let's make an example and suppose we want to add the `sky` command, which
|
|||
would find all occurrences of the word "sky" in a binary. The first thing to
|
||||
do is to see where `sky` command could be added by reading
|
||||
[`librz/core/cmd_descs/cmd_descs.yaml`](https://github.com/rizinorg/rizin/blob/6f40dfe493f0caf9e0541e1ee83e3d8012b5750f/librz/core/cmd_descs/cmd_descs.yaml).
|
||||
`sky` is `s` command's subcommand and they are splitted and placed inside the .YAML
|
||||
`sky` is `s` command's subcommand and they are split and placed inside the .YAML
|
||||
file specified by the descriptor `subcommands` of the respective command. Since `sky`
|
||||
starts with an `s`, its subcommands would be in [`librz/core/cmd_descs/cmd_seek.yaml`](https://github.com/rizinorg/rizin/blob/6f40dfe493f0caf9e0541e1ee83e3d8012b5750f/librz/core/cmd_descs/cmd_seek.yaml).
|
||||
That file respects the same tree structure used when executing rizin and seeing its help,
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ Mapping information in the map:
|
|||
|
||||
Section Transformation
|
||||
----------------------
|
||||
atm there are 3 diffent transformation-targets:
|
||||
atm there are 3 different transformation-targets:
|
||||
|
||||
- Hexeditor
|
||||
- Analysis
|
||||
|
|
@ -73,5 +73,5 @@ Emulation-Transformation:
|
|||
|
||||
- when the section does not allow write-access perform Analysis-Transformation, and you're done
|
||||
- open a new desc with write-permissions, using the malloc-plugin, with the size of vsize
|
||||
- copy min (size, vsize) bytes fram the desc, that fd referes to, starting at addr, to the new desc, starting at 0x0
|
||||
- copy min (size, vsize) bytes from the desc, that fd refers to, starting at addr, to the new desc, starting at 0x0
|
||||
- create a map with the size of vsize, that maps the new desc to vaddr, starting at 0x0
|
||||
|
|
|
|||
Loading…
Reference in a new issue