Skip to content

Commit

Permalink
[docs] updating docs to stipulate the new minimum requirements for gef
Browse files Browse the repository at this point in the history
  • Loading branch information
hugsy committed Jan 13, 2022
1 parent bdea715 commit 795f51c
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

## Instant Setup ##

Simply make sure you have [GDB 7.7 or higher](https://www.gnu.org/s/gdb) compiled with Python3 bindings, then:
Simply make sure you have [GDB 8.0 or higher](https://www.gnu.org/s/gdb) compiled with Python3.6+ bindings, then:


```bash
Expand Down
5 changes: 3 additions & 2 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ A simple recent GDB compiled with Python scripting support will do.

### Prerequisites

Only [GDB 7.7 and higher](https://www.gnu.org/s/gdb) is required. It must be
compiled with Python 3 support.
Only [GDB 8 and higher](https://www.gnu.org/s/gdb) is required. It must be
compiled with Python 3.6 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
13 changes: 7 additions & 6 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,28 @@ However, PEDA suffers from a major drawbacks, which the code is too fundamentall

Also, PEDA development has been quite idle for a few years now, and many new interesting features a debugger can provide simply do not exist.

## What if my GDB is < 7.7 ? ##
## What if my GDB is < 8.0 ? ##

GDB was introduced with its Python support early 2011 with the release of GDB 7. A (very) long way has gone since and the Python API has been massively improved, and GEF is taking advantage of them to provide the coolest features with as little performance impact as possible.

Therefore, it is highly recommended to run GEF with the latest version of GDB. However, all functions should work on a GDB 7.7 and up. If not, send a [bug report](https://github.com/hugsy/gef/issues) and provide as much details as possible.
Currently, GEF is optimized for running against GDB version 8.0+, and Python 3.6+. This allows for a best performance and best use of the GDB Python API. However, GEF can run on older versions too, check out [the version compatibility matrix](compat.md). For really older versions of GDB, you can use [`gef-legacy`](https://github.com/hugsy/gef-legacy) which supports a lot of older GDB, and a Python 2/3 compatibility layer.

If you are running an obsolete version, GEF will show a error and message and exit. You can still use GDB the normal way.
Therefore, it is highly recommended to run GEF with the latest version of GDB. However, all functions should work on a GDB 8.0 and up. If not, send a [bug report](https://github.com/hugsy/gef/issues) and provide as much details as possible.

If you are running an obsolete version, GEF will show a error and message and exit.

Some pre-compiled static binaries for both recent GDB and GDBServer can be downloaded from the [`gdb-static`](https://github.com/hugsy/gdb-static) repository.

_Note_: although some Ubuntu versions are marked as version 7.7 they are actually compiled with some missing features that will make `GEF` complain of an error. Before lodging a bug report, make sure to update your GDB (via APT is fine), or better install `gdb-multiarch` (the package `gdb64` will work as well, but is considered obsolete).

## I cannot get GEF setup!! ##

GEF will work on any GDB 7.7+ compiled with Python support. You can view that commands that failed to load using `gef missing`, but this will not affect GEF generally.
GEF will work on any GDB 8+ compiled with Python 3.6+ support. You can view that commands that failed to load using `gef missing`, but this will not affect GEF generally.

If you experience problems setting it up on your host, first go to the [Discord channel](https://discord.gg/HCS8Hg7) for that. You will find great people there willing to help.

Note that the GitHub issue section is to be used to **report bugs** and **GEF issues** (like unexpected crash, improper error handling, weird edge case, etc.), not a place to ask for help.

But fear not, GDB 7.7 corresponds to the latest packaged version of Ubuntu 14.04. Any version higher or equal will work just fine. So you might actually only need to run `apt install gdb` to get the full-force of GEF.
All recent distributions ship packaged GDB that should be ready-to-go, with a GDB >= 8.0 and Python 3.6+. Any version higher or equal will work just fine. So you might actually only need to run `apt install gdb` to get the full-force of GEF.

## I get a SegFault when starting GDB with GEF ##

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Or [try it online](https://demo.gef.blah.cat) (user:`gef`/password:`gef-demo`)

### Quick install ###

Simply make sure you have [GDB 7.7 or higher](https://www.gnu.org/s/gdb).
Simply make sure you have [GDB 8.0 or higher](https://www.gnu.org/s/gdb), compiled with Python 3.6 or higher.

```bash
$ bash -c "$(curl -fsSL http://gef.blah.cat/sh)"
Expand Down

0 comments on commit 795f51c

Please sign in to comment.