Move clash-protocols to its own folder

clash-lang · Aug 16, 2024 · cc7f4f0 · cc7f4f0
1 parent 2baec88
commit cc7f4f0
Show file tree

Hide file tree

Showing 38 changed files with 35 additions and 14 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,5 +1,5 @@
-Copyright (c) 2020, Martijn Bastiaan
-              2020, QBayLogic B.V.
+Copyright (c) 2024, Martijn Bastiaan
+              2024, QBayLogic B.V.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

diff --git a/cabal.project b/cabal.project
@@ -1,5 +1,6 @@
 packages:
-  ./clash-protocols-base, .
+  ./clash-protocols-base
+  ./clash-protocols
 
 tests: True
 

diff --git a/clash-protocols/LICENSE b/clash-protocols/LICENSE
@@ -0,0 +1,23 @@
+Copyright (c) 2024, Martijn Bastiaan
+              2024, QBayLogic B.V.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. 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.
+
+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 OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/Setup.hs → clash-protocols/Setup.hs b/Setup.hs → clash-protocols/Setup.hs
diff --git a/clash-protocols.cabal → clash-protocols/clash-protocols.cabal b/clash-protocols.cabal → clash-protocols/clash-protocols.cabal
@@ -91,7 +91,6 @@ common common-options
 
   default-language: Haskell2010
   build-depends:
-    -- GHC >= 9.0
     base >= 4.15.0.0,
     Cabal,
 
@@ -135,6 +134,7 @@ library
     , tasty-hedgehog >= 1.2
 
   exposed-modules:
+    Protocols
     Protocols.Avalon.MemMap
     Protocols.Avalon.Stream
     Protocols.Axi4.Common
@@ -152,7 +152,6 @@ library
     Protocols.Wishbone
     Protocols.Wishbone.Standard
     Protocols.Wishbone.Standard.Hedgehog
-    Protocols
 
     -- 'testProperty' is broken upstream, it reports wrong test names
     -- TODO: test / upstream ^
@@ -179,13 +178,12 @@ test-suite unittests
     Tests.Protocols.Axi4
     Tests.Protocols.Plugin
     Tests.Protocols.Wishbone
-
     Util
+
   build-depends:
     clash-protocols-base,
     clash-protocols,
     clash-prelude-hedgehog,
-    data-default,
     unordered-containers,
     deepseq,
     extra,
@@ -210,4 +208,3 @@ test-suite doctests
     clash-protocols,
     process,
     doctest
-
diff --git a/src/Protocols.hs → clash-protocols/src/Protocols.hs b/src/Protocols.hs → clash-protocols/src/Protocols.hs
diff --git a/src/Protocols/Avalon/MemMap.hs → ...-protocols/src/Protocols/Avalon/MemMap.hs b/src/Protocols/Avalon/MemMap.hs → ...-protocols/src/Protocols/Avalon/MemMap.hs
diff --git a/src/Protocols/Avalon/Stream.hs → ...-protocols/src/Protocols/Avalon/Stream.hs b/src/Protocols/Avalon/Stream.hs → ...-protocols/src/Protocols/Avalon/Stream.hs
diff --git a/src/Protocols/Axi4/Common.hs → clash-protocols/src/Protocols/Axi4/Common.hs b/src/Protocols/Axi4/Common.hs → clash-protocols/src/Protocols/Axi4/Common.hs
diff --git a/src/Protocols/Axi4/ReadAddress.hs → ...otocols/src/Protocols/Axi4/ReadAddress.hs b/src/Protocols/Axi4/ReadAddress.hs → ...otocols/src/Protocols/Axi4/ReadAddress.hs
diff --git a/src/Protocols/Axi4/ReadData.hs → ...-protocols/src/Protocols/Axi4/ReadData.hs b/src/Protocols/Axi4/ReadData.hs → ...-protocols/src/Protocols/Axi4/ReadData.hs
diff --git a/src/Protocols/Axi4/Stream.hs → clash-protocols/src/Protocols/Axi4/Stream.hs b/src/Protocols/Axi4/Stream.hs → clash-protocols/src/Protocols/Axi4/Stream.hs
diff --git a/src/Protocols/Axi4/WriteAddress.hs → ...tocols/src/Protocols/Axi4/WriteAddress.hs b/src/Protocols/Axi4/WriteAddress.hs → ...tocols/src/Protocols/Axi4/WriteAddress.hs
diff --git a/src/Protocols/Axi4/WriteData.hs → ...protocols/src/Protocols/Axi4/WriteData.hs b/src/Protocols/Axi4/WriteData.hs → ...protocols/src/Protocols/Axi4/WriteData.hs
diff --git a/src/Protocols/Axi4/WriteResponse.hs → ...ocols/src/Protocols/Axi4/WriteResponse.hs b/src/Protocols/Axi4/WriteResponse.hs → ...ocols/src/Protocols/Axi4/WriteResponse.hs
diff --git a/src/Protocols/Df.hs → clash-protocols/src/Protocols/Df.hs b/src/Protocols/Df.hs → clash-protocols/src/Protocols/Df.hs
diff --git a/src/Protocols/DfConv.hs → clash-protocols/src/Protocols/DfConv.hs b/src/Protocols/DfConv.hs → clash-protocols/src/Protocols/DfConv.hs
diff --git a/src/Protocols/Hedgehog.hs → clash-protocols/src/Protocols/Hedgehog.hs b/src/Protocols/Hedgehog.hs → clash-protocols/src/Protocols/Hedgehog.hs
diff --git a/src/Protocols/Hedgehog/Internal.hs → ...tocols/src/Protocols/Hedgehog/Internal.hs b/src/Protocols/Hedgehog/Internal.hs → ...tocols/src/Protocols/Hedgehog/Internal.hs
diff --git a/src/Protocols/Idle.hs → clash-protocols/src/Protocols/Idle.hs b/src/Protocols/Idle.hs → clash-protocols/src/Protocols/Idle.hs
diff --git a/src/Protocols/Wishbone.hs → clash-protocols/src/Protocols/Wishbone.hs b/src/Protocols/Wishbone.hs → clash-protocols/src/Protocols/Wishbone.hs
diff --git a/src/Protocols/Wishbone/Standard.hs → ...tocols/src/Protocols/Wishbone/Standard.hs b/src/Protocols/Wishbone/Standard.hs → ...tocols/src/Protocols/Wishbone/Standard.hs
diff --git a/src/Protocols/Wishbone/Standard/Hedgehog.hs → ...c/Protocols/Wishbone/Standard/Hedgehog.hs b/src/Protocols/Wishbone/Standard/Hedgehog.hs → ...c/Protocols/Wishbone/Standard/Hedgehog.hs
diff --git a/src/Test/Tasty/Hedgehog/Extra.hs → ...rotocols/src/Test/Tasty/Hedgehog/Extra.hs b/src/Test/Tasty/Hedgehog/Extra.hs → ...rotocols/src/Test/Tasty/Hedgehog/Extra.hs
diff --git a/tests/Tests/Protocols.hs → clash-protocols/tests/Tests/Protocols.hs b/tests/Tests/Protocols.hs → clash-protocols/tests/Tests/Protocols.hs
diff --git a/tests/Tests/Protocols/Avalon.hs → ...protocols/tests/Tests/Protocols/Avalon.hs b/tests/Tests/Protocols/Avalon.hs → ...protocols/tests/Tests/Protocols/Avalon.hs
diff --git a/tests/Tests/Protocols/Axi4.hs → ...h-protocols/tests/Tests/Protocols/Axi4.hs b/tests/Tests/Protocols/Axi4.hs → ...h-protocols/tests/Tests/Protocols/Axi4.hs
diff --git a/tests/Tests/Protocols/Df.hs → clash-protocols/tests/Tests/Protocols/Df.hs b/tests/Tests/Protocols/Df.hs → clash-protocols/tests/Tests/Protocols/Df.hs
diff --git a/tests/Tests/Protocols/DfConv.hs → ...protocols/tests/Tests/Protocols/DfConv.hs b/tests/Tests/Protocols/DfConv.hs → ...protocols/tests/Tests/Protocols/DfConv.hs
diff --git a/tests/Tests/Protocols/Plugin.hs → ...protocols/tests/Tests/Protocols/Plugin.hs b/tests/Tests/Protocols/Plugin.hs → ...protocols/tests/Tests/Protocols/Plugin.hs
diff --git a/tests/Tests/Protocols/Wishbone.hs → ...otocols/tests/Tests/Protocols/Wishbone.hs b/tests/Tests/Protocols/Wishbone.hs → ...otocols/tests/Tests/Protocols/Wishbone.hs
diff --git a/tests/Util.hs → clash-protocols/tests/Util.hs b/tests/Util.hs → clash-protocols/tests/Util.hs
diff --git a/tests/doctests.hs → clash-protocols/tests/doctests.hs b/tests/doctests.hs → clash-protocols/tests/doctests.hs
diff --git a/tests/unittests.hs → clash-protocols/tests/unittests.hs b/tests/unittests.hs → clash-protocols/tests/unittests.hs
diff --git a/default.nix b/default.nix
@@ -3,4 +3,4 @@
 with nixpkgs.pkgs;
 with gitignore;
 
-haskellPackages.callCabal2nix "clash-protocols" (gitignoreSource ./.) {}
+haskellPackages.callCabal2nix "clash-protocols" (gitignoreSource ./clash-protocols) {}
diff --git a/format.sh b/format.sh
@@ -34,7 +34,7 @@ cd $DIR
 if [ $1 == "diff" ] ; then
   src_files=$(git diff --cached --name-only --diff-filter=ACMR -- '*.hs')
 else
-  src_files=$(find clash-protocols-base/Setup.hs Setup.hs clash-protocols-base/src src tests -type f -name "*.hs")
+  src_files=$(find clash-protocols-base/Setup.hs clash-protocols/Setup.hs clash-protocols-base/src clash-protocols/src clash-protocols/tests -type f -name "*.hs")
 fi
 
 src_files_str=$(printf "%s\n" "${src_files[@]}" | sed 's| |\\ |g')

diff --git a/hie.yaml b/hie.yaml
@@ -2,15 +2,15 @@ cradle:
   multi:
     - path: "./clash-protocols-base/src"
       config: {cradle: {cabal: {component: "lib:clash-protocols-base"}}}
-    - path: "./src"
+    - path: "./clash-protocols/src"
       config: {cradle: {cabal: {component: "lib:clash-protocols"}}}
-    - path: "./tests"
+    - path: "./clash-protocols/tests"
       config: {cradle: {cabal: {component: "test-suite:unittests"}}}
     - path: "./bin/Clash.hs"
       config: {cradle: {cabal: {component: "clash"}}}
     - path: "./bin/Clashi.hs"
       config: {cradle: {cabal: {component: "clashi"}}}
     - path: "./clash-protocols-base/Setup.hs"
       config: {cradle: {none: }}
-    - path: "./Setup.hs"
+    - path: "./clash-protocols/Setup.hs"
       config: {cradle: {none: }}
diff --git a/stack.yaml b/stack.yaml
@@ -2,7 +2,7 @@ resolver: lts-21.25 # ghc-9.4.8
 
 packages:
   - clash-protocols-base
-  - .
+  - clash-protocols
 
 extra-deps:
 - git: https://github.com/cchalmers/circuit-notation.git