Skip to content

Commit 902ad5d

Browse files
committed
rename: documentation changes
Update names in COPYING, LICENSE.spdx. Document information regarding the rename in README.md Signed-off-by: Yuxuan Shui <[email protected]>
1 parent ed0e686 commit 902ad5d

File tree

3 files changed

+33
-3
lines changed

3 files changed

+33
-3
lines changed

COPYING

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
compton - a compositor for X11
1+
picom - a compositor for X11
22

33
Based on xcompmgr, originally written by Keith Packard, with modifications
44
from several contributors (according to the xcompmgr man page): Matthew Allum,
55
Eric Anholt, Dan Doel, Thomas Luebking, Matthew Hawn, Ely Levy, Phil Blundell,
66
and Carl Worth. Menu transparency was implemented by Dana Jansens.
77

8-
Numerous contributions to compton from Richard Grenville.
8+
Numerous contributions to picom from Richard Grenville.
99

1010
See the CONTRIBUTORS file for a complete list of contributors
1111

LICENSE.spdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
SPDXVersion: SPDX-2.1
22
DataLicense: CC0-1.0
3-
PackageName: compton
3+
PackageName: picom
44
PackageLicenseDeclared: MPL-2.0 AND MIT

README.md

+30
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,36 @@ To test the new backends, add the `--experimental-backends` flag to the command
2525

2626
To report issues with the new backends, please state explicitly you are using the new backends in your report.
2727

28+
## Rename
29+
30+
### Rational
31+
32+
Since the inception of this fork, the existence of two compton repositories has caused some number of confusions. Mainly, people will report issues of this fork to the original compton, or report issues of the original compton here. Later, when distros started packaging this fork of compton, some wanted to differentiate the newer compton from the older version. They found themselves having no choice but to invent a name for this fork. This is less than ideal since this has the potential to cause more confusions among users.
33+
34+
Therefore, we decided to move this fork to a new name. Personally, I consider this more than justified since this version of compton has gone through significant changes since it was forked.
35+
36+
### The name
37+
38+
The criteria for a good name were
39+
40+
0. Being short, so it's easy to remember.
41+
1. Pronounceability, again, helps memorability
42+
2. Searchability, so when people searches the name, it's easy for them to find this repository.
43+
44+
Of course, choosing a name is never easy, and there is no apparent way to objectively evaluate the names. Yet, we have to solve aforementioned problems as soon as possible.
45+
46+
In the end, we picked `picom` (a portmanteau of `pico` and `composite`) as our new name. This name might not be perfect, but is what we will move forward with unless there's a compelling reason not to.
47+
48+
### Migration
49+
50+
Following the [deprecation process](https://github.com/yshui/compton/issues/114), migration to the new name will be broken into 3 steps:
51+
52+
1. All mentions to `compton` will be updated to `picom` in the code base. `compton` will still be installed, but only as a symlink to `picom`. When `picom` is launched via the symlink, a warning message is printed, alerting the user to migrate. Similarly, the old configuration file names and dbus interface names will still be accepted but warned.
53+
2. 3 major releases after step 1, the warning messages will be prompted to error messages and `picom` will not start when launched via the symlink.
54+
3. 3 major releases after step 2, the symlink will be removed.
55+
56+
The dbus interface and service names are unchanged, so no migration needed for that.
57+
2858
## Change Log
2959

3060
See [Releases](https://github.com/yshui/compton/releases)

0 commit comments

Comments
 (0)