Allow bitflags v1 and v2 to coexist #894

manushT · 2024-11-27T16:47:16Z

The patch breaks cargo's additive features

Fixes #877.

jonathanpallant · 2024-11-27T16:57:21Z

Unfortunately this doesn't work because Library A might use defmt to describe some data type and expect the bitflags v1 API whilst Library B might use defmt but expect the bitflags v2 API (if we add it).

You could have a feature flag for bitflags v2 so that we keep the dependency list as short as possible, but it has to be additional and exported as a different macro with a different name.

jonathanpallant · 2024-11-29T13:55:41Z

The CHANGELOG was reformatted. Can you rebase?

jonathanpallant · 2024-11-29T14:36:59Z

The format check failed, I'm afraid.

jonathanpallant · 2024-11-29T14:38:39Z

CHANGELOG.md

 * [#845] `decoder`: fix println!() records being printed with formatting
 * [#843] `defmt`: Sort IDs of log msgs by severity to allow runtime filtering by severity
 * [#822] `CI`: Run `cargo semver-checks` on every PR
+* [#877]:`defmt`: Allow `bitflags` v1 and v2 to coexist


This change was made to Defmt-next because defmt-0.3.9 has already been released so it needs to be in the section above.

This should refer to the PR, which is Allow bitflags v1 and v2 to coexist #894.

You will need to add a URL for [#894] down at the bottom of the file for the link to be valid.

jonathanpallant · 2024-11-29T14:48:53Z

CHANGELOG.md

 > A highly efficient logging framework that targets resource-constrained devices, like microcontrollers

 [defmt-next]: https://github.com/knurling-rs/defmt/compare/defmt-v0.3.9...main
+[defmt-next]: https://github.com/knurling-rs/defmt/pull/894


We already have a markdown link for [defmt-next] which was correct. You can't add another.

The change you've made needs to be listed under ## [defmt-next] heading.

CHANGELOG.md

defmt/src/lib.rs

jonathanpallant · 2024-12-02T09:27:45Z

macros/src/items/bitflags.rs

+            let bits_access = if is_v2 {
+                quote! { bits() }
+            } else {
+                quote! { bits}


Suggested change

quote! { bits}

quote! { bits }

jonathanpallant · 2025-01-07T14:34:45Z

@manushT - we still have an outstanding comment on this one.

vic1707 · 2025-01-15T10:20:00Z

defmt/src/export/mod.rs

 pub use bitflags::bitflags;

+#[cfg(feature = "bitflagsv2")]
+pub use bitflagsv2::bitflags as bitflagsv2;


may I ask for the bitflags traits (Bits & Flags) to also be re-exported.

Suggested change

pub use bitflagsv2::bitflags as bitflagsv2;

pub use bitflagsv2::{bitflags as bitflagsv2, Bits, Flags};

I need them, and other users might want them too, for a project and would prefer relying on the version installed by defmt instead of listing it manually.
Refers to #923

That's reasonable - perhaps for v2 import the whole crate like:

pub use bitflags::{bitflags, self}; #[cfg(feature = "bitflagsv2")] pub use bitflagsv2::{bitflags as bitflagsv2, self};

@manushT any thoughts on this one?

LeonMatthesKDAB

Mostly looks good to me, only two nitpicks.

defmt/src/lib.rs

jonathanpallant

Minor nit on some formatting, and I like the proposal for re-exporting some useful types from the crate (to save people having to go and pull in the exact one that defmt is using).

I think this requires a Wire Format Version bump? In which case I think it's blocked until after 1.0. Maybe we should do a Version 5 with the encoded symbols and a bunch of other stuff.

jonathanpallant · 2025-02-26T16:42:30Z

There's still an outstanding question around importing and re-exporting the bitflags API so that people don't have to try and include the same version of bitflags in their application that defmt was using. I think that's a good idea.

manushT force-pushed the allow-bitflags-v1-and-v2-to-coexist branch 4 times, most recently from 705a4d2 to aabac90 Compare November 29, 2024 13:46

manushT force-pushed the allow-bitflags-v1-and-v2-to-coexist branch 2 times, most recently from 0ffa167 to 5f6ef8a Compare November 29, 2024 14:34

jonathanpallant reviewed Nov 29, 2024

View reviewed changes

manushT force-pushed the allow-bitflags-v1-and-v2-to-coexist branch 2 times, most recently from b923d69 to b27ffe3 Compare November 29, 2024 14:45

jonathanpallant reviewed Nov 29, 2024

View reviewed changes

manushT force-pushed the allow-bitflags-v1-and-v2-to-coexist branch from b27ffe3 to c3cca96 Compare November 29, 2024 15:05

jonathanpallant reviewed Nov 29, 2024

View reviewed changes

CHANGELOG.md Show resolved Hide resolved

manushT force-pushed the allow-bitflags-v1-and-v2-to-coexist branch 3 times, most recently from 58cab23 to 5a22752 Compare November 29, 2024 15:23

jonathanpallant requested changes Dec 2, 2024

View reviewed changes

Urhengulas added the pr waits on: author Pull Request requires changes from the author label Jan 8, 2025

vic1707 reviewed Jan 15, 2025

View reviewed changes

manushT force-pushed the allow-bitflags-v1-and-v2-to-coexist branch 3 times, most recently from ce922bb to fb82c87 Compare January 15, 2025 12:31

LeonMatthesKDAB reviewed Jan 15, 2025

View reviewed changes

defmt/src/lib.rs Outdated Show resolved Hide resolved

defmt/src/lib.rs Outdated Show resolved Hide resolved

defmt/src/lib.rs Outdated Show resolved Hide resolved

manushT force-pushed the allow-bitflags-v1-and-v2-to-coexist branch from fb82c87 to abd313a Compare January 15, 2025 13:16

manushT force-pushed the allow-bitflags-v1-and-v2-to-coexist branch from abd313a to e8f6af3 Compare January 29, 2025 16:01

manushT requested a review from jonathanpallant January 29, 2025 16:12

jonathanpallant reviewed Jan 29, 2025

View reviewed changes

defmt/src/lib.rs Outdated Show resolved Hide resolved

jonathanpallant reviewed Jan 29, 2025

View reviewed changes

manushT force-pushed the allow-bitflags-v1-and-v2-to-coexist branch from 6a14e99 to a648875 Compare January 31, 2025 12:36

manushT added 5 commits February 26, 2025 13:38

Allow bitflags v1 and v2 to coexist

87e207a

Fix change-log

2c89bc7

Fix format

cc50563

Adds documentation for bitflagsv2

bb4baed

Fix documentation formatting

c4e940a

manushT force-pushed the allow-bitflags-v1-and-v2-to-coexist branch from a648875 to c4e940a Compare February 26, 2025 13:01

jonathanpallant added this to the defmt-1.0 milestone Mar 5, 2025

	pub use bitflagsv2::bitflags as bitflagsv2;
	pub use bitflagsv2::{bitflags as bitflagsv2, Bits, Flags};

Uh oh!

Allow bitflags v1 and v2 to coexist #894

Are you sure you want to change the base?

Allow bitflags v1 and v2 to coexist #894

Uh oh!

Conversation

manushT commented Nov 27, 2024 • edited by Urhengulas Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jonathanpallant commented Nov 27, 2024

Uh oh!

jonathanpallant commented Nov 29, 2024

Uh oh!

jonathanpallant commented Nov 29, 2024

Uh oh!

jonathanpallant Nov 29, 2024

Choose a reason for hiding this comment

Uh oh!

manushT Nov 29, 2024

Choose a reason for hiding this comment

Uh oh!

jonathanpallant Nov 29, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jonathanpallant Dec 2, 2024

Choose a reason for hiding this comment

Uh oh!

jonathanpallant commented Jan 7, 2025

Uh oh!

vic1707 Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonathanpallant Jan 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonathanpallant Feb 3, 2025

Choose a reason for hiding this comment

Uh oh!

LeonMatthesKDAB left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jonathanpallant left a comment

Choose a reason for hiding this comment

Uh oh!

jonathanpallant commented Feb 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

manushT commented Nov 27, 2024 •

edited by Urhengulas

Loading

vic1707 Jan 15, 2025 •

edited

Loading

jonathanpallant Jan 29, 2025 •

edited

Loading