Skip to content

Commit bbdb5db

Browse files
authored
Various docs improvements (#1925)
* Expose elf/* instead of just elf * Remove rop/call, since it is not supposed to be a public API * Make QEMU examples into code blocks
1 parent 6b2cdbb commit bbdb5db

File tree

4 files changed

+7
-16
lines changed

4 files changed

+7
-16
lines changed

docs/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Each of the ``pwntools`` modules is documented here.
5252
context
5353
dynelf
5454
encoders
55-
elf
55+
elf/*
5656
exception
5757
filepointer
5858
filesystem
@@ -65,7 +65,6 @@ Each of the ``pwntools`` modules is documented here.
6565
protocols
6666
qemu
6767
replacements
68-
rop
6968
rop/*
7069
runner
7170
shellcraft
@@ -83,6 +82,7 @@ Each of the ``pwntools`` modules is documented here.
8382
:hidden:
8483

8584
testexample
85+
rop/call
8686

8787
.. only:: not dash
8888

File renamed without changes.

docs/source/rop/call.rst

Lines changed: 0 additions & 9 deletions
This file was deleted.

pwnlib/qemu.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
In general, everything magic happens "behind the scenes", and pwntools
1212
attempts to make your life easier.
1313
14-
When using :class:`.process.process`, pwntools will attempt to blindly
14+
When using :class:`.process`, pwntools will attempt to blindly
1515
execute the binary, in case your system is configured to use ``binfmt-misc``.
1616
1717
If this fails, pwntools will attempt to manually launch the binary under
@@ -38,19 +38,19 @@
3838
architectures.
3939
4040
First, install the QEMU emulator itself. If your binary is statically-linked,
41-
thsi is sufficient.
41+
this is sufficient. ::
4242
4343
$ sudo apt-get install qemu-user
4444
4545
If your binary is dynamically linked, you need to install libraries like libc.
4646
Generally, this package is named ``libc6-$ARCH-cross``, e.g. ``libc-mips-cross``.
47-
ARM comes in both soft-float and hard-float variants, e.g. ``armhf``.
47+
ARM comes in both soft-float and hard-float variants, e.g. ``armhf``. ::
4848
4949
$ sudo apt-get install libc6-arm64-cross
5050
5151
If your binary relies on additional libraries, you can generally find them
5252
easily with ``apt-cache search``. For example, if it's a C++ binary it
53-
may require ``libstdc++``.
53+
may require ``libstdc++``. ::
5454
5555
$ apt-cache search 'libstdc++' | grep arm64
5656
@@ -65,7 +65,7 @@
6565
If you try to run your library now, you'll probably see an error about ``libc.so.6`` missing.
6666
6767
Create the ``/etc/qemu-binfmt`` directory if it does not exist, and create a symlink to
68-
the appropriate path.
68+
the appropriate path. ::
6969
7070
$ sudo mkdir /etc/qemu-binfmt
7171
$ sudo ln -s /usr/aarch64-linux-gnu /etc/qemu-binfmt/aarch64

0 commit comments

Comments
 (0)