about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMazdak Farrokhzad <twingoow@gmail.com>2020-04-10 12:48:51 +0200
committerGitHub <noreply@github.com>2020-04-10 12:48:51 +0200
commit6f118f2149bd4a359d9983055968122cc636b8a9 (patch)
tree4c300d0010c1f81aa83f0b79cf9ecdcec445215a
parent490bdc0e57a160fdcf07e70b8bb8d49085aa2640 (diff)
parentd6d0799abf99d54278ff45f188d6c5d6dcd2f718 (diff)
downloadrust-6f118f2149bd4a359d9983055968122cc636b8a9.tar.gz
rust-6f118f2149bd4a359d9983055968122cc636b8a9.zip
Rollup merge of #70969 - ehuss:json-filename-macros, r=eddyb
Fix JSON file_name documentation for macros.

JSON `file_name` paths were changed in #66364 for macros to point to actual source files instead of using `<MACRONAME macros>`.

Closes #70396
-rw-r--r--src/doc/rustc/src/json.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/doc/rustc/src/json.md b/src/doc/rustc/src/json.md
index c46380f1505..5dee603142d 100644
--- a/src/doc/rustc/src/json.md
+++ b/src/doc/rustc/src/json.md
@@ -59,8 +59,11 @@ Diagnostics have the following format:
     "spans": [
         {
             /* The file where the span is located.
-               For spans located within a macro expansion, this will be the
-               name of the expanded macro in the format "<MACRONAME macros>".
+               Note that this path may not exist. For example, if the path
+               points to the standard library, and the rust src is not
+               available in the sysroot, then it may point to a non-existent
+               file. Beware that this may also point to the source of an
+               external crate.
             */
             "file_name": "lib.rs",
             /* The byte offset where the span starts (0-based, inclusive). */