Skip to content
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

Jump to bottom

docs: Add note about giving credit to ported tools #2154

Merged
merged 2 commits into from
May 13, 2024
Merged

docs: Add note about giving credit to ported tools #2154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
764f850
docs: Add note about giving credit to ported tools
fidgetingbits May 9, 2024
3def6f7
Update DEVELOPING.md
disconnect3d May 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Empty file added CREDITS.md
View file
Open in desktop
Empty file.
24 changes: 16 additions & 8 deletions DEVELOPING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
- [Development Basics](#development-basics)
* [Environment setup](#environment-setup)
* [Testing](#testing)
* [Linting](#linting)
* [Minimum Supported Versions](#minimum-supported-versions)
- [Environment setup](#environment-setup)
- [Testing](#testing)
- [Linting](#linting)
- [Minimum Supported Versions](#minimum-supported-versions)
- [Adding a Command](#adding-a-command)
- [Adding a Configuration Option](#adding-a-configuration-option)
* [Configuration Docstrings](#configuration-docstrings)
* [Triggers](#triggers)
- [Configuration Docstrings](#configuration-docstrings)
- [Triggers](#triggers)
- [Porting public tools](#porting-public-tools)
- [Random developer notes](#random-developer-notes)

# Development Basics
Expand Down Expand Up @@ -123,7 +124,14 @@ TODO: There are many places GDB shows docstrings, and they show up slightly diff

## Triggers

TODO: If we want to do something when user changes config/theme - we can do it defining a function and decorating it with `pwndbg.config.Trigger`.
TODO: If we want to do something when user changes config/theme - we can do it defining a function and decorating it
with `pwndbg.config.Trigger`.

# Porting public tools

If porting a public tool to pwndbg, please make a point of crediting the original author in the pwndbg source code. This
fidgetingbits marked this conversation as resolved.
Show resolved Hide resolved
can be added to [CREDITS.md](./CREDITS.md) noting the original author/inspiration, and linking to the original tool/article. Also
please be sure that the license of the original tool is suitable to porting into pwndbg, such as MIT.

# Random developer notes

Expand All @@ -133,7 +141,7 @@ Feel free to update the list below!

* If there is possibility, don't use `gdb.execute` as this requires us to parse the string and so on; there are some cases in which there is no other choice. Most of the time we try to wrap GDB's API to our own/easier API.

* We have our own `pwndbg.config.Parameter` (which extends `gdb.Parameter`) - all of our parameters can be seen using `config` or `theme` commands.
* We have our own `pwndbg.config.Parameter` (which extends `gdb.Parameter`) - all of our parameters can be seen using `config` or `theme` commands.

* The dashboard/display/context we are displaying is done by `pwndbg/commands/context.py` which is invoked through GDB's prompt hook (which we defined in `pwndbg/prompt.py` as `prompt_hook_on_stop`).

Expand Down