docs: update

This commit is contained in:
Dylan Araps 2019-08-23 09:37:43 +00:00
parent 91efbe50a8
commit ce3c944405
11 changed files with 24 additions and 66 deletions

View File

@ -7,70 +7,4 @@ The data in each file is separated by lines and spaces. The repository and packa
More information: <https://getkiss.org/pages/package-system/>
## Index
<!-- vim-markdown-toc GFM -->
* [Adding packages to this repository](#adding-packages-to-this-repository)
* [Example package](#example-package)
* [Generating checksums](#generating-checksums)
* [Committing changes](#committing-changes)
* [Pull requests](#pull-requests)
* [Linting](#linting)
* [Code style](#code-style)
<!-- vim-markdown-toc -->
## Adding packages to this repository
Unless for a good reason, new packages go in `public`. The `core`, `extra` and `xorg` repositories are updated on a case by case basis.
- `core`: Contains just enough to rebuild itself and any additional packages.
- `extra`: Contains essential packages which do not belong in `core`.
- `xorg`: Contains everything `xorg` related for a working `xorg-server`.
- `testing`: Contains packages which aren't ready for wide usage yet.
- `public`: Everything else.
When a package is added to `public` it is assumed that the **first** committer is now the maintainer of said package. The other repositories are maintained by the KISS developers themselves.
## Example package
A simple package to use as a reference is `file`. It has dependencies and uses the GNU configure style (*which a lot of packages use*).
https://github.com/kisslinux/repo/tree/master/core/file
## Generating checksums
Once you have packaged something (*and before the first build*) run `kiss checksum pkg` to generate checksums for the package.
## Committing changes
One package per commit unless the packages are very closely related (`linux` and `linux-headers`).
Commit rules:
* **New packages**: `<package>: new package at <version>`
* **Existing packages**: `<package>: update to <version>`, `<package>: bump to <version>` is also acceptable.
* **Other package changes**: `<package>: <changes>`
* **Merges**: GitHub's default format is acceptable, or just `Merge #<PR number>` should suffice.
* **Misc**: We leave that to the discretion of the author and/or committer.
## Pull requests
Ensure that the package builds successfully on your system before creating a pull request. If for some reason it **does not**, open an issue if assistance is needed.
## Linting
All package `build` and `post-install` scripts are subject to checks using `shellcheck`. Packages must pass the linter to be accepted into the repository. Exceptions can be made using `shellcheck disable=SCXXXX` with good reason.
## Code style
- Indentation is 4 spaces.
- Keep variables lowercase unless they're environment variables.
- Use `#!/bin/sh -e`.
- Use `/usr` as the prefix.

7
xorg/xf86-input-evdev/build Executable file
View File

@ -0,0 +1,7 @@
#!/bin/sh -e
./configure \
--prefix=/usr --help 2>&1 | less
make
make DESTDIR="$1" install

View File

@ -0,0 +1 @@
8726073e81861bc7b2321e76272cbdbd33c7e1a121535a9827977265b9033ec0 xf86-input-evdev-2.10.6.tar.bz2

View File

@ -0,0 +1,2 @@
libevdev
xorg-server

View File

@ -0,0 +1 @@
https://www.x.org/pub/individual/driver/xf86-input-evdev-2.10.6.tar.bz2

View File

@ -0,0 +1 @@
2.10.6 1

View File

@ -0,0 +1,7 @@
#!/bin/sh -e
./configure \
--prefix=/usr
make
make DESTDIR="$1" install

View File

@ -0,0 +1 @@
7af83526eff1c76e8b9e1553b34245c203d029028d8044dd9dcf71eef1001576 xf86-input-synaptics-1.9.1.tar.bz2

View File

@ -0,0 +1,2 @@
libevdev
xorg-server

View File

@ -0,0 +1 @@
http://xorg.freedesktop.org/releases/individual/driver/xf86-input-synaptics-1.9.1.tar.bz2

View File

@ -0,0 +1 @@
1.9.1 1