Skip to content

Fix formatting and links, per CI tests #1209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hugsy merged 3 commits into from
Feb 1, 2026
+21 −20
Merged

Fix formatting and links, per CI tests #1209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8662a3f
Fix documentation: 2025.01 is the first release requiring Python 3.10
gordonmessmer Jan 29, 2026
469bd9e
Fix documentation: make markdownlint-cli happy
gordonmessmer Jan 29, 2026
cc902bb
Fix documentation: replace offline links
gordonmessmer Jan 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/api/gef.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5044,7 +5044,7 @@ usage() → None

## <kbd>class</kbd> `Elf`
Basic ELF parsing. Ref:
- http://www.skyfree.org/linux/references/ELF_Format.pdf
- https://refspecs.linuxfoundation.org/elf/TIS1.1.pdf
- https://refspecs.linuxfoundation.org/elf/elfspec_ppc.pdf
- https://refspecs.linuxfoundation.org/ELF/ppc64/PPC-elf64abi.html

Expand Down Expand Up @@ -19503,7 +19503,7 @@ usage() → None

## <kbd>class</kbd> `SPARC`
Refs:
- https://www.cse.scu.edu/~atkinson/teaching/sp05/259/sparc.pdf
- https://math-atlas.sourceforge.net/devel/assembly/SunUS_isa.pdf


---
Expand Down
4 changes: 2 additions & 2 deletions docs/commands/gef-remote.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,8 @@ makes now even more sense 😉 And using it is very straight forward.

#### `qemu-system`

To test locally, you can use the mini image linux x64 vm
[here](https://mega.nz/file/ldQCDQiR#yJWJ8RXAHTxREKVmR7Hnfr70tIAQDFeWSYj96SvPO1k).
To test locally, you can [download the mini image linux x64
vm](https://mega.nz/file/ldQCDQiR#yJWJ8RXAHTxREKVmR7Hnfr70tIAQDFeWSYj96SvPO1k).

1. Run `./run.sh`
2. Use `--qemu-user` and `--qemu-binary vmlinuz` when starting `gef-remote`
Expand Down
4 changes: 2 additions & 2 deletions docs/compat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
This matrix indicates the version of Python and/or GDB

| GEF version | GDB Python compatibility | Python compatibility |
|:--:|:--:|:--:|
| :--: | :--: | :--: |
| [2018.02](https://github.com/hugsy/gef/releases/tag/2018.02) | 7.2 | Python 2.7, Python 3.4+ |
| [2020.03](https://github.com/hugsy/gef/releases/tag/2020.03) | 7.4 | Python 2.7, Python 3.4+ |
| [2022.01](https://github.com/hugsy/gef/releases/tag/2022.01) | 8.0 | Python 3.6+ |
| [2024.09](https://github.com/hugsy/gef/releases/tag/2024.09) | 10.0 | Python 3.10+ |
| [2025.01](https://github.com/hugsy/gef/releases/tag/2025.01) | 10.0 | Python 3.10+ |
22 changes: 11 additions & 11 deletions docs/deprecated.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ were either moved to [GEF-Extras](https://github.com/hugsy/gef-extras) or even s
page aims to track those changes.

| Command | Status | Since | Link (if Applicable) | Notes |
|--|--|--|--|--|
| `cs-disassemble` | Moved | 2022.06 | [Link](https://github.com/hugsy/gef-extras/blob/main/scripts/capstone.py) | Depends on `capstone` |
| `assemble` | Moved | 2022.06 | [Link](https://github.com/hugsy/gef-extras/blob/main/scripts/assemble.py) | Depends on `keystone` |
| `emulate` | Moved | 2022.06 | [Link](https://github.com/hugsy/gef-extras/blob/main/scripts/emulate/__init__.py) | Depends on `unicorn` and `capstone` |
| `set-permission` | Moved | 2022.06 | [Link](https://github.com/hugsy/gef-extras/blob/main/scripts/emulate/__init__.py) | Depends on `keystone` |
| `ropper` | Moved | 2022.06 | [Link](https://github.com/hugsy/gef-extras/blob/main/scripts/ropper.py) | Depends on `ropper` |
| `ida-interact` | Moved | 2022.06 | [Link](https://github.com/hugsy/gef-extras/blob/main/scripts/ida_interact.py) | Depends on `rpyc` |
| `exploit-template` | Moved | [c402900](https://github.com/hugsy/gef-extras/commit/c4029007994d5e508cb3df900b60821b0b61e0e5) | [Link](https://github.com/hugsy/gef-extras/blob/main/scripts/skel.py) | |
| `windbg` | Moved | [a933a5a](https://github.com/hugsy/gef-extras/commit/a933a5ac43933742d91f4e299eadf05e3e0670be) | [Link](https://github.com/hugsy/gef-extras/blob/main/scripts/windbg.py) | |
| `is-syscall` | Moved | [3f79fb38](https://github.com/hugsy/gef-extras/commit/3f79fb382aa9052d073698d40237f98982c5d2de) | [Link](https://github.com/hugsy/gef-extras/blob/main/scripts/syscall_args) | |
| `syscall-args` | Moved | [3f79fb38](https://github.com/hugsy/gef-extras/commit/3f79fb382aa9052d073698d40237f98982c5d2de) | [Link](https://github.com/hugsy/gef-extras/blob/main/scripts/syscall_args) | |
| -- | -- | -- | -- | -- |
| `cs-disassemble` | Moved | 2022.06 | [New location](https://github.com/hugsy/gef-extras/blob/main/scripts/capstone.py) | Depends on `capstone` |
| `assemble` | Moved | 2022.06 | [New location](https://github.com/hugsy/gef-extras/blob/main/scripts/assemble.py) | Depends on `keystone` |
| `emulate` | Moved | 2022.06 | [New location](https://github.com/hugsy/gef-extras/blob/main/scripts/emulate/__init__.py) | Depends on `unicorn` and `capstone` |
| `set-permission` | Moved | 2022.06 | [New location](https://github.com/hugsy/gef-extras/blob/main/scripts/emulate/__init__.py) | Depends on `keystone` |
| `ropper` | Moved | 2022.06 | [New location](https://github.com/hugsy/gef-extras/blob/main/scripts/ropper.py) | Depends on `ropper` |
| `ida-interact` | Moved | 2022.06 | [New location](https://github.com/hugsy/gef-extras/blob/main/scripts/ida_interact.py) | Depends on `rpyc` |
| `exploit-template` | Moved | [c402900](https://github.com/hugsy/gef-extras/commit/c4029007994d5e508cb3df900b60821b0b61e0e5) | [New location](https://github.com/hugsy/gef-extras/blob/main/scripts/skel.py) | |
| `windbg` | Moved | [a933a5a](https://github.com/hugsy/gef-extras/commit/a933a5ac43933742d91f4e299eadf05e3e0670be) | [New location](https://github.com/hugsy/gef-extras/blob/main/scripts/windbg.py) | |
| `is-syscall` | Moved | [3f79fb38](https://github.com/hugsy/gef-extras/commit/3f79fb382aa9052d073698d40237f98982c5d2de) | [New location](https://github.com/hugsy/gef-extras/blob/main/scripts/syscall_args) | |
| `syscall-args` | Moved | [3f79fb38](https://github.com/hugsy/gef-extras/commit/3f79fb382aa9052d073698d40237f98982c5d2de) | [New location](https://github.com/hugsy/gef-extras/blob/main/scripts/syscall_args) | |

## Removed support for pyenv

Expand Down
7 changes: 4 additions & 3 deletions docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ your OS package manager to install them.

### GDB

Only [GDB 10.0 and higher](https://www.gnu.org/s/gdb) is required. It must be compiled with Python 3.10
or higher support. For most people, simply using your distribution package manager should be enough.
Only [GDB 10.0 and higher](https://www.sourceware.org/gdb/) is required. It must be compiled with
Python 3.10 or higher support. For most people, simply using your distribution package manager
should be enough.

As of January 2020, GEF officially doesn't support Python 2 any longer, due to Python 2 becoming
officially deprecated.
Expand Down Expand Up @@ -55,7 +56,7 @@ easily extended via
### Quick install

The quickest way to get started with GEF is through the installation script available. Simply make
sure you have [GDB 10.0 or higher](https://www.gnu.org/s/gdb), compiled with Python 3.10 or higher,
sure you have [GDB 10.0 or higher](https://www.sourceware.org/gdb/), compiled with Python 3.10 or higher,
and run

```bash
Expand Down
Loading