Update for COSMIC alpha 4

Signed-off-by: Tristan Andrus <[email protected]>
Co-authored-by: Tristan Andrus <[email protected]>

.gitmodules

@@ -86,3 +86,11 @@
     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

README.md

@@ -1,6 +1,6 @@
 # COSMIC Desktop
 
-Currently an incomplete **pre-alpha**. Testing instructions below for various distributions.
+Currently an incomplete **alpha**. Testing instructions below for various distributions.
 
 
 ## Components of COSMIC Desktop
@@ -124,13 +124,15 @@ 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 near its first alpha release. Using and testing the pre-alpha is welcome. Bugs and breakage are expected.
+COSMIC DE is in its first alpha release. Using and testing the alpha is welcome. Bugs and breakage are expected.
 
 #### Enable Wayland
 `sudo nano /etc/gdm3/custom.conf`
 
-Change to true
+Change `WaylandEnable` to `true`:
+```
 WaylandEnable=true
+```
 
 Reboot for this change to take effect.
 
@@ -140,7 +142,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` statement so it will look like this
+Look for `LABEL="gdm_prefer_xorg"` and `LABEL="gdm_disable_wayland"`. Add `#` to the `RUN` statements so they look like this:
 
 ```
 LABEL="gdm_prefer_xorg"
@@ -164,8 +166,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
-Installing via the preferred AUR helper is possible the usual way, e.g.:
-`paru -S cosmic-session-git` or `yay -S cosmic-session-git`
+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`
 
 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).
@@ -180,6 +182,28 @@ 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 -1 cosmic-meta pop-theme-meta -pv`
+
+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 [Overlay Repository](https://github.com/fsvm88/cosmic-overlay).
+
 ## Contact
 - [Mattermost](https://chat.pop-os.org/)
 - [Twitter](https://twitter.com/pop_os_official)

docs/DEBUGGING.md

@@ -0,0 +1,41 @@
+Debugging COSMIC
+================
+
+An assortment of useful tools and settings for debugging COSMIC.
+
+## Logs
+Cosmic-comp, cosmic-panel, and other components log to `stderr`, as well as journald (if present).
+
+## Wayland and X11 Protocols
+
+Run clients with `WAYLAND_DEBUG=1` to see what wayland calls are made. `xtrace -n <command>` can be used to see what X calls an X11 client is making.
+
+## XWayland
+
+A tool like `xprop` can be used to determine if an application is running in XWayland. If `xprop` is unable to select a window, it is a native Wayland window.
+
+## Performance
+
+`sudo perf top` can be used to see what functions, across all processes, are using the most CPU time. The `-p` argument can be used to restrict this to a single process. The output is more useful for executables with debug symbols.
+
+`cosmic-comp` integrates Tracy for profiling. It can be built with `cargo build --features profile-with-tracy --profile fastdebug`, then the Tracy client can connect from the same system or a different one
+
+## Graphics drivers
+`eglinfo` and `vulkaninfo` indicate what graphics cards and drivers are in use for hardware-accelerated rendering.
+
+On systems with NVIDIA graphics, `nvidia-smi` has information about the GPU and driver.
+
+## DRM
+The Linux DRM subsystem handles graphics cards and display controllers.
+
+`drm_info` prints information about the outputs, planes, etc. associated with each GPU and their properties. The output of this command can be useful for understanding display related issues.
+
+https://gitlab.freedesktop.org/wlroots/wlroots/-/wikis/DRM-Debugging documents how to configure DRM to enable additional logging, which can be useful for understanding some DRM driver issues.
+
+## Frozen desktop
+
+If the desktop is frozen and `ctrl+alt+f*` don't work to change to a TTY, [the magic SysRq key](https://www.kernel.org/doc/html/latest/admin-guide/sysrq.html) with `r` can be used to swich input in raw mode, so the kernel will handle the tty switch key binding. /etc/sysctl.conf` or `/etc/sysctl.d` may need to be edited first to set `kernel.sysrq=1` or another value that allows this command.
+
+It is also possible to connect over `ssh` from another computer.
+
+Then `pidof cosmic-comp` can be used to get the PID of the compositor. Then it is possible to investigate further with tools like `gdb`, using `sudo gdb` then `attach <pid>`.

justfile

@@ -11,6 +11,7 @@ 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
@@ -22,6 +23,7 @@ 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
 
@@ -34,6 +36,7 @@ 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}}
@@ -45,6 +48,7 @@ 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}}
 
@@ -71,6 +75,7 @@ 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-notifications/target
@@ -82,5 +87,6 @@ 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

scripts/tag.sh

@@ -0,0 +1,29 @@
+#!/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"