sharksforarms / deku

Declarative binary reading and writing: bit-level, symmetric, serialization/deserialization
Apache License 2.0
1.14k stars 55 forks source link

Document the `logging` feature. #374

Closed vext01 closed 1 year ago

vext01 commented 1 year ago

Fixes #362.

vext01 commented 1 year ago

Just realised that not all the useful logging messages come from the deku crate. Some come from the consumer, presumably due to macro madness.

See: b19fd43

This will need squashing.

wcampbell0x2a commented 1 year ago

Just realised that not all the useful logging messages come from the deku crate. Some come from the consumer, presumably due to macro madness.

See: b19fd43

This will need squashing.

Correct. Since it's a derive macro, you would need RUST_LOG={deku_crate}=trace. I think it's fine to not mention this.

vext01 commented 1 year ago

OK to squash the commits?

On Fri, 10 Nov 2023, 18:32 wcampbell, @.***> wrote:

Just realised that not all the useful logging messages come from the deku crate. Some come from the consumer, presumably due to macro madness.

See: b19fd43 https://github.com/sharksforarms/deku/pull/374/commits/b19fd439207bbe62b334e2aa63be75195059f9da

This will need squashing.

Correct. Since it's a derive macro, you would need RUST_LOG={deku_crate}=trace. I think it's fine to not mention this.

— Reply to this email directly, view it on GitHub https://github.com/sharksforarms/deku/pull/374#issuecomment-1806230656, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAETWGZ324SC2A7TTQY6UZLYDZXKNAVCNFSM6AAAAAA7GJGJVWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMBWGIZTANRVGY . You are receiving this because you authored the thread.Message ID: @.***>

wcampbell0x2a commented 1 year ago

OK to squash the commits? On Fri, 10 Nov 2023, 18:32 wcampbell, @.> wrote: Just realised that not all the useful logging messages come from the deku crate. Some come from the consumer, presumably due to macro madness. See: b19fd43 <b19fd43> This will need squashing. Correct. Since it's a derive macro, you would need RUST_LOG={deku_crate}=trace. I think it's fine to not mention this. — Reply to this email directly, view it on GitHub <#374 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAETWGZ324SC2A7TTQY6UZLYDZXKNAVCNFSM6AAAAAA7GJGJVWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMBWGIZTANRVGY . You are receiving this because you authored the thread.Message ID: @.>

Yes

vext01 commented 1 year ago

squashed.

vext01 commented 1 year ago

(sorry for the delay)

sharksforarms commented 1 year ago

Some CI issues: pushed https://github.com/sharksforarms/deku/pull/374/commits/4e9dd7a34611a43436df16577ada76d1a01e124c to address it

failures:

---- src/lib.rs - (line 274) stdout ----
error: expected one of `.`, `;`, `?`, `}`, or an operator, found `,`
Error:  --> src/lib.rs:276:23
  |
5 | deku = { version = "*", features = ["logging"] }
  |                       ^ expected one of `.`, `;`, `?`, `}`, or an operator

error: expected `;`, found `log`
Error:  --> src/lib.rs:276:49
  |
5 | deku = { version = "*", features = ["logging"] }
  |                                                 ^ help: add `;` here
6 | log = "*"
  | --- unexpected token

error: expected `;`, found `env_logger`
Error:  --> src/lib.rs:277:10
  |
6 | log = "*"
  |          ^ help: add `;` here
7 | env_logger = "*"
  | ---------- unexpected token

error[E0423]: expected value, found crate `env_logger`
Error:  --> src/lib.rs:278:1
  |
7 | env_logger = "*"
  | ^^^^^^^^^^
  |
help: you might have meant to introduce a new binding
  |
7 | let env_logger = "*"
  | +++

error: aborting due to 4 previous errors
Error: aborting due to 4 previous errors
For more information about this error, try `rustc --explain E0423`.
Couldn't compile the test.

failures:
    src/lib.rs - (line 274)

test result: FAILED. 48 passed; 1 failed; 3 ignored; 0 measured; 0 filtered out; finished in 4.36s

error: doctest failed, to rerun pass `-p deku --doc`
Error: The process '/home/runner/.cargo/bin/cargo' failed with exit code 101