document addDependentFile uses contents, not mtime
authorGreg Weber <greg@gregweber.info>
Tue, 18 Nov 2014 01:15:51 +0000 (19:15 -0600)
committerAustin Seipp <austin@well-typed.com>
Tue, 18 Nov 2014 01:15:52 +0000 (19:15 -0600)
Reviewers: austin

Reviewed By: austin

Subscribers: thomie, carter

Differential Revision: https://phabricator.haskell.org/D481

GHC Trac Issues: #4900

libraries/template-haskell/Language/Haskell/TH/Syntax.hs

index ddbe3a9..48199a4 100644 (file)
@@ -377,9 +377,16 @@ runIO :: IO a -> Q a
 runIO m = Q (qRunIO m)
 
 -- | Record external files that runIO is using (dependent upon).
--- The compiler can then recognize that it should re-compile the file using this TH when the external file changes.
--- Note that ghc -M will still not know about these dependencies - it does not execute TH.
+-- The compiler can then recognize that it should re-compile the Haskell file
+-- when an external file changes.
+--
 -- Expects an absolute file path.
+--
+-- Notes:
+--
+--   * ghc -M does not know about these dependencies - it does not execute TH.
+--
+--   * The dependency is based on file content, not a modification time
 addDependentFile :: FilePath -> Q ()
 addDependentFile fp = Q (qAddDependentFile fp)