changeset 1286:53cb989f05ad

misc: update markdown files
author David Demelier <markand@malikania.fr>
date Mon, 15 Nov 2021 09:26:44 +0100
parents 6531ae5da11a
children 8c73c712e598
files CHANGES.md CONTRIBUTE.md LICENSE.md README.md
diffstat 4 files changed, 67 insertions(+), 26 deletions(-) [+]
line wrap: on
line diff
--- a/CHANGES.md	Mon Nov 15 09:11:52 2021 +0100
+++ b/CHANGES.md	Mon Nov 15 09:26:44 2021 +0100
@@ -1,8 +1,45 @@
-Vanilla Linux CHANGES
-=====================
+vanilla CHANGES
+===============
+
+This changelog contains only important changes, individual packages upgrades are
+explicitly omitted from this file.
+
+vanilla current
+---------------
+
+### 2021-11-15
+
+LLVM has been upgraded to 13.0.0.
+
+For better user experience and disk usage, it is now split into individual
+packages. This is mainly due to the fact that LLVM is now distributed as a
+monorepo, unfortunately this means that you need to rebuild the whole toolchain
+if just one component has to be rebuilt (e.g.  `clang`).
+
+Split packages are as following:
 
-Vanilla Linux current
-------------------------------
+- clang
+- compiler-rt
+- libcxx
+- libcxxabi
+- libunwind
+- lld
+- lldb
+- openmp
+
+More packages will be split out in the future (e.g. libllvm, clang-tools-extra
+and so on).
+
+### 2021-08-03
+
+Split packages are now supported.
+
+It is still considered as an unloved feature of last resort. It is currently
+enabled for large packages that provide both libraries and utilities that are
+not strictly required together. This includes:
+
+- util-linux (splits into libuuid, libblkid, ...),
+- llvm
 
 ### 2019-08-28
 
@@ -28,7 +65,7 @@
 
 Compatibility symlinks have been created from /sbin to /bin and from /usr to /.
 
-Vanilla Linux 0.1.0 2019-04-01
-------------------------------
+vanilla 0.1.0 2019-04-01
+------------------------
 
 First release with basic core support.
--- a/CONTRIBUTE.md	Mon Nov 15 09:11:52 2021 +0100
+++ b/CONTRIBUTE.md	Mon Nov 15 09:26:44 2021 +0100
@@ -1,5 +1,5 @@
-Vanilla Linux CONTRIBUTING GUIDE
-================================
+vanilla CONTRIBUTING GUIDE
+==========================
 
 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.
@@ -97,7 +97,7 @@
 
 Replace `topic` with one of the following:
 
-- **vanilla**: for a non package changeset,
+- **misc**: for a non package changeset,
 - **category/package**: for a specific package.
 
 ### Quick way
--- a/LICENSE.md	Mon Nov 15 09:11:52 2021 +0100
+++ b/LICENSE.md	Mon Nov 15 09:26:44 2021 +0100
@@ -1,7 +1,7 @@
-Vanilla Linux ISC LICENSE
-=========================
+vanilla ISC LICENSE
+===================
 
-Copyright (c) 2019 David Demelier <markand@malikania.fr>
+Copyright (c) 2019-2021 David Demelier <markand@malikania.fr>
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above
--- a/README.md	Mon Nov 15 09:11:52 2021 +0100
+++ b/README.md	Mon Nov 15 09:26:44 2021 +0100
@@ -1,27 +1,29 @@
-Vanilla Linux
-=============
+The vanilla project
+===================
+
+Welcome to the vanilla source tree. This directory contains scripts to build
+precompiled packages for vanilla linux distribution.
 
-Welcome to the Vanilla Linux source tree. This directory contains scripts to
-build precompiled packages for Vanilla Linux.
+This source tree is usually only required for vanilla development, end users who
+just want to rebuild binary packages should use `vpk`, `vpkbuild` and rebuild
+source package from the official packages repository.
 
-This source tree is usually only required for Vanilla Linux development, end
-users who just want to rebuild binary packages should use `vpk` and rebuild
-source package from the repository.
+More information about the vanilla project into its dedicated [homepage][].
 
 Usage
 =====
 
-To build a script, go to the desired directory and use `vpk build`.
+To build a script, go to the desired directory and use `vpkbuild build`.
 
 Example with zlib:
 
 	$ cd compression/zlib
-	$ vpk download
-	$ vpk build
+	$ vpkbuild download
+	$ vpkbuild build -b
 
-Then if build succeeded, you may install the package in /tmp/vpk/pkg.
+Then if build succeeded, you may install the package in */tmp/vpk/*.
 
-	$ vpk add /tmp/vpk/zlib*.txz
+	$ vpk add /tmp/vpk/$(vpk arch)/zlib*.tar.gz
 
 Options
 =======
@@ -29,10 +31,12 @@
 Check the variable *PKGOPTIONS* in the build script file, if there is one it
 means the package is configurable with options.
 
-Specify environment variables before calling `vpk build`.
+Specify environment variables before calling `vpkbuild build`.
 
 Example:
 
-	$ PULSEAUDIO=no vpk build
+	$ PULSEAUDIO=no vpkbuild build
 
 Note: boolean options are set using *no* and *yes* (case sensitive).
+
+[homepage]: http://projects.malikania.fr/vanilla