Private project's header files should be #include'd using the file na…

…me when in the same folder. Private headers may live in sub-directories, but they should never be included using "." or ".." as part of a relative paths. For example: #include "privateUtils.h" #include "pvt/helperFunctions.h"
Autodesk · Mar 28, 2020 · fb592d1 · fb592d1
1 parent c05eb7f
commit fb592d1
Show file tree

Hide file tree

Showing 12 changed files with 22 additions and 28 deletions.
diff --git a/lib/mayaUsd/ufe/Global.cpp b/lib/mayaUsd/ufe/Global.cpp
@@ -16,7 +16,8 @@
 
 #include <mayaUsd/ufe/Global.h>
 
-#include <mayaUsd/ufe/private/InPathChange.h>
+#include "private/InPathChange.h"
+
 #include <mayaUsd/ufe/ProxyShapeHandler.h>
 #include <mayaUsd/ufe/ProxyShapeHierarchyHandler.h>
 #include <mayaUsd/ufe/StagesSubject.h>

diff --git a/lib/mayaUsd/ufe/StagesSubject.cpp b/lib/mayaUsd/ufe/StagesSubject.cpp
@@ -16,7 +16,8 @@
 
 #include <mayaUsd/ufe/StagesSubject.h>
 
-#include <mayaUsd/ufe/private/InPathChange.h>
+#include "private/InPathChange.h"
+
 #include <mayaUsd/ufe/ProxyShapeHandler.h>
 #include <mayaUsd/ufe/UsdStageMap.h>
 #include <mayaUsd/ufe/Utils.h>

diff --git a/lib/mayaUsd/ufe/UsdHierarchy.cpp b/lib/mayaUsd/ufe/UsdHierarchy.cpp
@@ -19,8 +19,9 @@
 #include <cassert>
 #include <stdexcept>
 
-#include <mayaUsd/ufe/private/InPathChange.h>
-#include <mayaUsd/ufe/private/Utils.h>
+#include "private/InPathChange.h"
+#include "private/Utils.h"
+
 #include <mayaUsd/ufe/UsdUndoCreateGroupCommand.h>
 #include <mayaUsd/ufe/Utils.h>
 

diff --git a/lib/mayaUsd/ufe/UsdRotatePivotTranslateUndoableCommand.cpp b/lib/mayaUsd/ufe/UsdRotatePivotTranslateUndoableCommand.cpp
@@ -15,7 +15,7 @@
 //
 #include <mayaUsd/ufe/UsdRotatePivotTranslateUndoableCommand.h>
 
-#include <mayaUsd/ufe/private/Utils.h>
+#include "private/Utils.h"
 
 MAYAUSD_NS_DEF {
 namespace ufe {

diff --git a/lib/mayaUsd/ufe/UsdRotateUndoableCommand.cpp b/lib/mayaUsd/ufe/UsdRotateUndoableCommand.cpp
@@ -16,7 +16,7 @@
 
 #include <mayaUsd/ufe/UsdRotateUndoableCommand.h>
 
-#include <mayaUsd/ufe/private/Utils.h>
+#include "private/Utils.h"
 
 MAYAUSD_NS_DEF {
 namespace ufe {

diff --git a/lib/mayaUsd/ufe/UsdScaleUndoableCommand.cpp b/lib/mayaUsd/ufe/UsdScaleUndoableCommand.cpp
@@ -16,7 +16,8 @@
 
 #include <mayaUsd/ufe/UsdScaleUndoableCommand.h>
 
-#include <mayaUsd/ufe/private/Utils.h>
+#include "private/Utils.h"
+
 #include <mayaUsd/ufe/Utils.h>
 
 MAYAUSD_NS_DEF {

diff --git a/lib/mayaUsd/ufe/UsdTransform3d.cpp b/lib/mayaUsd/ufe/UsdTransform3d.cpp
@@ -15,7 +15,9 @@
 //
 
 #include <mayaUsd/ufe/UsdTransform3d.h>
-#include <mayaUsd/ufe/private/Utils.h>
+
+#include "private/Utils.h"
+
 #include <mayaUsd/ufe/UsdRotatePivotTranslateUndoableCommand.h>
 #include <mayaUsd/ufe/UsdRotateUndoableCommand.h>
 #include <mayaUsd/ufe/UsdScaleUndoableCommand.h>

diff --git a/lib/mayaUsd/ufe/UsdTranslateUndoableCommand.cpp b/lib/mayaUsd/ufe/UsdTranslateUndoableCommand.cpp
@@ -16,7 +16,8 @@
 
 #include <mayaUsd/ufe/UsdTranslateUndoableCommand.h>
 
-#include <mayaUsd/ufe/private/Utils.h>
+#include "private/Utils.h"
+
 #include <mayaUsd/ufe/Utils.h>
 
 MAYAUSD_NS_DEF {

diff --git a/lib/mayaUsd/ufe/UsdUndoRenameCommand.cpp b/lib/mayaUsd/ufe/UsdUndoRenameCommand.cpp
@@ -16,7 +16,8 @@
 
 #include <mayaUsd/ufe/UsdUndoRenameCommand.h>
 
-#include <mayaUsd/ufe/private/InPathChange.h>
+#include "private/InPathChange.h"
+
 #include <mayaUsd/ufe/Utils.h>
 
 #include <ufe/scene.h>

diff --git a/lib/mayaUsd/ufe/Utils.cpp b/lib/mayaUsd/ufe/Utils.cpp
@@ -15,8 +15,10 @@
 //
 
 #include <mayaUsd/ufe/Utils.h>
+
+#include "private/Utils.h"
+
 #include <mayaUsd/nodes/proxyShapeBase.h>
-#include <mayaUsd/ufe/private/Utils.h>
 #include <mayaUsd/ufe/ProxyShapeHandler.h>
 #include <mayaUsd/ufe/UsdStageMap.h>
 

diff --git a/lib/mayaUsd/ufe/private/CMakeLists.txt b/lib/mayaUsd/ufe/private/CMakeLists.txt
@@ -6,19 +6,3 @@ target_sources(${PROJECT_NAME}
         Utils.cpp
 )
 
-set(headers
-    Utils.h
-    InPathChange.h
-)
-
-# -----------------------------------------------------------------------------
-# promoted headers
-# -----------------------------------------------------------------------------
-mayaUsd_promoteHeaderList(HEADERS ${headers} SUBDIR ufe/private)
-
-# -----------------------------------------------------------------------------
-# install
-# -----------------------------------------------------------------------------
-install(FILES ${headers}
-    DESTINATION ${CMAKE_INSTALL_PREFIX}/include/${PROJECT_NAME}/ufe/private
-)
diff --git a/lib/mayaUsd/ufe/private/Utils.cpp b/lib/mayaUsd/ufe/private/Utils.cpp
@@ -14,7 +14,7 @@
 // limitations under the License.
 //
 
-#include <mayaUsd/ufe/private/Utils.h>
+#include "Utils.h"
 
 #include <string>
 #include <memory>