about summary refs log tree commit diff
path: root/src/doc/rustc
diff options
context:
space:
mode:
authorEric Huss <eric@huss.org>2020-04-09 18:54:53 -0700
committerEric Huss <eric@huss.org>2020-04-09 18:54:53 -0700
commitd6d0799abf99d54278ff45f188d6c5d6dcd2f718 (patch)
tree7353e7f3ef2e1c45865c05cf39bb0642eb107af0 /src/doc/rustc
parent93dc97a85381cc52eb872d27e50e4d518926a27c (diff)
downloadrust-d6d0799abf99d54278ff45f188d6c5d6dcd2f718.tar.gz
rust-d6d0799abf99d54278ff45f188d6c5d6dcd2f718.zip
Fix JSON file_name documentation for macros.
Diffstat (limited to 'src/doc/rustc')
-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). */