Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Second round of changes to the MCU docs #1624

Merged
merged 42 commits into from
Sep 12, 2022
Merged

Second round of changes to the MCU docs #1624

merged 42 commits into from
Sep 12, 2022

Commits on Sep 12, 2022

  1. Refer to this as sections not document

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    a16f2be View commit details
    Browse the repository at this point in the history

  2. Rename the toolchain/HAL section to prerequisites 

    ... because that's what it really is :-)
    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    28c9384 View commit details
    Browse the repository at this point in the history

  3. Rephrase the memory allocator paragraph 

    Usually "in order to" just becomes "to", but here it makes most sense to just
name the requirement first.
Also removed the bold from "nightly" as there's no other use of bold in this
doc, it looks a little out of place.
    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    49027f7 View commit details
    Browse the repository at this point in the history

  4. Take the person out of the section connecting sentence - it's simpler… 

    … that way
    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    e06ea2d View commit details
    Browse the repository at this point in the history

  5. create -> crate

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    5e56baf View commit details
    Browse the repository at this point in the history

  6. bare-meta -> bare metal

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    9495fc6 View commit details
    Browse the repository at this point in the history

  7. Minor edit 

    Refer to the source of the features
    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    354245b View commit details
    Browse the repository at this point in the history

  8. Polish compat-0.3.0 explanation 

    * Fix persona (we selected the feature)
* Use the blog title for the link to the blog.
    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    ffb7817 View commit details
    Browse the repository at this point in the history

  9. Use but instead of which to emphasize the contrast between std and ba… 

    …re metal
    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    7c3a183 View commit details
    Browse the repository at this point in the history

  10. Don't use future tense for what describes the present

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    425bfbf View commit details
    Browse the repository at this point in the history

  11. Simplify the unsafe-single-threaded guarantees 

    Tell what is okay, not what is not okay.
    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    2001137 View commit details
    Browse the repository at this point in the history

  12. Fix reference to std feature 

    Refere to it in regular double quotes, like earlier. This could also be swapped to use a back tick, but
then it should be done in both places.
    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    b00011e View commit details
    Browse the repository at this point in the history

  13. Fix libm feature description 

    First say why we select the feature, then provide background. Makes it easier to skim.
    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    db4c515 View commit details
    Browse the repository at this point in the history

  14. Re-introduce the HAL abbreviation

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    3192933 View commit details
    Browse the repository at this point in the history

  15. Fix the build.rs section order 

    Providing the code snippet first and then the explanation makes it much easier to read.
    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    7cdeb65 View commit details
    Browse the repository at this point in the history

  16. Fix application structure intro 

    Each tasks "receives", "reacts" or "renders.
    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    20ca2ad View commit details
    Browse the repository at this point in the history

  17. Remove use of typical 

    Every operating system provides the primitives, in reality.
    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    cb1e761 View commit details
    Browse the repository at this point in the history

  18. Use user interface consistently

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    1fc9eaa View commit details
    Browse the repository at this point in the history

  19. In bare metal environments it is your responsibility to substitute th… 

    …e event loop

It's not something that'll happen in the future :-)
    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    640ba85 View commit details
    Browse the repository at this point in the history

  20. Shorten application structure bullet points

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    b0ea94e View commit details
    Browse the repository at this point in the history

  21. Connect the crate selection with the need of writing drivers better 

    by referring to crates as missing.
    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    969aa30 View commit details
    Browse the repository at this point in the history

  22. Clarify the purpose of forward input from peripherals to Slint

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    3122ff4 View commit details
    Browse the repository at this point in the history

  23. Minor sentence polish

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    e1a6ca0 View commit details
    Browse the repository at this point in the history

  24. Use contractions

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    1a3005d View commit details
    Browse the repository at this point in the history

  25. an minimal -> a minimal

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    90247c5 View commit details
    Browse the repository at this point in the history

  26. Remove stray "in order to"

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    ff5855e View commit details
    Browse the repository at this point in the history

  27. since -> between 

    This emphasizes the time difference better
    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    f206d2f View commit details
    Browse the repository at this point in the history

  28. Simplify the additional functionality the trait can be used to implement

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    7418994 View commit details
    Browse the repository at this point in the history

  29. Polish and simplify the renderer section a little bit

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    bbadf2f View commit details
    Browse the repository at this point in the history

  30. Use "Rendering" consistently for both rendering section titles

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    988d8c7 View commit details
    Browse the repository at this point in the history

  31. Attemt to simplify the remaining sections in one go

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    971bdbd View commit details
    Browse the repository at this point in the history

  32. Fix typo

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    bff6e9f View commit details
    Browse the repository at this point in the history

  33. The global memory allocator support is available *in* the rust version

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    4b47af5 View commit details
    Browse the repository at this point in the history

  34. Emphasize that only the night version has what we need

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    fe669bf View commit details
    Browse the repository at this point in the history

  35. Fix missing plural

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    fe1f3ce View commit details
    Browse the repository at this point in the history

  36. Consistently use 0.3.0 instead of mixing 0.3 and 0.3.0

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    0d55efd View commit details
    Browse the repository at this point in the history

  37. Clarify that thread_local! as a macro is not available

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    817bade View commit details
    Browse the repository at this point in the history

  38. drive -> operate 

    There's already a lot of "driving" in that section.
    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    12fea26 View commit details
    Browse the repository at this point in the history

  39. Update api/rs/slint/mcu.md 

    Co-authored-by: Olivier Goffart <olivier.goffart@slint-ui.com>
    @tronical @ogoffart
    tronical and ogoffart authored Sep 12, 2022
    Configuration menu
    Copy the full SHA
    6b6027a View commit details
    Browse the repository at this point in the history

  40. Update api/rs/slint/mcu.md 

    Co-authored-by: Olivier Goffart <olivier.goffart@slint-ui.com>
    @tronical @ogoffart
    tronical and ogoffart authored Sep 12, 2022
    Configuration menu
    Copy the full SHA
    434274a View commit details
    Browse the repository at this point in the history

  41. Additional suggestions from Olivier

    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    63b99cb View commit details
    Browse the repository at this point in the history

  42. only available in the nightly version -> only possible with the night… 

    …ly version

They might settle on a different API, but the possibility is key here.
    @tronical
    tronical committed Sep 12, 2022
    Configuration menu
    Copy the full SHA
    94c4ad9 View commit details
    Browse the repository at this point in the history