Skip to content

Commit

Permalink
release 0.5
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel5151 committed May 22, 2021
1 parent de09632 commit 90aad2e
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Expand Up @@ -3,7 +3,7 @@
Cargo.lock

**/.gdb_history
# GDB will core dump if the target is implemented incorrectly (which it often is during debugging)
# The GDB client may core dump if the target is implemented incorrectly
**/core

.vscode
8 changes: 2 additions & 6 deletions CHANGELOG.md
@@ -1,12 +1,8 @@
# Changelog

All notable changes to this project will be documented in this file.

This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

# 0.5.0-dev

**This changelog is not final, and is subject to change**
# 0.5.0

While the overall structure of the API has remained the same, `0.5.0` does introduce a few breaking API changes that require some attention. That being said, it should not be a difficult migration, and updating to `0.5.0` from `0.4` shouldn't take more than 10 mins of refactoring.

Expand All @@ -21,7 +17,7 @@ Check out [`transition_guide.md`](./docs/transition_guide.md) for guidance on up
- Implement `ResumeAction::{Step,Continue}WithSignal`
- Added the `Exited(u8)`, `Terminated(u8)`, and `ReplayLog("begin"|"end")` stop reasons.
- Added `DisconnectReason::Exited(u8)` and `DisconnectReason::Terminated(u8)`.
- Reworked the `MultiThreadOps::resume` API to be significantly more egonomic and efficient
- Reworked the `MultiThreadOps::resume` API to be significantly more ergonomic and efficient
- See the [transition guide](https://github.com/daniel5151/gdbstub/blob/dev/0.5/docs/transition_guide.md#new-multithreadopsresume-api) for more details.

#### New Protocol Extensions
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Expand Up @@ -2,7 +2,7 @@
name = "gdbstub"
description = "An implementation of the GDB Remote Serial Protocol in Rust"
authors = ["Daniel Prilik <danielprilik@gmail.com>"]
version = "0.5.0-dev"
version = "0.5.0"
license = "MIT"
edition = "2018"
readme = "README.md"
Expand Down
6 changes: 1 addition & 5 deletions README.md
Expand Up @@ -5,7 +5,7 @@

An ergonomic and easy-to-integrate implementation of the [GDB Remote Serial Protocol](https://sourceware.org/gdb/onlinedocs/gdb/Remote-Protocol.html#Remote-Protocol) in Rust, with full `#![no_std]` support.

`gdbstub` makes it easy to integrate powerful guest debugging support to your emulator/hypervisor/debugger/embedded project. By implementing just a few basic methods of the [`gdbstub::Target`](https://docs.rs/gdbstub/latest/gdbstub/target/ext/base/singlethread/trait.SingleThreadOps.html) trait, you can have a rich GDB debugging session up-and-running in no time!
`gdbstub` makes it easy to integrate powerful guest debugging support to your emulator/hypervisor/debugger/embedded project. By implementing just a few basic methods of the [`gdbstub::Target`](https://docs.rs/gdbstub/latest/gdbstub/target/ext/base/singlethread/trait.SingleThreadOps.html) trait, you can have a rich GDB debugging session up and running in no time!

**If you're looking for a quick snippet of example code to see what a typical `gdbstub` integration might look like, check out [examples/armv4t/gdb/mod.rs](https://github.com/daniel5151/gdbstub/blob/dev/0.5/examples/armv4t/gdb/mod.rs)**

Expand All @@ -14,10 +14,6 @@ An ergonomic and easy-to-integrate implementation of the [GDB Remote Serial Prot
- [Changelog](CHANGELOG.md)
- [0.4 to 0.5 Transition Guide](docs/transition_guide.md)

> _Note:_ [`gdbstub:master`](https://github.com/daniel5151/gdbstub/tree/master) only contains code that is semver-compatible with the latest released version of `gdbstub` (currently `0.4.x`). All breaking changes and \*major\* new features are staged in [`gdbstub:dev/0.5`](https://github.com/daniel5151/gdbstub/blob/dev/0.5/CHANGELOG.md#050-dev).
>
> I am expecting to cut a `0.5` release quite soon (hopefully before the end of May 2021), so if you're starting a `gdbstub` integration from scratch, I would highly recommend working off the `dev/0.5` branch directly, thereby saving yourself the effort of having to update from `0.4` to `0.5`.
Why use `gdbstub`?

- **Excellent Ergonomics**
Expand Down
4 changes: 1 addition & 3 deletions gdbstub_arch/Cargo.toml
Expand Up @@ -11,10 +11,8 @@ homepage = "https://github.com/daniel5151/gdbstub"
repository = "https://github.com/daniel5151/gdbstub"
keywords = ["gdb", "emulation", "no_std", "debugging"]
categories = ["development-tools::debugging", "embedded", "emulators", "no-std"]
exclude = ["examples/**/*.elf", "examples/**/*.o"]

[dependencies]
gdbstub = { path = "../", default-features = false }
gdbstub = { path = "../", version = "0.5", default-features = false }

num-traits = { version = "0.2", default-features = false }

0 comments on commit 90aad2e

Please sign in to comment.