CensoredUsername / dynasm-rs

A dynasm-like tool for rust.
https://censoredusername.github.io/dynasm-rs/language/index.html
Mozilla Public License 2.0
716 stars 52 forks source link

Fix label docs (and a couple of misc bits) #92

Closed vext01 closed 5 days ago

vext01 commented 6 months ago

Main work is in https://github.com/CensoredUsername/dynasm-rs/commit/8d5f2f2b7b89e836e93c7a4653e1b97046281112, as discussed in #91.

I was unable to check the rendered output of my non-sourcefile doc changes (e.g. language ref), as I don't know how to generate the html :)

vext01 commented 6 months ago

I've pushed a few more commits.

I'll wait for you response about the label types before attempting to fix that.

I also notice that on nightly rust, cargo doc gives warnings like:

warning: field `span` is never read                                                                                                                                                                                                           
   --> plugin/src/arch/x64/ast.rs:337:9                                                                                                                                                                                                       
    |                                                                                                                                                                                                                                         
336 |     Indirect {                                                                                                                                                                                                                          
    |     -------- field in this variant                                                                                                                                                                                                      
337 |         span: Span,                                                                                                                                                                                                                     
    |         ^^^^                                                                                                                                                                                                                            
    |
    = note: `#[warn(dead_code)]` on by default

warning: field `span` is never read
   --> plugin/src/arch/x64/ast.rs:345:9
    |
344 |     Direct {
    |     ------ field in this variant
345 |         span: Span,
    |         ^^^^
...

But removing them also isn't correct. I'm not sure about this...

CensoredUsername commented 6 months ago

I'll likely look over this in the weekend. in the meantime, you should be able to generate the docs by running ./build_docs.sh

vext01 commented 6 months ago

Let me know and I can push changes to fix whatever I've misunderstood.

CensoredUsername commented 5 months ago

Poke ;) could you fix the errors in the label documentation I mentioned?

vext01 commented 4 months ago

My apologies. I missed your message. I'll try to get to this soon.

vext01 commented 2 months ago

@CensoredUsername were those changes any good?

CensoredUsername commented 1 month ago

Heya, sorry for the late reply. I want to merge this somewhere next week, it looks good :+1:

CensoredUsername commented 5 days ago

I did some cleanup, and it's all merged into dev now. thanks! And apologies for the delay.