From 478393fb7d5f51ef5030c37b6e862789d6441cc5 Mon Sep 17 00:00:00 2001 From: slotThe Date: Wed, 12 Jan 2022 15:10:15 +0100 Subject: [PATCH] Deprecate user and abandoned modules Now that the user configs are on the website, it is time to deprecate them. At the same time deprecated X.C.Monad, which hasn't been updated since 2008 and X.C.Prime, which has confused users quite recently, thinking it to be a better starting place. Fixes: https://github.com/xmonad/xmonad-contrib/issues/677 Fixes: https://github.com/xmonad/xmonad-contrib/issues/595 Related: https://github.com/xmonad/xmonad-web/pull/49 --- CHANGES.md | 7 +++++++ XMonad/Config/Arossato.hs | 1 + XMonad/Config/Bluetile.hs | 2 +- XMonad/Config/Dmwit.hs | 2 +- XMonad/Config/Droundy.hs | 2 +- XMonad/Config/Monad.hs | 2 +- XMonad/Config/Prime.hs | 2 +- XMonad/Config/Saegesser.hs | 2 ++ XMonad/Config/Sjanssen.hs | 2 +- XMonad/Layout/IndependentScreens.hs | 2 +- 10 files changed, 17 insertions(+), 7 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 51263e2d..22fbbeef 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -10,6 +10,13 @@ now return a `Parser` (from `XMonad.Util.Parser`) instead of a `ReadP`. + * `XMonad.Config.{Arossato,Bluetile,Dmwit,Droundy,Monad,Prime,Saegesser,Sjanssen}` + + - Deprecated all of these modules. The user-specific configuration + modules may still be found [on the website]. + +[on the website]: https://xmonad.org/configurations.html + ### New Modules * `XMonad.Layout.CenteredIfSingle` diff --git a/XMonad/Config/Arossato.hs b/XMonad/Config/Arossato.hs index 19e7e7ab..c5007df4 100644 --- a/XMonad/Config/Arossato.hs +++ b/XMonad/Config/Arossato.hs @@ -16,6 +16,7 @@ ------------------------------------------------------------------------ module XMonad.Config.Arossato + {-# DEPRECATED "This module contains a personal configuration, to be removed from xmonad-contrib. If you use this module, please copy the relevant parts to your configuration or obtain a copy of it on https://xmonad.org/configurations.html and include it as a local module." #-} ( -- * Usage -- $usage arossatoConfig diff --git a/XMonad/Config/Bluetile.hs b/XMonad/Config/Bluetile.hs index f39fdd17..e6daf1da 100644 --- a/XMonad/Config/Bluetile.hs +++ b/XMonad/Config/Bluetile.hs @@ -20,7 +20,7 @@ -- ----------------------------------------------------------------------------- -module XMonad.Config.Bluetile ( +module XMonad.Config.Bluetile {-# DEPRECATED "This module contains a personal configuration, to be removed from xmonad-contrib. If you use this module, please copy the relevant parts to your configuration or obtain a copy of it on https://xmonad.org/configurations.html and include it as a local module." #-} ( -- * Usage -- $usage bluetileConfig diff --git a/XMonad/Config/Dmwit.hs b/XMonad/Config/Dmwit.hs index 7f4b19f8..e019f1a2 100644 --- a/XMonad/Config/Dmwit.hs +++ b/XMonad/Config/Dmwit.hs @@ -7,7 +7,7 @@ -- Description : Daniel Wagner's xmonad configuration. -- ------------------------------------------------------------------------ -module XMonad.Config.Dmwit where +module XMonad.Config.Dmwit {-# DEPRECATED "This module contains a personal configuration, to be removed from xmonad-contrib. If you use this module, please copy the relevant parts to your configuration or obtain a copy of it on https://xmonad.org/configurations.html and include it as a local module." #-} where -- system imports import Control.Monad.Trans diff --git a/XMonad/Config/Droundy.hs b/XMonad/Config/Droundy.hs index da053a35..f4afe848 100644 --- a/XMonad/Config/Droundy.hs +++ b/XMonad/Config/Droundy.hs @@ -8,7 +8,7 @@ -- License : BSD3-style (see LICENSE) -- ------------------------------------------------------------------------ -module XMonad.Config.Droundy ( config, mytab ) where +module XMonad.Config.Droundy {-# DEPRECATED "This module contains a personal configuration, to be removed from xmonad-contrib. If you use this module, please copy the relevant parts to your configuration or obtain a copy of it on https://xmonad.org/configurations.html and include it as a local module." #-} ( config, mytab ) where import XMonad hiding (keys, config) import qualified XMonad (keys) diff --git a/XMonad/Config/Monad.hs b/XMonad/Config/Monad.hs index 364e65aa..2399e300 100644 --- a/XMonad/Config/Monad.hs +++ b/XMonad/Config/Monad.hs @@ -15,7 +15,7 @@ ideas: "only once" features like avoidStruts, ewmhDesktops -} -module XMonad.Config.Monad where +module XMonad.Config.Monad {-# DEPRECATED "This module does not work." #-} where import XMonad hiding (terminal, keys) import qualified XMonad as X diff --git a/XMonad/Config/Prime.hs b/XMonad/Config/Prime.hs index 1c9c3504..1a5fd6da 100644 --- a/XMonad/Config/Prime.hs +++ b/XMonad/Config/Prime.hs @@ -23,7 +23,7 @@ -- ----------------------------------------------------------------------------- -module XMonad.Config.Prime ( +module XMonad.Config.Prime {-# DEPRECATED "This module is a perpetual draft and will therefore be removed from xmonad-contrib in the near future." #-} ( -- Note: The identifiers here are listed in the order that makes the most sense -- for a user, while the definitions below are listed in the order that makes -- the most sense for a developer. diff --git a/XMonad/Config/Saegesser.hs b/XMonad/Config/Saegesser.hs index 53ead7a0..7b8fb17c 100755 --- a/XMonad/Config/Saegesser.hs +++ b/XMonad/Config/Saegesser.hs @@ -6,6 +6,8 @@ -- A mostly striped down configuration that demonstrates spawnOnOnce -- --------------------------------------------------------------------- +module XMonad.Config.Saegesser {-# DEPRECATED "This module contains a personal configuration, to be removed from xmonad-contrib. If you use this module, please copy the relevant parts to your configuration or obtain a copy of it on https://xmonad.org/configurations.html and include it as a local module." #-} where + import System.IO import XMonad diff --git a/XMonad/Config/Sjanssen.hs b/XMonad/Config/Sjanssen.hs index fefc604a..e71b55fe 100644 --- a/XMonad/Config/Sjanssen.hs +++ b/XMonad/Config/Sjanssen.hs @@ -5,7 +5,7 @@ -- Description : Spencer Janssen's xmonad config. -- ------------------------------------------------------------------------ -module XMonad.Config.Sjanssen (sjanssenConfig) where +module XMonad.Config.Sjanssen {-# DEPRECATED "This module contains a personal configuration, to be removed from xmonad-contrib. If you use this module, please copy the relevant parts to your configuration or obtain a copy of it on https://xmonad.org/configurations.html and include it as a local module." #-} (sjanssenConfig) where import XMonad hiding (Tall(..)) import qualified XMonad.StackSet as W diff --git a/XMonad/Layout/IndependentScreens.hs b/XMonad/Layout/IndependentScreens.hs index e3e93fae..e00468ab 100644 --- a/XMonad/Layout/IndependentScreens.hs +++ b/XMonad/Layout/IndependentScreens.hs @@ -78,7 +78,7 @@ import qualified XMonad.StackSet as W -- screen into a physical workspace name. -- -- A complete example abusing many of the functions below is available in the --- "XMonad.Config.Dmwit" module. +-- configuration. type VirtualWorkspace = WorkspaceId type PhysicalWorkspace = WorkspaceId