Changes between Version 10 and Version 11 of Commentary/SourceTree/Includes

Timestamp:

Dec 11, 2012 4:57:39 PM (7 years ago)

Author:

simonmar

Comment:

use source: links

Commentary/SourceTree/Includes

@@ -13 +13 @@
 relatively stable:
 
- [http://darcs.haskell.org/ghc/includes/HsFFI.h HsFFI.h]::
+ [source:includes/HsFFI.h HsFFI.h]::
   The external FFI api, as required by the FFI spec
 
- [http://darcs.haskell.org/ghc/includes/RtsAPI.h RtsAPI.h]::
+ [source:includes/RtsAPI.h RtsAPI.h]::
   The API for calling into the RTS.  Used by the implementation
   of `foreign export` calls, but may also be used by external
   clients.
 
- [http://darcs.haskell.org/ghc/includes/Rts.h Rts.h]::
+ [source:includes/Rts.h Rts.h]::
   This header file defines everything that is visible
   externally to the RTS.  It includes `Stg.h` and everything
@@ -30 +30 @@
 The canonical definition of certain structures are in C header files.
 For example, the layout of closures and info tables are defined in the
-headers [http://darcs.haskell.org/ghc/includes/rts/storage/Closures.h Closures.h] and
-[http://darcs.haskell.org/ghc/includes/rts/storage/InfoTables.h InfoTables.h] respectivesly.  How do we get the information about the
+headers [source:includes/rts/storage/Closures.h Closures.h] and
+[source:includes/rts/storage/InfoTables.h InfoTables.h] respectivesly.  How do we get the information about the
 layout of these structures to the parts of the system that are not
 written in C, such as the compiler itself, or the C-- code in the RTS?
@@ -51 +51 @@
 functions from `.hc` files are given types at the call site.
 
- [http://darcs.haskell.org/ghc/includes/Stg.h Stg.h]::
+ [source:includes/Stg.h Stg.h]::
   The top of the hierarchy is `Stg.h`, which includes everything
   required by `.hc` code.  Most files `#included` by `Stg.h` are in the
   `stg` subdirectory.
 
- [http://darcs.haskell.org/ghc/includes/ghcconfig.h ghcconfig.h]::
+ [source:includes/ghcconfig.h ghcconfig.h]::
   Configuration info derived by the `configure` script.
- [http://darcs.haskell.org/ghc/includes/MachDeps.h MachDeps.h]::
+ [source:includes/MachDeps.h MachDeps.h]::
   Sizes of various basic types (should be in the `stg` subdirectory,
   but left here for backwards-compatibility reasons).
- [http://darcs.haskell.org/ghc/includes/stg/DLL.h stg/DLL.h]::
+ [source:includes/stg/DLL.h stg/DLL.h]::
   Stuff related to Windows DLLs.
- [http://darcs.haskell.org/ghc/includes/stg/MachRegs.h stg/MachRegs.h]::
+ [source:includes/stg/MachRegs.h stg/MachRegs.h]::
   Global register assignments for this processor.
- [http://darcs.haskell.org/ghc/includes/stg/MiscClosures.h stg/MiscClosures.h]::
+ [source:includes/stg/MiscClosures.h stg/MiscClosures.h]::
   Declarations for closures & info tables built-in to the RTS
- [http://darcs.haskell.org/ghc/includes/stg/Regs.h stg/Regs.h]::
+ [source:includes/stg/Regs.h stg/Regs.h]::
   "registers" in the virtual machine.
- [http://darcs.haskell.org/ghc/includes/stg/SMP.h stg/SMP.h]::
+ [source:includes/stg/SMP.h stg/SMP.h]::
   Atomic memory operations for SMP support
- [http://darcs.haskell.org/ghc/includes/stg/Ticky.h stg/Ticky.h]::
+ [source:includes/stg/Ticky.h stg/Ticky.h]::
   Declarations for ticky-ticky counters
- [http://darcs.haskell.org/ghc/includes/stg/Types.h stg/Types.h]::
+ [source:includes/stg/Types.h stg/Types.h]::
   Basic types specific to the virtual machine (eg. `StgWord`).
 
 == The RTS external APIs ==
 
-The header [http://darcs.haskell.org/ghc/includes/Rts.h Rts.h]
+The header [source:includes/Rts.h Rts.h]
 includes all the headers below the `rts` subdirectory, which together
 define the RTS external API.  Virtually all RTS code `#includes`
@@ -85 +85 @@
 The rts header files are divided into a few directories:
 
- * [http://darcs.haskell.org/ghc/includes/rts includes/rts]: Most of
+ * [source:includes/rts includes/rts]: Most of
    the external RTS APIs, in separate header files per-subsystem
 
- * [http://darcs.haskell.org/ghc/includes/rts/storage includes/rts/storage]: Definitions of the layout of heap and stack
+ * [source:includes/rts/storage includes/rts/storage]: Definitions of the layout of heap and stack
    objects, info tables, structures that define memory areas managed
    by the GC, and memory management APIs.
 
- * [http://darcs.haskell.org/ghc/includes/rts/prof includes/rts/prof]:
+ * [source:includes/rts/prof includes/rts/prof]:
    Interfaces and definitions for profiling.
 
 == Included into C-- (`.cmm`) code ==
 
- [http://darcs.haskell.org/ghc/includes/Cmm.h Cmm.h]::
+ [source:includes/Cmm.h Cmm.h]::
   included into `.cmm` source only; provides useful macros for writing
   low-level C-- code for GHC.