Add a DEBUGGING.md file with some information useful for debugging

I have included information about various things I've used for debugging COSMIC. More could definitely be added. It seems good to have some central resource for this. Though not everything listed here is very straightforward to use.
2026-08-28 00:10:16 +00:00 · 2024-07-25 19:04:41 -07:00
28 changed files with 27 additions and 105 deletions
@@ -86,15 +86,3 @@
    path = cosmic-store
    url = https://github.com/pop-os/cosmic-store.git
    branch = master
-[submodule "cosmic-wallpapers"]
-	path = cosmic-wallpapers
-	url = https://github.com/pop-os/cosmic-wallpapers.git
-	branch = master
-[submodule "cosmic-idle"]
-	path = cosmic-idle
-	url = https://github.com/pop-os/cosmic-idle.git
-	branch = master
-[submodule "cosmic-player"]
-	path = cosmic-player
-	url = https://github.com/pop-os/cosmic-player.git
-	branch = master
@@ -1,6 +1,6 @@
 # COSMIC Desktop

-Currently an incomplete **alpha**. Testing instructions below for various distributions.
+Currently an incomplete **pre-alpha**. Testing instructions below for various distributions.


 ## Components of COSMIC Desktop
@@ -16,7 +16,6 @@ Currently an incomplete **alpha**. Testing instructions below for various distri
 * [cosmic-notifications](https://github.com/pop-os/cosmic-notifications)
 * [cosmic-osd](https://github.com/pop-os/cosmic-osd)
 * [cosmic-panel](https://github.com/pop-os/cosmic-panel)
-* [cosmic-player](https://github.com/pop-os/cosmic-player)
 * [cosmic-randr](https://github.com/pop-os/cosmic-randr)
 * [cosmic-screenshot](https://github.com/pop-os/cosmic-screenshot)
 * [cosmic-session](https://github.com/pop-os/cosmic-session)
@@ -125,15 +124,13 @@ We do our best to keep the referenced submodule commits in this repository build
 Notes on versioning and packaging all these components together properly will be added at a later stage once COSMIC DE gets its first release.

 ## Installing on Pop!_OS
-COSMIC DE is in its first alpha release. Using and testing the alpha is welcome. Bugs and breakage are expected.
+COSMIC DE is near its first alpha release. Using and testing the pre-alpha is welcome. Bugs and breakage are expected.

 #### Enable Wayland
 `sudo nano /etc/gdm3/custom.conf`

-Change `WaylandEnable` to `true`:
-```
+Change to true
 WaylandEnable=true
-```

 Reboot for this change to take effect.

@@ -143,7 +140,7 @@ Reboot for this change to take effect.
 sudo nano /usr/lib/udev/rules.d/61-gdm.rules
 ```

-Look for `LABEL="gdm_prefer_xorg"` and `LABEL="gdm_disable_wayland"`. Add `#` to the `RUN` statements so they look like this:
+Look for `LABEL="gdm_prefer_xorg"` and `LABEL="gdm_disable_wayland"`, add `#` to the `RUN` statement so it will look like this

 ```
 LABEL="gdm_prefer_xorg"
@@ -167,8 +164,8 @@ sudo systemctl restart gdm
 After logging out, click on your user and there will be a sprocket at the bottom right. Change the setting to COSMIC. Proceed to log in.

 ## Installing on Arch Linux
-Install via [cosmic-session](https://archlinux.org/packages/extra/x86_64/cosmic-session/) or the [cosmic](https://archlinux.org/groups/x86_64/cosmic/) group, e.g.:
-`pacman -S cosmic-session` or `pacman -S cosmic`
+Installing via the preferred AUR helper is possible the usual way, e.g.:
+`paru -S cosmic-session-git` or `yay -S cosmic-session-git`

 Then log out, click on your user, and a sprocket at the bottom right shows an additional entry alongside your desktop environments. Change to COSMIC and proceed with log in.
 For a more detailed discussion, consider the [relevant section in the Arch wiki](https://wiki.archlinux.org/title/COSMIC).
@@ -183,28 +180,6 @@ dnf install cosmic-desktop
 Then log out, click on your user, and a sprocket at the bottom right shows an additional entry alongside your desktop environments. Change to COSMIC and proceed with log in.
 For further information, you may check the [COPR page](https://copr.fedorainfracloud.org/coprs/ryanabx/cosmic-epoch/).

-## Installing on openSUSE tumbleweed 
-Cosmic can be installed by adding X11:COSMIC:Factory repo with opi.
-```
-opi patterns-cosmic
-```
-Select X11:COSMIC:Factory, after installing keep the repo.
-
-Then log out, click on your user, and a sprocket at the bottom right shows an additional entry alongside your desktop environments. Change to COSMIC and proceed with log in.
-For further information, you may check the [OBS page](https://build.opensuse.org/project/show/X11:COSMIC:Factory).
-
-## Installing on Gentoo Linux
-COSMIC can be installed on Gentoo via a custom overlay. Add the overlay using your preferred overlay manager (such as eselect), and then install the desktop environment:
-
-`eselect repository add cosmic-overlay git https://github.com/fsvm88/cosmic-overlay.git`
-
-Next, install the COSMIC desktop environment and its associated themes:
-
-`emerge cosmic-meta pop-theme-meta`
-
-Then log out, click on your user, and a sprocket at the bottom right shows an additional entry alongside your desktop environments. Change to COSMIC and proceed with log in.
-For further information, you may check the [Gentoo Wiki](https://wiki.gentoo.org/wiki/COSMIC) or [Overlay Repository](https://github.com/fsvm88/cosmic-overlay).
-
 ## Contact
 - [Mattermost](https://chat.pop-os.org/)
 - [Twitter](https://twitter.com/pop_os_official)
@@ -11,12 +11,10 @@ build:
    {{ just }} cosmic-edit/build-release
    {{ just }} cosmic-files/build-release
    {{ just }} cosmic-greeter/build-release
-    {{ just }} cosmic-idle/build-release
    {{ just }} cosmic-launcher/build-release
    {{ just }} cosmic-notifications/build-release
    {{ make }} -C cosmic-osd all
    {{ just }} cosmic-panel/build-release
-    {{ just }} cosmic-player/build-release
    {{ just }} cosmic-randr/build-release
    {{ just }} cosmic-screenshot/build-release
    {{ just }} cosmic-settings/build-release
@@ -24,7 +22,6 @@ build:
    {{ just }} cosmic-session/all
    {{ just }} cosmic-store/build-release
    {{ just }} cosmic-term/build-release
-    {{ make }} -C cosmic-wallpapers all
    {{ make }} -C cosmic-workspaces-epoch all
    {{ make }} -C xdg-desktop-portal-cosmic all

@@ -37,12 +34,10 @@ install rootdir="" prefix="/usr/local": build
    {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-files/install
    {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-greeter/install
    {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-icons/install
-    {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-idle/install
    {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-launcher/install
    {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-notifications/install
    {{ make }} -C cosmic-osd install DESTDIR={{rootdir}} prefix={{prefix}}
    {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-panel/install
-    {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-player/install
    {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-randr/install
    {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-screenshot/install
    {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-settings/install
@@ -50,7 +45,6 @@ install rootdir="" prefix="/usr/local": build
    {{ just }} rootdir={{rootdir}} prefix={{rootdir + prefix}} cosmic-session/install
    {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-store/install
    {{ just }} rootdir={{rootdir}} prefix={{prefix}} cosmic-term/install
-    {{ make }} -C cosmic-wallpapers install DESTDIR={{rootdir}} prefix={{prefix}}
    {{ make }} -C cosmic-workspaces-epoch install DESTDIR={{rootdir}} prefix={{prefix}}
    {{ make }} -C xdg-desktop-portal-cosmic install DESTDIR={{rootdir}} prefix={{prefix}}

@@ -77,10 +71,8 @@ clean:
    rm -rf cosmic-edit/target
    {{ just }} cosmic-files/clean
    rm -rf cosmic-greeter/target
-    {{ just }} cosmic-idle/clean
    rm -rf cosmic-launcher/target
    rm -rf cosmic-panel/target
-    rm -rf cosmic-player/target
    rm -rf cosmic-notifications/target
    rm -rf cosmic-osd/target
    rm -rf cosmic-randr/target
@@ -90,6 +82,5 @@ clean:
    rm -rf cosmic-session/target
    {{ just }} cosmic-store/clean
    {{ just }} cosmic-term/clean
-    {{ make }} -C cosmic-wallpapers clean
    rm -rf cosmic-workspaces-epoch/target
    rm -rf xdg-desktop-portal-cosmic/target
@@ -1,29 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-
-TAG="$1"
-
-if [ -z "$TAG" ]
-then
-    echo "$0 [tag]" >&2
-    exit 1
-fi
-
-echo "Do you want to tag the current state of cosmic-epoch with the tag $TAG? (y/N)"
-read answer
-if [ "$answer" != "y" ]
-then
-    echo "Did not answer y, exiting" >&2
-    exit 1
-fi
-
-set -x
-
-git fetch --recurse-submodules
-
-git tag --force "$TAG"
-git submodule foreach git tag --force "$TAG"
-
-git push --force origin tag "$TAG"
-git submodule foreach git push --force origin tag "$TAG"