Code

Rewrite docs for pointer methods#53783

Code

Merged

bors merged 34 commits intorust-lang:masterrust-lang/rust:masterfrom RalfJung:ptr-docsRalfJung/rust:ptr-docsCopy head branch name to clipboardSep 24, 2018

+701-549

Commits

Commits on Aug 29, 2018

• Rewrite docs for std::ptr

  Show description for 911d35f
  

  ecstatic-morse

  authored and

  RalfJung

  committed
  911d35f

  Copy full SHA for 911d35f

• Mention alignment in top-level docs

  Show description for da58beb
  

  Dylan MacKenzie

  authored and

  RalfJung

  committed
  da58beb

  Copy full SHA for da58beb

• Fix failing doctests

  

  ecstatic-morse

  authored and

  RalfJung

  committed
  9f5a3cc

  Copy full SHA for 9f5a3cc

• Fix unused variable warning in doctest

  

  ecstatic-morse

  authored and

  RalfJung

  committed
  04a08c6

  Copy full SHA for 04a08c6

• Update docs for swap_nonoverlapping

  Show description for 7b2ef6b
  

  ecstatic-morse

  authored and

  RalfJung

  committed
  7b2ef6b

  Copy full SHA for 7b2ef6b

• Reword module level docs re: alignment

  

  ecstatic-morse

  authored and

  RalfJung

  committed
  6f7338b

  Copy full SHA for 6f7338b

• Fix off-by-one error when specifying a valid range

  

  ecstatic-morse

  authored and

  RalfJung

  committed
  30122e9

  Copy full SHA for 30122e9

• Remove definiton of valid pointer

  Show description for e40585f
  

  ecstatic-morse

  authored and

  RalfJung

  committed
  e40585f

  Copy full SHA for e40585f

• Redefine range validity

  Show description for ea5570c
  

  ecstatic-morse

  authored and

  RalfJung

  committed
  ea5570c

  Copy full SHA for ea5570c

• Incorporate RalfJung's suggestions

  Show description for 3a55c85
  

  ecstatic-morse

  authored and

  RalfJung

  committed
  3a55c85

  Copy full SHA for 3a55c85

• You can't make an omlette without breaking a few links

  

  ecstatic-morse

  authored and

  RalfJung

  committed
  95a9088

  Copy full SHA for 95a9088

• Add a list of known facts re: validity

  Show description for 7e165d9
  

  ecstatic-morse

  authored and

  RalfJung

  committed
  7e165d9

  Copy full SHA for 7e165d9

• Resolve null/ZST conflict correctly (whoops)

  

  ecstatic-morse

  authored and

  RalfJung

  committed
  c8da321

  Copy full SHA for c8da321

• edit docs a little

  RalfJung

  committed
  b0c5dc2

  Copy full SHA for b0c5dc2

• clarify that these are preliminary guarantees

  RalfJung

  committed
  098bec8

  Copy full SHA for 098bec8

Commits on Aug 30, 2018

• clarify ZST comment

  RalfJung

  committed
  fc63113

  Copy full SHA for fc63113

• apply comments

  RalfJung

  committed
  1ec66fb

  Copy full SHA for 1ec66fb

• address remaining remarks and add example for dropping unaligned data

  RalfJung

  committed
  e869b81

  Copy full SHA for e869b81

• avoid shadowing; fix examples

  RalfJung

  committed
  d97f61f

  Copy full SHA for d97f61f

• improve volatile comments

  RalfJung

  committed
  c06f551

  Copy full SHA for c06f551

• fix example

  RalfJung

  committed
  2741224

  Copy full SHA for 2741224

• fix example

  RalfJung

  committed
  18a7bdb

  Copy full SHA for 18a7bdb

Commits on Aug 31, 2018

• turn ptr type method docs into links to docs of free functions, to avoid duplication and inconsistency

  RalfJung

  committed
  4ed469c

  Copy full SHA for 4ed469c

• apply feedback

  RalfJung

  committed
  dc2237c

  Copy full SHA for dc2237c

• (un)aligned

  RalfJung

  committed
  b463871

  Copy full SHA for b463871

• fix doctests

  RalfJung

  committed
  408a6a0

  Copy full SHA for 408a6a0

Commits on Sep 1, 2018

• Valid raw pointers

  RalfJung

  committed
  755de3c

  Copy full SHA for 755de3c

• remark on concurrency in validity section

  RalfJung

  committed
  bc809e0

  Copy full SHA for bc809e0

Commits on Sep 11, 2018

• fix typos

  ubsan

  committed
  78f5b68

  Copy full SHA for 78f5b68

• Merge pull request #1 from ubsan/ptr-docs

  Show description for c44e88c
  RalfJung

  authored
  c44e88c

  Copy full SHA for c44e88c

Commits on Sep 17, 2018

• tweaks

  RalfJung

  committed
  2713d36

  Copy full SHA for 2713d36

• rearrange for clarity

  RalfJung

  committed
  0ec87d0

  Copy full SHA for 0ec87d0

Commits on Sep 18, 2018

• clarify swap

  RalfJung

  committed
  adcc0d2

  Copy full SHA for adcc0d2

Commits on Sep 21, 2018

• clarify write_bytes a bit

  RalfJung

  committed
  c197dc4

  Copy full SHA for c197dc4