Giters

Mange / rtl8192eu-linux-driver

Drivers for the rtl8192eu chipset for wireless adapters (D-Link DWA-131 rev E1 included!)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Branch name and version number

rffontenelle opened this issue · comments

commented

Problem

I read the README that the master branch is for an old driver version, and that the currently version is provided in realtek-4.4.x — which is the default branch. However include/rtw_version.h states that the current version is now 5.6.4 (then I saw the commit history for the 5.6.4 update)

So we have 4.4.x in branch and in README, but it doesn't match the driver name. This causes packagers for several distros to use 4.4.1 as latest version (see repology).

Is there a particular reason for keeping these two situations as they are?

Solution suggested

Assuming the above answer is now, I'd bring up the discussion to solve them. And I will start suggesting solutions:

Branch, suggestion 1: Rename

Existent git branches can be renamed. This could be bring some headache, but there could be a heads-up notice of X days/weeks/whatever for the users to be aware. This notice could have 1) when will the change be applied and 2) commands necessary to change rename the branch in there.

Renaming a branch in GitHub Docs shows how the maintainer rename a branch in the web interface, and how to update local clones after the branch name changes.

I suggest renaming it to main.

Branch, suggestion 2: Create a new default

If renaming is too much headache for you and the users, an easy way out is to create a new branch based on the current default realtek-4.4.x and make it default. See Changing the default branch in GitHub Docs.

README, suggestion: update information

(I can do a PR, just let me know if you want to have this started)

  • Update branch name instructions to say the default is now main (or whatever name you choose), and that realtek-4.4.1 (if not renamed) and master are old versions.
  • Provide version information: could be simply a new section stating that the driver version can be found in include/rtw_version.h file, and giving example (something like "this is the content", then point to the actual version: "this one is version")
  • In Submitting patches section, it mentions master which is not the default anymore.
commented

Hi, you are right, the naming not was the best decision.

renaming should broke a lot of projects that use this repo, like ArmBian, some Archilinux AUR, etc.

Create a new default named main looks fine for me.