Remove redundant include of Rts.h in EventLogWriter.h
authorZejun Wu <watashi@fb.com>
Sat, 8 Dec 2018 04:21:00 +0000 (23:21 -0500)
committerBen Gamari <ben@smart-cactus.org>
Sat, 8 Dec 2018 04:21:07 +0000 (23:21 -0500)
`EventLogWriter.h` doesn't use anything from `Rts.h`, the include is
redundant. This include is ignored when we include

```
Rts.h -> RtsAPI.h -> rts/EventLogWriter.h -> Rts.h
```

but can can cause problem when we include `RtsApi.h` directly with
errors like

```
In file included from /usr/lib/ghc-8.6.2/include/RtsAPI.h:20:
In file included from
/usr/lib/ghc-8.6.2/include/rts/EventLogWriter.h:14:
In file included from /usr/lib/ghc-8.6.2/include/Rts.h:185:
/usr/lib/ghc-8.6.2/include/rts/storage/GC.h:187:29: error: unknown type
name 'Capability'
StgPtr  allocate          ( Capability *cap, W_ n );
```

Test Plan: ./validate

Reviewers: simonmar, bgamari, afarmer, erikd, alexbiehl

Reviewed By: bgamari, alexbiehl

Subscribers: rwbarton, carter

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

includes/rts/EventLogWriter.h

index 829b0f2..347ff5b 100644 (file)
@@ -4,6 +4,11 @@
  *
  * Support for fast binary event logging.
  *
+ * Do not #include this file directly: #include "Rts.h" instead.
+ *
+ * To understand the structure of the RTS headers, see the wiki:
+ *   http://ghc.haskell.org/trac/ghc/wiki/Commentary/SourceTree/Includes
+ *
  * ---------------------------------------------------------------------------*/
 
 #pragma once
@@ -11,8 +16,6 @@
 #include <stddef.h>
 #include <stdbool.h>
 
-#include "Rts.h"
-
 /*
  *  Abstraction for writing eventlog data.
  */