Mercurial > vanilla
changeset 594:3cffdd760a86
vanilla: improve docs files
author | David Demelier <markand@malikania.fr> |
---|---|
date | Fri, 12 Jul 2019 20:50:00 +0200 |
parents | 68bbc3a7544b |
children | b8fa19b6a221 |
files | CHANGES.md CONTRIBUTE.md HOWTO.md LICENSE.md README.md STYLE.md UIDS.md UIDS_GIDS.md |
diffstat | 8 files changed, 42 insertions(+), 47 deletions(-) [+] |
line wrap: on
line diff
--- a/CHANGES.md Fri Jul 12 20:45:00 2019 +0200 +++ b/CHANGES.md Fri Jul 12 20:50:00 2019 +0200 @@ -1,23 +1,17 @@ -vanilla CHANGES -=============== +Vanilla Linux CHANGES +===================== -vanilla current ------------------------- +Vanilla Linux current +------------------------------ -### New filesystem hierarchy +### 2019-04-10 Vanilla does not follow FHS anymore, /usr directory has been removed, /bin and /sbin have been merged. -### Default shell - -The default toolchain was switched from GCC to LLVM. Templates have been updated -accordingly. +Compatibility symlinks have been created from /sbin to /bin and from /usr to /. -The /bin/sh default shell has been set to dash. It is only installed if it does -not already exist so user may set a different default shell if desired. - -vanilla 0.1.0 2019-04-01 ------------------------- +Vanilla Linux 0.1.0 2019-04-01 +------------------------------ First release with basic core support.
--- a/CONTRIBUTE.md Fri Jul 12 20:45:00 2019 +0200 +++ b/CONTRIBUTE.md Fri Jul 12 20:50:00 2019 +0200 @@ -1,7 +1,7 @@ -vanilla CONTRIBUTING GUIDE -========================== +Vanilla Linux CONTRIBUTING GUIDE +================================ -Read this guide if you want to contribute to vanilla. The purpose of this +Read this guide if you want to contribute to Vanilla Linux. The purpose of this document is to describe the steps to submit a patch. You may submit a patch when: @@ -38,7 +38,7 @@ [email] from = Your Name <youraddress@yourdomain.tld> - to = vanilla@malikania.fr + to = vanilla-dev@malikania.fr [smtp] host = yourdomain.tld @@ -79,11 +79,11 @@ Create your patch ----------------- -Usually, when you create a patch, you should have your own copy of vanilla -in your directory. +Usually, when you create a patch, you should have your own copy of Vanilla Linux +sources in your directory. -The following steps assumes that you have already cloned the vanilla -repository somewhere. +The following steps assumes that you have already cloned the repository +somewhere. Note: the recommended way is to create one unique revision.
--- a/HOWTO.md Fri Jul 12 20:45:00 2019 +0200 +++ b/HOWTO.md Fri Jul 12 20:50:00 2019 +0200 @@ -1,4 +1,5 @@ -# vanilla HOWTO +Vanilla Linux HOWTO +=================== This documentation explains how to write a package file. @@ -35,7 +36,7 @@ - PKGNAME: the package name - PKGVERSION: the package upstream version -- PKGREVISION: the vanilla revision (starts at 1) +- PKGREVISION: the initial revision (starts at 1) - PKGLICENSE: a space separated list of licenses (see README.licenses.md) - PKGSUMMARY: a short summary @@ -248,7 +249,7 @@ - CXX: C++ compiler (defaults to g++) - CXXFLAGS: C++ flags (defaults to -O2) -## Keep vanilla +## Keep neutral Do not make any modifications to the package. Keep it as close to upstream as possible. Only minor tweaks are allowed including:
--- a/LICENSE.md Fri Jul 12 20:45:00 2019 +0200 +++ b/LICENSE.md Fri Jul 12 20:50:00 2019 +0200 @@ -1,5 +1,5 @@ -vanilla ISC LICENSE -=================== +Vanilla Linux ISC LICENSE +========================= Copyright (c) 2019 David Demelier <markand@malikania.fr>
--- a/README.md Fri Jul 12 20:45:00 2019 +0200 +++ b/README.md Fri Jul 12 20:50:00 2019 +0200 @@ -1,8 +1,8 @@ -vanilla -======= +Vanilla Linux +============= -Welcome to the vanilla source tree. This directory contains scripts to build -precompiled packages for vanilla. +Welcome to the Vanilla Linux source tree. This directory contains scripts to +build precompiled packages for Vanilla Linux. Usage =====
--- a/STYLE.md Fri Jul 12 20:45:00 2019 +0200 +++ b/STYLE.md Fri Jul 12 20:50:00 2019 +0200 @@ -1,5 +1,5 @@ -vanilla CODING STYLE -==================== +Vanilla Linux CODING STYLE +========================== File content ============
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/UIDS.md Fri Jul 12 20:50:00 2019 +0200 @@ -0,0 +1,14 @@ +Vanilla Linux reserved UIDs and GIDs +==================================== + +Users and groups are created once needed at package installation. It's perfectly +safe to reuse the same UID/GID for different packages (example www, mail). + +You may think of UID/GID just like a simple package dependency. + +The following UID/GID are defined: + +| uid | gid | package(s) | +|---------------|---------------|------------| +| sshd (100) | sshd (100) | openssh | +| polkitd (101) | polkitd (101) | polkit |
--- a/UIDS_GIDS.md Fri Jul 12 20:45:00 2019 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,14 +0,0 @@ -vanilla reserved UIDs and GIDs -============================== - -Users and groups are created once needed at package installation. It's perfectly -safe to reuse the same UID/GID for different packages (example www, mail). - -You may think of UID/GID just like a simple package dependency. - -The following UID/GID are defined: - -| uid | gid | package(s) | -|---------------|---------------|------------| -| sshd (100) | sshd (100) | openssh | -| polkitd (101) | polkitd (101) | polkit |