aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJussi Pakkanen <jpakkane@gmail.com>2017-05-02 23:20:35 +0300
committerJussi Pakkanen <jpakkane@gmail.com>2017-05-11 19:34:16 +0300
commit6e59d845341996b02a74702fbf50e9df671640ab (patch)
treeefb95f362d33b93b266e22f106fbd6a5a78523e2 /docs
parenta91aed8854e7a59d6138adfe2c03ee30e02a1ee5 (diff)
downloadmeson-6e59d845341996b02a74702fbf50e9df671640ab.zip
meson-6e59d845341996b02a74702fbf50e9df671640ab.tar.gz
meson-6e59d845341996b02a74702fbf50e9df671640ab.tar.bz2
Initialise submodules.
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Creating-releases.md15
-rw-r--r--docs/sitemap.txt1
2 files changed, 16 insertions, 0 deletions
diff --git a/docs/markdown/Creating-releases.md b/docs/markdown/Creating-releases.md
new file mode 100644
index 0000000..b0149a6
--- /dev/null
+++ b/docs/markdown/Creating-releases.md
@@ -0,0 +1,15 @@
+---
+short-description: Creating releases
+...
+
+# Creating releases
+
+In addition to development, almost all projects provide periodical source releases. These are standalone packages (usually either in tar or zip format) of the source code. They do not contain any revision control metadata, only the source code.
+
+Meson provides a simple way of generating these. It consists of a single command:
+
+ ninja dist
+
+This creates a file called `projectname-version.tar.xz` in the build tree subdirectory `meson-dist`. This archive contains the full contents of the latest commit in revision control including all the submodules. All revision control metadata is removed. Meson then takes this archive and tests that it works by doing a full compile + test + install cycle. If all these pass, Meson will then create a SHA-256 checksum file next to the archive.
+
+**Note**: Meson behaviour is different from Autotools. The Autotools "dist" target packages up the current source tree. Meson packages the latest revision control commit. The reason for this is that it prevents developers from doing accidental releases where the distributed archive does not match any commit in revision control (especially the one tagged for the release).
diff --git a/docs/sitemap.txt b/docs/sitemap.txt
index c4bb0d4..9dceb05 100644
--- a/docs/sitemap.txt
+++ b/docs/sitemap.txt
@@ -42,6 +42,7 @@ index.md
Build-system-converters.md
Configuring-a-build-directory.md
Run-targets.md
+ Creating-releases.md
Creating-OSX-packages.md
Creating-Linux-binaries.md
Reference-manual.md