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.

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

Rewrite docs for std::ptr #49767

Merged
merged 9 commits into from
May 15, 2018
Merged

Rewrite docs for std::ptr #49767

merged 9 commits into from
May 15, 2018

Commits on Apr 7, 2018

  1. Rewrite docs for std::ptr

    - Add links to the GNU libc docs for `memmove`, `memcpy`, and
      `memset`, as well as internally linking to other functions in `std::ptr`
    - List sources of UB for all functions.
    - Add example to `ptr::drop_in_place` and compares it to `ptr::read`.
    - Add examples which more closely mirror real world uses for the
      functions in `std::ptr`. Also, move the reimplementation of `mem::swap`
      to the examples of `ptr::read` and use a more interesting example for
      `copy_nonoverlapping`.
    - Change module level description
    ecstatic-morse committed Apr 7, 2018
    Configuration menu
    Copy the full SHA
    8b8091d View commit details
    Browse the repository at this point in the history
  2. Change write_bytes test causing UB to no_run

    This also fixes improper text wrapping.
    ecstatic-morse committed Apr 7, 2018
    Configuration menu
    Copy the full SHA
    ee259e4 View commit details
    Browse the repository at this point in the history

Commits on Apr 8, 2018

  1. Configuration menu
    Copy the full SHA
    b564c4a View commit details
    Browse the repository at this point in the history
  2. Don't link "Undefined Behavior" heading

    The rendered version does not make clear that this is a link to another
    page, and it breaks the anchor link.
    ecstatic-morse committed Apr 8, 2018
    Configuration menu
    Copy the full SHA
    6eceb94 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    422b616 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    d7ce9a2 View commit details
    Browse the repository at this point in the history

Commits on Apr 9, 2018

  1. Fix various nits from PR review

    - Remove redundant "unsafe" from module description.
    - Add a missing `Safety` heading to `read_unaligned`.
    - Remove weasel words in `Undefined Behavior` description for
      `write{,_unaligned,_bytes}`.
    ecstatic-morse committed Apr 9, 2018
    Configuration menu
    Copy the full SHA
    d7209d5 View commit details
    Browse the repository at this point in the history

Commits on May 9, 2018

  1. Use the "Safety" heading instead of "Undefined Behavior"

    Dylan MacKenzie committed May 9, 2018
    Configuration menu
    Copy the full SHA
    e350ba4 View commit details
    Browse the repository at this point in the history
  2. Shorten ownership safety discussion in read_volatile

    Non-`Copy` types should not be in volatile memory.
    Dylan MacKenzie committed May 9, 2018
    Configuration menu
    Copy the full SHA
    827251e View commit details
    Browse the repository at this point in the history