Tracking: Migrate SDL libs to their real names, no capitals, no underscores

Open
#522,007 0 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Quiet
Domain
tooling

Research direction

Start by locating the package definitions for the listed SDL libraries and inspect top-level/all-packages and top-level/aliases.nix. Migrate the names to lowercase, hyphenated forms, and move the SDL and SDL2 aliases to top-level/aliases.nix; completion is the checklist being fully addressed.

Written by the indexing model from the issue text.

Description

0.kind: enhancement 3.skill: sprintable 5.scope: tracking 6.topic: hygiene

While doing some dev with SDL libs, I found it pretty annoying that the discoverability was pretty low.

  1. Not all of the libraries have their real names (sdl12-compat is named SDL_compat for some reason?)
  2. Many of them use capitals for SDL, which is not good practice in nixpkgs
  3. Many of them use underscores, which is also not good practice in nixpkgs

So it would be nice to migrate them to new names that fix those issues.

Also remove the aliases that are in top-level/all-packages and move them to the aliases file (SDL and SDL2)

Tracking

  • SDL_compat #522006
  • SDL2
  • SDL_gfx
  • SDL_net
  • SDL_ttf
  • SDL2_gfx
  • SDL2_net
  • SDL2_ttf
  • SDL_image
  • SDL_mixer
  • SDL_sixel
  • SDL_sound
  • SDL2_Pango
  • SDL2_image
  • SDL2_mixer
  • SDL2_sound
  • SDL_stretch
  • SDL_audiolib
  • SDL alias to top-level/aliases.nix
  • SDL2 alias to top-level/aliases.nix
Dominant language
Nix
Stars
26.2k
Forks
20.1k
Avg merge
9h 57m
Merged PRs (30d)
517

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from NixOS/nixpkgs

All issues in NixOS/nixpkgs

Similar issues

More DevTools issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.