[lmi-commits] [lmi] master 317fcf8 2/5: Document the PCH header selection rule

[Greg Chicares]

branch: master
commit 317fcf88fd1b45094586f6c3a44c5ea5c8f2b520
Author: Gregory W. Chicares <address@hidden>
Commit: Gregory W. Chicares <address@hidden>

    Document the PCH header selection rule
    
    See:
      http://lists.nongnu.org/archive/html/lmi/2017-03/msg00088.html
    Cf. the c2d02f6f4a6fdf33b2329c7140a4dd06904de281 commit message.
---
 pchfile.hpp    | 4 ++--
 pchfile_wx.hpp | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/pchfile.hpp b/pchfile.hpp
index 6f12df5..b06c9d2 100644
--- a/pchfile.hpp
+++ b/pchfile.hpp
@@ -21,8 +21,8 @@
 
 // In every '.cpp' file that is expected to benefit from precompiled
 // headers, include exactly one of these PCH headers:
-//   pchfile.hpp
-//   pchfile_wx.hpp
+//   pchfile.hpp    // For TUs included in a non-wx-dependent library
+//   pchfile_wx.hpp // For TUs included in a     wx-dependent library
 // Include it before anything else except comments and whitespace.
 // Never include any PCH header in any other file.
 
diff --git a/pchfile_wx.hpp b/pchfile_wx.hpp
index 1aa210b..40d166d 100644
--- a/pchfile_wx.hpp
+++ b/pchfile_wx.hpp
@@ -21,8 +21,8 @@
 
 // In every '.cpp' file that is expected to benefit from precompiled
 // headers, include exactly one of these PCH headers:
-//   pchfile.hpp
-//   pchfile_wx.hpp
+//   pchfile.hpp    // For TUs included in a non-wx-dependent library
+//   pchfile_wx.hpp // For TUs included in a     wx-dependent library
 // Include it before anything else except comments and whitespace.
 // Never include any PCH header in any other file.