[reproducible-website] 01/01: Format changes for Documentation nav and Definition section
Valerie R Young
spectranaut at riseup.net
Tue Dec 20 02:05:27 UTC 2016
This is an automated email from the git hooks/post-receive script.
spectranaut-guest pushed a commit to branch master
in repository reproducible-website.
commit 8ccd3ba1e3f3dfb3d568a6277d0b293bac198c84
Author: Valerie R Young <spectranaut at riseup.net>
Date: Mon Dec 19 21:05:07 2016 -0500
Format changes for Documentation nav and Definition section
---
_data/docs.yml | 6 +++---
_docs/definition.md | 15 ++++++++-------
2 files changed, 11 insertions(+), 10 deletions(-)
diff --git a/_data/docs.yml b/_data/docs.yml
index 8440061..72e9cb1 100644
--- a/_data/docs.yml
+++ b/_data/docs.yml
@@ -1,10 +1,10 @@
-- title: Best practices
+- title: Introduction
docs:
- definition
- - plans
- buy-in
+ - plans
- test-bench
-- title: Get deterministic builds
+- title: Achieve deterministic builds
docs:
- deterministic-build-systems
- volatile-inputs
diff --git a/_docs/definition.md b/_docs/definition.md
index 16b547a..1b56bcb 100644
--- a/_docs/definition.md
+++ b/_docs/definition.md
@@ -1,10 +1,11 @@
---
-title: When is a build "reproducible"?
+title: Definitions
layout: docs
permalink: /docs/definition/
---
-A build is reproducible if, given the same source code, build environment and
+## When is a build reproducible?
+A build is **reproducible** if, given the same source code, build environment and
build instructions, any party can recreate bit-by-bit identical copies of all
specified artifacts.
@@ -14,21 +15,21 @@ the authors or distributors. The artifacts of a build are the parts of the
build results that are the desired primary output.
## Explanations
-Source code is usually a version control checkout at a specific revision or
+**Source code** is usually a version control checkout at a specific revision or
a source code archive.
-Relevant attributes of the build environment would usually include dependencies
+**Relevant attributes of the build environment** would usually include dependencies
and their versions, build configuration flags and some environment variables as
far as they are used by the build system, such as for example, locale. It is
preferable to reduce the set of relevant attributes of the build environment.
-Artifacts, for example, would include executables, distribution packages or
+**Artifacts**, for example, would include executables, distribution packages or
filesystem images. They would usually not include a build log or similar
secondary outputs.
-The reproducibility of artifacts is verified by bit-by-bit comparison. This is
+The reproducibility of artifacts is **verified** by bit-by-bit comparison. This is
usually achieved using cryptographically secure hash functions.
-Authors or distributors means parties that claim reproducibility of a set of
+**Authors or distributors** means parties that claim reproducibility of a set of
artifacts. These may be upstream authors, distribution maintainers or any other
distributor.
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/reproducible/reproducible-website.git
More information about the Reproducible-commits
mailing list