diff --git a/ChangeLog.md b/ChangeLog.md new file mode 100644 --- /dev/null +++ b/ChangeLog.md @@ -0,0 +1,4 @@ +## 1.3.0.1 + +* Modernized package by switching README to markdown, adding ChangeLog.md +* Updated links in rdtsc.cabal to point to Github diff --git a/LICENSE b/LICENSE --- a/LICENSE +++ b/LICENSE @@ -1,32 +1,29 @@ -Copyright (c) 2011-2012, Martin Grabmueller - +Copyright (c) 2011-2015, Martin Grabmüller All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above - copyright notice, this list of conditions and the following - disclaimer in the documentation and/or other materials provided - with the distribution. +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. - * Neither the name of Martin Grabmueller nor the names of other - contributors may be used to endorse or promote products derived - from this software without specific prior written permission. +* Neither the name of rdtsc nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /* diff --git a/README b/README deleted file mode 100644 --- a/README +++ /dev/null @@ -1,42 +0,0 @@ - -*-outline-*- -* README file for Rdtsc binding - -This small Cabal package provides a Haskell binding to the "rdtsc" -machine instruction on modern IA-32 processors. This instruction can -be used to read the number of cycles since processor startup and gives -very accurate timing information. - ---------------------------------------------------------------------------- -Note: this package contains the file cycle.h by Matteo Frigo, which -provides access to cycle counters on several architectures. The -license for this file is included in the file LICENSE in this package. ----------------------------------------------------------------------------- - -** Usage - -Use - - runghc Setup.hs configure - runghc Setup.hs build - runghc Setup.hs install - -for building and installing system-wide, or - - runghc Setup.hs configure --prefix=$HOME/haskell-modules - runghc Setup.hs build - runghc Setup.hs install --user - -for building and installing in directory $HOME/haskell-modules. - -Just import module "System.CPUTime.Rdtsc" into your Haskell file and use - - ghc --make FILENAME - -to compile your program. - -The "tests" directory contains a small test program for the module and -demonstrates its usage. There is also a C version for this test -program, to test the overheads of Haskell's FFI. - -Happy Haskell hacking, - Martin diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# rdtsc - Binding for the rdtsc machine instruction + +This small Cabal package provides a Haskell binding to the "rdtsc" +machine instruction on modern IA-32 processors. This instruction can +be used to read the number of cycles since processor startup and gives +very accurate timing information. + +---- + +Note: this package contains the file cycle.h by Matteo Frigo, which +provides access to cycle counters on several architectures. The +license for this file is included in the file LICENSE in this package. + +---- + +## Usage + +Use + + cabal install rdtsc + +for building and installing system-wide, or + + tar xzvf rdtsc-X.Y.Z.W.tar.gz + cd rdtsc-X.Y.Z.W + cabal sandbox init + cabal install + +for building and installing in a sandbox. + +Just import module "System.CPUTime.Rdtsc" into your Haskell file and use + + ghc --make FILENAME + +to compile your program. + +The "tests" directory contains a small test program for the module and +demonstrates its usage. There is also a C version for this test +program, to test the overheads of Haskell's FFI. + +Happy Haskell hacking, + Martin diff --git a/rdtsc.cabal b/rdtsc.cabal --- a/rdtsc.cabal +++ b/rdtsc.cabal @@ -1,5 +1,5 @@ Name: rdtsc -Version: 1.3.0.0 +Version: 1.3.0.1 Build-type: Simple Cabal-version: >= 1.6 @@ -25,20 +25,23 @@ Maintainer: martin@grabmueller.de -Homepage: http://code.haskell.org/rdtsc +Homepage: https://github.com/mgrabmueller/rdtsc +Bug-reports: https://github.com/mgrabmueller/rdtsc/issues Category: Foreign binding Stability: Experimental -extra-source-files: README +extra-source-files: + README.md + ChangeLog.md tests/Makefile tests/test_rdtsc.c tests/TestRdtsc.hs Source-repository head - type: darcs - location: http://code.haskell.org/rdtsc/ + type: git + location: https://github.com/mgrabmueller/rdtsc Library Exposed-Modules: diff --git a/tests/Makefile b/tests/Makefile --- a/tests/Makefile +++ b/tests/Makefile @@ -1,5 +1,5 @@ GHC=ghc -GHCFLAGS=-O -fglasgow-exts -i../.. +GHCFLAGS=-O -i../.. CC=gcc CFLAGS=-O2