Fixing broken references to char primitive methods in str module

[porkbrain]

The links in string module to methods in char module are broken for #method.escape_debug, #method.escape_default and #method.escape_unicode.

r? @steveklabnik

[rust-highfive]

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

[tspiteri]

This PR would break the links for the str methods instead, e.g. str::escape_debug. I think this is issue #32129.

[GuillaumeGomez]

Just like @tspiteri said, it seems to fix something as much as it breaks things...

[tspiteri]

I think the solution to this problem would have to be in rustdoc, but I don't know rustdoc enough to know how hard it would be. I think that for relative links in Deref methods, rustdoc could determine the relative path to the Deref::Target, and prepend that path to the relative link.

[rust-highfive]

The job x86_64-gnu-llvm-7 of your PR failed (pretty log, 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.

2020-03-03T11:11:37.2046606Z ========================== Starting Command Output ===========================
2020-03-03T11:11:37.2053856Z [command]/bin/bash --noprofile --norc /home/vsts/work/_temp/a940011d-5527-4cd2-a198-318b5710a8ee.sh
2020-03-03T11:11:37.2054446Z 
2020-03-03T11:11:37.2060601Z ##[section]Finishing: Disable git automatic line ending conversion
2020-03-03T11:11:37.2081973Z ##[section]Starting: Checkout rust-lang/rust@refs/pull/69669/merge to s
2020-03-03T11:11:37.2085910Z Task         : Get sources
2020-03-03T11:11:37.2086254Z Description  : Get sources from a repository. Supports Git, TfsVC, and SVN repositories.
2020-03-03T11:11:37.2086607Z Version      : 1.0.0
2020-03-03T11:11:37.2086837Z Author       : Microsoft
---
2020-03-03T11:11:38.4040229Z ##[command]git remote add origin https://github.com/rust-lang/rust
2020-03-03T11:11:38.4054759Z ##[command]git config gc.auto 0
2020-03-03T11:11:38.4068446Z ##[command]git config --get-all http.https://github.com/rust-lang/rust.extraheader
2020-03-03T11:11:38.4074583Z ##[command]git config --get-all http.proxy
2020-03-03T11:11:38.4091534Z ##[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/69669/merge:refs/remotes/pull/69669/merge
---
2020-03-03T12:12:33.6497956Z .................................................................................................... 1700/9725
2020-03-03T12:12:37.9061459Z .................................................................................................... 1800/9725
2020-03-03T12:12:49.3192027Z ......................................................i............................................. 1900/9725
2020-03-03T12:12:56.8966391Z .................................................................................................... 2000/9725
2020-03-03T12:13:10.1736174Z ............................................iiiii................................................... 2100/9725
2020-03-03T12:13:19.7466276Z .................................................................................................... 2300/9725
2020-03-03T12:13:21.9602310Z .................................................................................................... 2400/9725
2020-03-03T12:13:25.4625572Z .................................................................................................... 2500/9725
2020-03-03T12:13:46.1233104Z .................................................................................................... 2600/9725
---
2020-03-03T12:16:21.7767958Z .....i...............i.............................................................................. 5000/9725
2020-03-03T12:16:31.1219426Z .................................................................................................... 5100/9725
2020-03-03T12:16:35.6700557Z ................................................i................................................... 5200/9725
2020-03-03T12:16:43.8085985Z .................................................................................................... 5300/9725
2020-03-03T12:16:50.7786544Z ...........................ii.ii........i...i....................................................... 5400/9725
2020-03-03T12:16:58.4366405Z .................................................................................................... 5600/9725
2020-03-03T12:17:07.4793885Z .................................................................................................... 5700/9725
2020-03-03T12:17:14.2223090Z ..................i................................................................................. 5800/9725
2020-03-03T12:17:19.6171787Z .................................................................................................... 5900/9725
2020-03-03T12:17:19.6171787Z .................................................................................................... 5900/9725
2020-03-03T12:17:29.8061432Z .................................................................................................... 6000/9725
2020-03-03T12:17:40.2539451Z ..........ii...i..ii...........i.................................................................... 6100/9725
2020-03-03T12:17:55.8842427Z .................................................................................................... 6300/9725
2020-03-03T12:18:01.9787715Z .................................................................................................... 6400/9725
2020-03-03T12:18:01.9787715Z .................................................................................................... 6400/9725
2020-03-03T12:18:18.1259137Z .........................................i..ii...................................................... 6500/9725
2020-03-03T12:18:38.3334387Z .................................................................................................... 6700/9725
2020-03-03T12:18:40.2094763Z .................................i.................................................................. 6800/9725
2020-03-03T12:18:42.1208607Z .................................................................................................... 6900/9725
2020-03-03T12:18:44.3769197Z ...............................................................i.................................... 7000/9725
---
2020-03-03T12:20:21.7184902Z .................................................................................................... 7700/9725
2020-03-03T12:20:26.9358323Z .................................................................................................... 7800/9725
2020-03-03T12:20:32.0778118Z .................................................................................................... 7900/9725
2020-03-03T12:20:40.1677562Z .........i.......................................................................................... 8000/9725
2020-03-03T12:20:48.7728733Z ..........................................................iiiiiii.i................................. 8100/9725
2020-03-03T12:20:56.9916585Z ...................................................................................................i 8200/9725
2020-03-03T12:21:08.1535066Z .................................................................................................... 8400/9725
2020-03-03T12:21:22.7925220Z .................................................................................................... 8500/9725
2020-03-03T12:21:31.1549423Z .................................................................................................... 8600/9725
2020-03-03T12:21:37.9613298Z .................................................................................................... 8700/9725
---
2020-03-03T12:23:47.7675477Z  finished in 7.095
2020-03-03T12:23:47.7938760Z Check compiletest suite=codegen mode=codegen (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2020-03-03T12:23:47.9781489Z 
2020-03-03T12:23:47.9781837Z running 178 tests
2020-03-03T12:23:50.7555383Z iiii......i...........ii..iiii...i....i...........i............i..i..................i....i......... 100/178
2020-03-03T12:23:52.8944282Z ...i.i.i...iii..iiiiiiiiiiiiiiii.......................iii............ii......
2020-03-03T12:23:52.8948076Z 
2020-03-03T12:23:52.8952475Z  finished in 5.101
2020-03-03T12:23:52.9134687Z Check compiletest suite=codegen-units mode=codegen-units (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2020-03-03T12:23:53.0644291Z 
---
2020-03-03T12:23:54.8920456Z  finished in 1.978
2020-03-03T12:23:54.9143721Z Check compiletest suite=assembly mode=assembly (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2020-03-03T12:23:55.0912530Z 
2020-03-03T12:23:55.0914005Z running 9 tests
2020-03-03T12:23:55.0915581Z iiiiiiiii
2020-03-03T12:23:55.0917842Z 
2020-03-03T12:23:55.0928130Z  finished in 0.178
2020-03-03T12:23:55.1130700Z Check compiletest suite=incremental mode=incremental (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2020-03-03T12:23:55.2804191Z 
---
2020-03-03T12:24:14.2301199Z  finished in 19.118
2020-03-03T12:24:14.2520812Z Check compiletest suite=debuginfo mode=debuginfo (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2020-03-03T12:24:14.4343201Z 
2020-03-03T12:24:14.4343501Z running 116 tests
2020-03-03T12:24:27.1889552Z iiiii..i.....i..i...i..i.i.i..i..i..ii....i.i....ii..........iiii..........i.....i..i.......ii.i.ii. 100/116
2020-03-03T12:24:28.9730417Z ....iiii.....ii.
2020-03-03T12:24:28.9734237Z 
2020-03-03T12:24:28.9738007Z  finished in 14.722
2020-03-03T12:24:28.9745517Z Uplifting stage1 rustc (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
2020-03-03T12:24:28.9746177Z Copying stage2 rustc from stage1 (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu / x86_64-unknown-linux-gnu)
---
2020-03-03T12:37:32.0603676Z 
2020-03-03T12:37:32.0605680Z    Doc-tests core
2020-03-03T12:37:36.6156957Z 
2020-03-03T12:37:36.6157670Z running 2480 tests
2020-03-03T12:37:45.3739645Z ......iiiii......................................................................................... 100/2480
2020-03-03T12:37:53.8957489Z ....................................................................................ii.............. 200/2480
2020-03-03T12:38:13.5935078Z ...................i................................................................................ 400/2480
2020-03-03T12:38:13.5935078Z ...................i................................................................................ 400/2480
2020-03-03T12:38:22.7934241Z ........................................................................i..i..................iiii.. 500/2480
2020-03-03T12:38:38.1901935Z .................................................................................................... 700/2480
2020-03-03T12:38:46.3534793Z .................................................................................................... 800/2480
2020-03-03T12:38:54.5146322Z .................................................................................................... 900/2480
2020-03-03T12:39:02.2863514Z .................................................................................................... 1000/2480
---
2020-03-03T12:42:29.8433483Z 
2020-03-03T12:42:29.8434658Z running 1010 tests
2020-03-03T12:42:46.9881541Z i................................................................................................... 100/1010
2020-03-03T12:42:56.4928135Z .................................................................................................... 200/1010
2020-03-03T12:43:03.2294978Z ..................iii......i......i...i......i...................................................... 300/1010
2020-03-03T12:43:08.0015672Z .................................................................................................... 400/1010
2020-03-03T12:43:14.3826407Z ............................................i..i......................................ii............ 500/1010
2020-03-03T12:43:26.2317316Z .................................................................................................... 700/1010
2020-03-03T12:43:26.2317316Z .................................................................................................... 700/1010
2020-03-03T12:43:32.7644004Z ....................................iiii............................................................ 800/1010
2020-03-03T12:43:46.1435516Z .................................................................................................... 900/1010
2020-03-03T12:43:52.5157455Z ..........................................................iiii...................................... 1000/1010
2020-03-03T12:43:52.9545938Z test result: ok. 990 passed; 0 failed; 20 ignored; 0 measured; 0 filtered out
2020-03-03T12:43:52.9546155Z 
2020-03-03T12:43:52.9672564Z  finished in 160.235
2020-03-03T12:43:52.9683031Z Testing term stage1 (x86_64-unknown-linux-gnu -> x86_64-unknown-linux-gnu)
---
2020-03-03T13:02:10.3787172Z Rustbook (x86_64-unknown-linux-gnu) - edition-guide
2020-03-03T13:02:10.7454587Z Building stage0 tool linkchecker (x86_64-unknown-linux-gnu)
2020-03-03T13:02:10.9176216Z    Compiling linkchecker v0.1.0 (/checkout/src/tools/linkchecker)
2020-03-03T13:02:12.4672434Z     Finished release [optimized] target(s) in 1.71s
2020-03-03T13:02:15.2185503Z std/primitive.str.html:1205: broken link - /checkout/obj/build/x86_64-unknown-linux-gnu/std/primitive.char.html
2020-03-03T13:02:15.2186501Z std/primitive.str.html:1228: broken link - /checkout/obj/build/x86_64-unknown-linux-gnu/std/primitive.char.html
2020-03-03T13:02:15.2187444Z std/primitive.str.html:1249: broken link - /checkout/obj/build/x86_64-unknown-linux-gnu/std/primitive.char.html
2020-03-03T13:02:19.8092298Z thread 'main' panicked at 'found some broken links', src/tools/linkchecker/main.rs:43:9
2020-03-03T13:02:19.8123865Z 
2020-03-03T13:02:19.8124228Z 
2020-03-03T13:02:19.8125179Z command did not execute successfully: "/checkout/obj/build/x86_64-unknown-linux-gnu/stage0-tools-bin/linkchecker" "/checkout/obj/build/x86_64-unknown-linux-gnu/doc"
2020-03-03T13:02:19.8126040Z expected success, got: exit code: 101
---
2020-03-03T13:02:20.4941708Z   local time: Tue Mar  3 13:02:19 UTC 2020
2020-03-03T13:02:20.5000046Z   network time: Tue, 03 Mar 2020 13:02:20 GMT
2020-03-03T13:02:20.5000868Z == end clock drift check ==
2020-03-03T13:02:21.7629090Z 
2020-03-03T13:02:21.7710947Z ##[error]Bash exited with code '1'.
2020-03-03T13:02:21.7734516Z ##[section]Finishing: Run build
2020-03-03T13:02:21.7794889Z ##[section]Starting: Checkout rust-lang/rust@refs/pull/69669/merge to s
2020-03-03T13:02:21.7801113Z Task         : Get sources
2020-03-03T13:02:21.7801507Z Description  : Get sources from a repository. Supports Git, TfsVC, and SVN repositories.
2020-03-03T13:02:21.7801851Z Version      : 1.0.0
2020-03-03T13:02:21.7802092Z Author       : Microsoft
2020-03-03T13:02:21.7802092Z Author       : Microsoft
2020-03-03T13:02:21.7802495Z Help         : [More Information](https://go.microsoft.com/fwlink/?LinkId=798199)
2020-03-03T13:02:21.7802937Z ==============================================================================
2020-03-03T13:02:22.1376175Z Cleaning any cached credential from repository: rust-lang/rust (GitHub)
2020-03-03T13:02:22.1426870Z ##[section]Finishing: Checkout rust-lang/rust@refs/pull/69669/merge to s
2020-03-03T13:02:22.1525125Z Cleaning up task key
2020-03-03T13:02:22.1526718Z Start cleaning up orphan processes.
2020-03-03T13:02:22.1726063Z Terminate orphan process: pid (4326) (python)
2020-03-03T13:02:22.1974174Z ##[section]Finishing: Finalize Job

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)

[steveklabnik]

Yes, this is #32129. Thank you and sorry :(

[porkbrain]

I see, I am not familiar with how the references are generated. Thanks for catching this.

[GuillaumeGomez]

Using the intra-doc links would work I guess.

[tspiteri]

@GuillaumeGomez I had already tried that and failed in #58596, that's why this PR caught me attention. But I got blocked on #58699 and couldn't work around it as suggested in #58699 (comment), though I do not remember the details why; maybe I missed something.

[GuillaumeGomez]

I can take a look. intra-doc links might be a bit "lazy" sometimes...