From 683131559c25322b8f0a1c6ee052914e5aec143b Mon Sep 17 00:00:00 2001
From: hjk <hjk@theqtcompany.com>
Date: Wed, 6 Apr 2016 11:43:18 +0200
Subject: [PATCH] ProjectExplorer: Add a comment regarding the use of
 EnvironmentAspect

Also, make EnvironmentAspect::environment() non-virtual, it should
always be equal to base + user changes.

Change-Id: I0259894d5ac3121a840631e37baebdcfa86b198b
Reviewed-by: Tobias Hunger <tobias.hunger@theqtcompany.com>
---
 src/plugins/projectexplorer/environmentaspect.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/plugins/projectexplorer/environmentaspect.h b/src/plugins/projectexplorer/environmentaspect.h
index 9fb946ef4b2..20c59f84c13 100644
--- a/src/plugins/projectexplorer/environmentaspect.h
+++ b/src/plugins/projectexplorer/environmentaspect.h
@@ -53,8 +53,10 @@ public:
     QList<Utils::EnvironmentItem> userEnvironmentChanges() const { return m_changes; }
     void setUserEnvironmentChanges(const QList<Utils::EnvironmentItem> &diff);
 
+    // The environment the user chose as base for his modifications.
     virtual Utils::Environment baseEnvironment() const = 0;
-    virtual Utils::Environment environment() const;
+    // The environment including the user's modifications.
+    Utils::Environment environment() const;
 
 signals:
     void baseEnvironmentChanged();