Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Activity
    QuietMisdreavus
    @QuietMisdreavus
    oh hey, sxd-xpath is even maintained by shep, nice
    Vitaly Shukela
    @vi
    (by the way used a nice hack while debugging (pseudocode): while true; do htmldocck.py ... && play_sound1 || play_sound2; done. It makes it audible if the test is currently failing or passing without even leaving the editor and switching to console.)
    QuietMisdreavus
    @QuietMisdreavus
    oh nice
    i do all my dev on a remote server, so all i can do is ^Z to hide my vim and add ; echo -e '\a' to spit a terminal bell when a build/test is done
    whether or not a build ends in success or failure is primarily indicated by how long it takes to ring the bell :V
    i also didn't realize htmldocck.py could be just called directly like that, i should keep that in mind
    i'm used to going through x.py test which ropes in way more things
    so if you're okay with that test, the last thing is the CSS we talked about earlier
    Vitaly Shukela
    @vi
    With strace powers one can even call ld that is called by gcc that is called by make that is called by .... directly (but here the command line for running it quick just getting printed when test fails).
    QuietMisdreavus
    @QuietMisdreavus
    you are clearly better at this than i am o_O
    QuietMisdreavus @QuietMisdreavus has yet to approach strace
    Vitaly Shukela
    @vi
    Imagine build system is a crypto. It's likely a weak crypto, so replay attack is going to be easy.
    QuietMisdreavus
    @QuietMisdreavus
    lol
    Vitaly Shukela
    @vi
    (The same can go for tricky file/protocol format. Imagine it's just encrypted and crack that cipher.)
    QuietMisdreavus
    @QuietMisdreavus
    nice, i like it!
    Ranveer Aggarwal
    @ranveeraggarwal
    Hello! I'm new to Rust (written a few hundred lines to get a hang of rustc) and am looking for something to work on. I would love to work on rustdoc and to get started, I am looking for an easy issue (with mentorship, if possible).
    QuietMisdreavus
    @QuietMisdreavus
    @ranveeraggarwal Thanks for checking out rustdoc! I'll see if i can rummage through the issues at some point today to find you one
    there's certainly a ton to wade through, but only a few that don't need a whole lot of familiarity with the codebase
    (also sorry for totally missing your message yesterday! >_>)
    Ranveer Aggarwal
    @ranveeraggarwal
    Thank you! :smile:
    I'm hoping to build the familiarity with a couple of simple issues and then help out with the bigger ones.
    QuietMisdreavus
    @QuietMisdreavus
    yeah!
    rustdoc isn't all that complicated to move around in, it just has the disadvantage of being part of the compiler's build system
    (also a few 3000-line files >_>)
    Ranveer Aggarwal
    @ranveeraggarwal

    (also a few 3000-line files >_>)

    Ouch, it's going to take a while then. Up for the challenge :D

    QuietMisdreavus
    @QuietMisdreavus
    nah, if i find an issue for you (or if you find one and bring it here) then i can usually point you to where in the file you need to look at
    Ranveer Aggarwal
    @ranveeraggarwal
    Awesome!
    QuietMisdreavus
    @QuietMisdreavus
    so if you get antsy and want to go hunting before i get to it, feel free to wander through the full list https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-rustdoc
    (i've got some dayjob stuff to take care of today, so it may be a bit before i can go actively searching)
    Ranveer Aggarwal
    @ranveeraggarwal
    Sure
    QuietMisdreavus
    @QuietMisdreavus
    @ranveeraggarwal so here's one i wanted to see myself recently rust-lang/rust#45150
    (i didn't know if it had an issue already so i just opened one for it >_>)
    i just mentored someone else on something very similar recently (in fact it's the last thing in the backlog if you scroll back above when you entered) so i know this will be small
    rustdoc is in the rust-lang/rust repo, so if you don't have that set up yet that's step zero
    otherwise, in src/librustdoc/html/render.rs there's a function called item_trait that prints everything in the main body of a trait page
    QuietMisdreavus
    @QuietMisdreavus
    specifically for this, it defines an inner function called trait_item that it runs on everything in the trait definition (associated items and methods) to print its docs https://github.com/rust-lang/rust/blob/master/src/librustdoc/html/render.rs#L2365-L2381
    [src] links are created with the help of a local Item type and its method src_href, which tries to assemble a URL for the given item
    the PR from earlier added a src link farther down in item_trait, so you can even steal its html generation for it, since it'll work the same https://github.com/rust-lang/rust/blob/master/src/librustdoc/html/render.rs#L2494-L2499
    QuietMisdreavus
    @QuietMisdreavus
    so the smallest change that would add this would just copy/paste that block into trait_item (the inner function) after the render_stability_since call
    item_trait takes two Items, so the one you want is m - the other one is the trait itself
    hopefully that all makes sense
    this is arguably the smallest change you could make to rustdoc, but it's still a really useful one
    (saving things like little css changes or typo fixes, i guess)
    Ranveer Aggarwal
    @ranveeraggarwal
    Looks good, thanks! I will clone the repo and get to it :grin:
    QuietMisdreavus
    @QuietMisdreavus
    awesome! let me know if you run into any issues
    Ranveer Aggarwal
    @ranveeraggarwal
    Sure!
    QuietMisdreavus
    @QuietMisdreavus
    since you said you're cloning the repo now, i'll point you to the setup tips in the bottom 2/3 of this post https://quietmisdreavus.net/code/2017/09/18/come-work-on-rustdoc/
    that should help get you most of the way there
    Ranveer Aggarwal
    @ranveeraggarwal
    Awesome, I guess I have everything required. I live in an opposite (D/N) timezone, so it'll be a while until I get back.
    QuietMisdreavus
    @QuietMisdreavus
    oh, no worries
    gitter has persistent server-side logs, so if you leave a question in here i'll see it the next time i'm on