only enable desktop generation by default on linux

Author: pvsr

qbpm.1.scd

@@ -38,8 +38,7 @@ appropriate \--basedir, or more conveniently using the qbpm launch and qbpm choo
 
 *new* [options] <profile> [<url>]
 	Create a new qutebrowser profile named _profile_. If _url_ is present it will
-	be used as the profile's home page. By default, a .desktop file will be
-	created for the profile in $XDG_DATA_HOME/applications/qbpm/.
+	be used as the profile's home page.
 
 	Options:
 
@@ -50,12 +49,14 @@ appropriate \--basedir, or more conveniently using the qbpm launch and qbpm choo
 		If --launch is set, run qutebrowser in the foreground.
 
 	*--no-desktop-file*
-		Do not generate a .desktop file for the profile.
+		Do not generate an XDG desktop entry for the profile. Always true on
+		non-linux systems. See https://wiki.archlinux.org/title/Desktop_entries
+		for information on desktop entries.
 
 	*--overwrite*
 		By default qbpm will refuse to create a profile if one with the same name
-		already exists. --overwrite disables this check and rewrites the existing
-		profile's configuration files from scratch. Profile data is left untouched.
+		already exists. --overwrite disables this check and replaces the existing
+		profile's configuration files. Profile data is left untouched.
 
 *launch* [options] <profile> [argument...]
 	Start qutebrowser with --basedir set to the location of _profile_. All
@@ -106,7 +107,7 @@ appropriate \--basedir, or more conveniently using the qbpm launch and qbpm choo
 	*new*.
 
 *desktop* <profile>
-	Generate a .desktop file for _profile_.
+	Generate an XDG desktop entry for _profile_.
 
 *edit* <profile>
 	Open _profile_'s config.py in your default editor.

src/qbpm/desktop.py

@@ -2,7 +2,7 @@
 from pathlib import Path
 from typing import Optional
 
-from xdg_base_dirs import xdg_data_dirs, xdg_data_home
+from xdg_base_dirs import xdg_data_home
 
 from . import Profile
 
@@ -21,7 +21,6 @@
 ]
 
 
-# TODO disable when not on linux?
 # TODO expose application_dir through config
 def create_desktop_file(
     profile: Profile, application_dir: Optional[Path] = None

src/qbpm/main.py

@@ -176,7 +176,7 @@ def desktop(
     context: Context,
     profile_name: str,
 ) -> None:
-    """Create a desktop file for an existing profile."""
+    """Create an XDG desktop file for an existing profile."""
     profile = Profile(profile_name, **vars(context))
     exit_with(operations.desktop(profile))
 

src/qbpm/profiles.py

@@ -1,5 +1,6 @@
 from functools import partial
 from pathlib import Path
+from sys import platform
 from typing import Optional
 
 from . import Profile
@@ -68,15 +69,15 @@ def new_profile(
     profile: Profile,
     qb_config_dir: Optional[Path],
     home_page: Optional[str] = None,
-    desktop_file: bool = True,
+    desktop_file: Optional[bool] = None,
     overwrite: bool = False,
 ) -> bool:
     qb_config_dir = resolve_qb_config_dir(qb_config_dir)
     if not qb_config_dir:
         return False
     if create_profile(profile, overwrite):
         create_config(profile, qb_config_dir, home_page, overwrite)
-        if desktop_file:
+        if desktop_file is True or (desktop_file is not False and platform == "linux"):
             create_desktop_file(profile)
         return True
     return False