Skip to content

A bunch of minor documentation tweaks and fixes. #63808

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
Merged
merged 8 commits into from
Aug 23, 2019
Merged

A bunch of minor documentation tweaks and fixes. #63808

merged 8 commits into from
Aug 23, 2019

Conversation

tomasz-rozanski
Copy link
Contributor

No description provided.

@tomasz-rozanski
Fix a typo.
a078a34
@tomasz-rozanski
Fix formatting.
4ee6ee0
@tomasz-rozanski
Remove redundant mut.
7e13679
@tomasz-rozanski
Fix punctuation.
49dce29
@tomasz-rozanski
Change code formatting for readability.
3b04e91
@tomasz-rozanski
Make use of existing constants.
cdedd26 
f32::consts::PI / 2.0 -> f32::consts::FRAC_PI_2
f32::consts::PI / 4.0 -> f32::consts::FRAC_PI_4
f64::consts::PI / 2.0 -> f64::consts::FRAC_PI_2
f64::consts::PI / 4.0 -> f64::consts::FRAC_PI_4
@tomasz-rozanski
Change variables names to be more consistent.
eae5d77 
Changed all instances of `c_str` into `cstr` in the documentation examples. This is also consistent with the module source code.
@rust-highfive
Copy link
Contributor

r? @KodrAus

(rust_highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 22, 2019
@rust-highfive
Copy link
Contributor

The job x86_64-gnu-llvm-6.0 of your PR failed (raw log). Through arcane magic we have determined that the following fragments from the build log may contain information about the problem.

Click to expand the log. 
2019-08-22T13:39:04.9117742Z ##[command]git remote add origin https://github.com/rust-lang/rust
2019-08-22T13:39:04.9318750Z ##[command]git config gc.auto 0
2019-08-22T13:39:04.9402841Z ##[command]git config --get-all http.https://github.com/rust-lang/rust.extraheader
2019-08-22T13:39:04.9468282Z ##[command]git config --get-all http.proxy
2019-08-22T13:39:04.9614154Z ##[command]git -c http.extraheader="AUTHORIZATION: basic ***" fetch --force --tags --prune --progress --no-recurse-submodules --depth=2 origin +refs/heads/*:refs/remotes/origin/* +refs/pull/63808/merge:refs/remotes/pull/63808/merge
2019-08-22T13:39:07.0097563Z remote:                                                                                         
---
2019-08-22T13:39:41.0034854Z do so (now or later) by using -b with the checkout command again. Example:
2019-08-22T13:39:41.0034890Z 
2019-08-22T13:39:41.0035127Z   git checkout -b <new-branch-name>
2019-08-22T13:39:41.0035158Z 
2019-08-22T13:39:41.0035245Z HEAD is now at 65db25c40 Merge eae5d77995488ffc316a7ff8344c4eaa81d67932 into 201e52e5fe73ccf3dd22946b1216ad8d64f8c2ba
2019-08-22T13:39:41.0192512Z ##[section]Starting: Collect CPU-usage statistics in the background
2019-08-22T13:39:41.0195479Z ==============================================================================
2019-08-22T13:39:41.0195561Z Task         : Bash
2019-08-22T13:39:41.0195613Z Description  : Run a Bash script on macOS, Linux, or Windows
---
2019-08-22T14:42:28.4819056Z .................................................................................................... 1500/8948
2019-08-22T14:42:34.1793207Z .................................................................................................... 1600/8948
2019-08-22T14:42:47.1441449Z ...........................................i...............i........................................ 1700/8948
2019-08-22T14:42:55.4557827Z .................................................................................................... 1800/8948
2019-08-22T14:43:09.8402949Z ...................................iiiii............................................................ 1900/8948
2019-08-22T14:43:20.6276091Z .................................................................................................... 2100/8948
2019-08-22T14:43:23.2873547Z .................................................................................................... 2200/8948
2019-08-22T14:43:27.8275675Z .................................................................................................... 2300/8948
2019-08-22T14:43:35.0579010Z .................................................................................................... 2400/8948
---
2019-08-22T14:46:36.0912860Z .......................i...............i............................................................ 4700/8948
2019-08-22T14:46:48.0159650Z .................................................................................................... 4800/8948
2019-08-22T14:46:54.1907497Z .................................................................................................... 4900/8948
2019-08-22T14:47:05.5076781Z .................................................................................................... 5000/8948
2019-08-22T14:47:10.9073860Z ....ii.ii........................................................................................... 5100/8948
2019-08-22T14:47:25.7896846Z .................................................................................................... 5300/8948
2019-08-22T14:47:32.6521402Z ............................................................i....................................... 5400/8948
2019-08-22T14:47:39.8004788Z .................................................................................................... 5500/8948
2019-08-22T14:47:47.8923504Z .................................................................................................... 5600/8948
2019-08-22T14:47:47.8923504Z .................................................................................................... 5600/8948
2019-08-22T14:47:58.7223242Z .....................................................ii...i..ii...........i......................... 5700/8948
2019-08-22T14:48:19.8401984Z .................................................................................................... 5900/8948
2019-08-22T14:48:25.0157232Z .................................................................................................... 6000/8948
2019-08-22T14:48:25.0157232Z .................................................................................................... 6000/8948
2019-08-22T14:48:32.6050161Z ......................................................i..ii......................................... 6100/8948
2019-08-22T14:49:00.0285050Z .................................................................................................... 6300/8948
2019-08-22T14:49:02.2692747Z i................................................................................................... 6400/8948
2019-08-22T14:49:04.5152225Z ........................................................................i........................... 6500/8948
2019-08-22T14:49:07.6510096Z .................................................................................................... 6600/8948
---
2019-08-22T14:53:52.0706498Z  finished in 21.339
2019-08-22T14:53:52.0889830Z Check compiletest suite=codegen mode=codegen (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2019-08-22T14:53:52.2598676Z 
2019-08-22T14:53:52.2599387Z running 148 tests
2019-08-22T14:53:55.5533568Z i....iii.......iii.iiii....i............................i..i..................i....i.........ii.i.i. 100/148
2019-08-22T14:53:57.5639709Z .iiii..............i.........iii.i......ii......
2019-08-22T14:53:57.5640425Z 
2019-08-22T14:53:57.5643970Z  finished in 5.475
2019-08-22T14:53:57.5852287Z Check compiletest suite=codegen-units mode=codegen-units (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2019-08-22T14:53:57.7559491Z 
---
2019-08-22T14:53:59.8336880Z  finished in 2.248
2019-08-22T14:53:59.8544735Z Check compiletest suite=assembly mode=assembly (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2019-08-22T14:54:00.0108712Z 
2019-08-22T14:54:00.0109770Z running 9 tests
2019-08-22T14:54:00.0111159Z iiiiiiiii
2019-08-22T14:54:00.0111597Z 
2019-08-22T14:54:00.0114391Z  finished in 0.157
2019-08-22T14:54:00.0314392Z Check compiletest suite=incremental mode=incremental (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2019-08-22T14:54:00.1915828Z 
---
2019-08-22T14:54:18.3703065Z  finished in 18.338
2019-08-22T14:54:18.3898020Z Check compiletest suite=debuginfo mode=debuginfo-gdb+lldb (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2019-08-22T14:54:18.5643241Z 
2019-08-22T14:54:18.5644215Z running 122 tests
2019-08-22T14:54:43.4223251Z .iiiii...i.....i..i...i..i.i.i..i.ii..i.i.....i..i....i..........iiii..........i...ii...i.......ii.i 100/122
2019-08-22T14:54:48.1210878Z .i.i......iii.i.....ii
2019-08-22T14:54:48.1211761Z 
2019-08-22T14:54:48.1216508Z  finished in 29.731
2019-08-22T14:54:48.1257402Z Uplifting stage1 rustc (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2019-08-22T14:54:48.1258635Z Copying stage2 rustc from stage1 (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu / x86_64-unknown-linux-gnu)
---
2019-08-22T15:09:13.7498972Z 
2019-08-22T15:09:13.7500406Z    Doc-tests core
2019-08-22T15:09:18.9045735Z 
2019-08-22T15:09:18.9046757Z running 2380 tests
2019-08-22T15:09:31.9337142Z ......iiiii......................................................................................... 100/2380
2019-08-22T15:09:44.8966318Z .........................................................................ii......................... 200/2380
2019-08-22T15:10:14.9977494Z .................................................................................................... 400/2380
2019-08-22T15:10:14.9977494Z .................................................................................................... 400/2380
2019-08-22T15:10:26.5852642Z ..............................i..i.................iiii............................................. 500/2380
2019-08-22T15:10:51.2425098Z .................................................................................................... 700/2380
2019-08-22T15:11:03.5159655Z .................................................................................................... 800/2380
2019-08-22T15:11:15.7013488Z .................................................................................................... 900/2380
2019-08-22T15:11:28.0169202Z .................................................................................................... 1000/2380
---
2019-08-22T15:16:57.9493227Z 
2019-08-22T15:16:57.9498155Z running 991 tests
2019-08-22T15:17:22.2493505Z i................................................................................................... 100/991
2019-08-22T15:17:35.8490150Z .................................................................................................... 200/991
2019-08-22T15:17:44.8917850Z .................i.ii.....i......i...i......i.....................F................................. 300/991
2019-08-22T15:17:50.0204151Z .................................................................................................... 400/991
2019-08-22T15:17:58.4838559Z ..................................i..i.................................ii........................... 500/991
2019-08-22T15:18:13.6405339Z .................................................................................................... 700/991
2019-08-22T15:18:13.6405339Z .................................................................................................... 700/991
2019-08-22T15:18:22.2958007Z .................iiii............................................................................... 800/991
2019-08-22T15:18:38.1403812Z .................................................................................................... 900/991
2019-08-22T15:18:45.5847610Z .......................................iiii................................................
2019-08-22T15:18:45.5848516Z 
2019-08-22T15:18:45.5849465Z ---- ffi/os_str.rs - ffi::os_str::OsString::with_capacity (line 191) stdout ----
2019-08-22T15:18:45.5849465Z ---- ffi/os_str.rs - ffi::os_str::OsString::with_capacity (line 191) stdout ----
2019-08-22T15:18:45.5849686Z error[E0596]: cannot borrow `os_string` as mutable, as it is not declared as mutable
2019-08-22T15:18:45.5850090Z   --> ffi/os_str.rs:198:1
2019-08-22T15:18:45.5850305Z    |
2019-08-22T15:18:45.5850447Z 6  | let os_string = OsString::with_capacity(10);
2019-08-22T15:18:45.5850875Z    |     --------- help: consider changing this to be mutable: `mut os_string`
2019-08-22T15:18:45.5851051Z ...
2019-08-22T15:18:45.5851439Z 10 | os_string.push("foo");
2019-08-22T15:18:45.5851607Z    | ^^^^^^^^^ cannot borrow as mutable
2019-08-22T15:18:45.5851860Z error: aborting due to previous error
2019-08-22T15:18:45.5851998Z 
2019-08-22T15:18:45.5852419Z For more information about this error, try `rustc --explain E0596`.
2019-08-22T15:18:45.5853184Z Couldn't compile the test.
---
2019-08-22T15:18:45.5854381Z 
2019-08-22T15:18:45.6030821Z error: test failed, to rerun pass '--doc'
2019-08-22T15:18:45.6050613Z 
2019-08-22T15:18:45.6051002Z 
2019-08-22T15:18:45.6051839Z command did not execute successfully: "/checkout/obj/build/x86_64-unknown-linux-gnu/stage0/bin/cargo" "test" "--target" "x86_64-unknown-linux-gnu" "-Zbinary-dep-depinfo" "-j" "2" "--release" "--locked" "--color" "always" "--features" "panic-unwind backtrace compiler-builtins-c" "--manifest-path" "/checkout/src/libstd/Cargo.toml" "-p" "std" "--" "--quiet"
2019-08-22T15:18:45.6052257Z 
2019-08-22T15:18:45.6052386Z 
2019-08-22T15:18:45.6062300Z failed to run: /checkout/obj/build/bootstrap/debug/bootstrap test
2019-08-22T15:18:45.6062791Z Build completed unsuccessfully in 1:32:19
2019-08-22T15:18:45.6062791Z Build completed unsuccessfully in 1:32:19
2019-08-22T15:18:45.6123959Z == clock drift check ==
2019-08-22T15:18:45.6141730Z   local time: Thu Aug 22 15:18:45 UTC 2019
2019-08-22T15:18:45.7633422Z   network time: Thu, 22 Aug 2019 15:18:45 GMT
2019-08-22T15:18:45.7639044Z == end clock drift check ==
2019-08-22T15:18:46.2439877Z ##[error]Bash exited with code '1'.
2019-08-22T15:18:46.2503041Z ##[section]Starting: Checkout
2019-08-22T15:18:46.2505525Z ==============================================================================
2019-08-22T15:18:46.2505608Z Task         : Get sources
2019-08-22T15:18:46.2505661Z Description  : Get sources from a repository. Supports Git, TfsVC, and SVN repositories.

I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact @TimNN. (Feature Requests)

@tomasz-rozanski
Copy link
Contributor Author

tomasz-rozanski commented Aug 22, 2019 •
edited
Loading

The job x86_64-gnu-llvm-6.0 of your PR failed (raw log). Through arcane magic we have determined that the following fragments from the build log may contain information about the problem.

Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact @TimNN. (Feature Requests)

I found the problem in 7e13679. Pushing a fix.

@KodrAus
Copy link
Contributor

KodrAus commented Aug 22, 2019

Thanks @Rosto75!

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Aug 22, 2019

📌 Commit d9f3258 has been approved by KodrAus

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 22, 2019
@bors
Copy link
Collaborator

bors commented Aug 23, 2019

⌛ Testing commit d9f3258 with merge 0507d49...

bors added a commit that referenced this pull request Aug 23, 2019
@bors
Auto merge of #63808 - Rosto75:master, r=KodrAus
0507d49 
A bunch of minor documentation tweaks and fixes.
@bors
Copy link
Collaborator

bors commented Aug 23, 2019

☀️ Test successful - checks-azure
Approved by: KodrAus
Pushing 0507d49 to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Aug 23, 2019
@bors bors merged commit d9f3258 into rust-lang:master Aug 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@KodrAus KodrAus

Labels
merged-by-bors This PR was explicitly merged by bors. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@tomasz-rozanski @rust-highfive @KodrAus @bors