Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc/contributing: mention icons & themes folders #74376

Merged
merged 1 commit into from Dec 7, 2019

Conversation

c0bw3b
Copy link
Contributor

@c0bw3b c0bw3b commented Nov 27, 2019

Motivation for this change

Follow-up to #74060

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nix-review --run "nix-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.
Notify maintainers

cc @worldofpeace @romildo

@@ -652,6 +662,16 @@ args.stdenv.mkDerivation (args // {
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>
If it’s a <emphasis>desktop theme</emphasis>:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Desktop theme is ambiguous. Icon themes are also themes; so are sound themes. Maybe GTK and Qt themes, or whatever?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not just GTK and Qt though. It could be E17 themes, a login manager theme, maybe even a Grub or Plymouth one.

doc/contributing/coding-conventions.xml Outdated Show resolved Hide resolved
@c0bw3b
Copy link
Contributor Author

c0bw3b commented Dec 2, 2019

Second iteration
@worldofpeace @jtojnar PTAL :)

Comment on lines +666 to +668
<term>
If it’s a <emphasis>theme</emphasis> for a <emphasis>desktop environment</emphasis>,
a <emphasis>window manager</emphasis> or a <emphasis>display manager</emphasis>:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this means we won't regroup sound themes here?
Like https://github.com/NixOS/nixpkgs/tree/master/pkgs/data/misc/sound-theme-freedesktop.

Copy link
Contributor Author

@c0bw3b c0bw3b Dec 3, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(saw this after)
no my thinking is that sound themes would be under their own arbo, just like icons

@worldofpeace
Copy link
Contributor

Asking the above because @jtojnar mentioned sound themes in #74376 (comment).

It seems we've gone the ambiguous route to just group anything that could be like a theme to be in that directory. I'm not opposed to this, but I think maybe it would catch sound themes too.

@c0bw3b
Copy link
Contributor Author

c0bw3b commented Dec 3, 2019

No, in my mind sound themes would be located under a dedicated data/sounds or data/sound-themes. But there is none yet so it does not exist (no there is at least sound-theme-freedesktop and it's under data/misc, still better than top-level misc)

Let's keep in mind that we want to document what's already done up to now. Our folder structure is already a little lax, but it's still better than everything in misc or whatev/something/random/bleh :)
The manual already says :

When in doubt, consider refactoring the pkgs/ tree, e.g. creating new categories or splitting up an existing category

So when a PR will want to add a sound theme to nixpkgs, then we could suggest to the contributor to create a data/sounds arbo and locate it there.

@worldofpeace
Copy link
Contributor

Sounds about right @c0deaddict 👍

@c0bw3b
Copy link
Contributor Author

c0bw3b commented Dec 3, 2019

On a side note: if we'd like to make a clear precedent for sound themes, I'm ready to take some time and craft another PR after this for the relocation of sound-theme-freedesktop under data/sounds.
I would maybe also move misc/screensavers under data/screensavers at the same time.. 🐱

@c0bw3b c0bw3b merged commit c65cbd9 into NixOS:master Dec 7, 2019
@c0bw3b c0bw3b deleted the manual/themes branch December 7, 2019 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants