From 19fddc019f2349e183b9eac231c0ce9b261b39f5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9my=20Rakic?= <remy.rakic+github@gmail.com>
Date: Mon, 14 Jun 2021 18:57:06 +0200
Subject: [PATCH] Improve documentation on
 `UndefinedBehaviorInfo::ValidationFailure`

---
 compiler/rustc_middle/src/mir/interpret/error.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/compiler/rustc_middle/src/mir/interpret/error.rs b/compiler/rustc_middle/src/mir/interpret/error.rs
index b01eb28e946..7941800c7fa 100644
--- a/compiler/rustc_middle/src/mir/interpret/error.rs
+++ b/compiler/rustc_middle/src/mir/interpret/error.rs
@@ -257,6 +257,8 @@ pub enum UndefinedBehaviorInfo<'tcx> {
     /// Should only be thrown by `validity.rs` and always point out which part of the value
     /// is the problem.
     ValidationFailure {
+        /// The "path" to the value in question, e.g. `.0[5].field` for a struct
+        /// field in the 6th element of an array that is the first element of a tuple.
         path: Option<String>,
         msg: String,
     },