From 7f28404f2b6ba57c4b85d57a9ab238b5071e1548 Mon Sep 17 00:00:00 2001
From: Martin Habovstiak <martin.habovstiak@gmail.com>
Date: Sat, 22 Oct 2022 09:39:07 +0200
Subject: [PATCH] Document `SOURCE_DATE_EPOCH`

While this crate already supported `SOURCE_DATE_EPOCH` it wasn't
documented that it does. This change adds the appropriate section to
the README.
---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index d36e00c..946cb57 100644
--- a/README.md
+++ b/README.md
@@ -127,6 +127,7 @@ fn main() {
     println!("{}", build::CARGO_TREE);          // e.g. the output of '$ cargo tree'
 
     println!("{}", build::PROJECT_NAME);        // your project name, e.g. 'shadow-rs'
+    // Time respects SOURCE_DATE_EPOCH environment variable - see below
     println!("{}", build::BUILD_TIME);          // time when start build occurred, e.g. '2020-08-16 14:50:25'
     println!("{}", build::BUILD_TIME_2822);     // time when start build occurred by rfc2822, e.g. 'Thu, 24 Jun 2021 21:33:59 +0800'
     println!("{}", build::BUILD_TIME_3339);     // time when start build occurred by rfc3339, e.g. '2021-06-24T21:33:59.972494+08:00'
@@ -136,6 +137,11 @@ fn main() {
 }
 ```
 
+#### Reproducibility
+
+This tool includes the current time in the binary which would normally make it non-reproducible.
+However, it respects the [`SOURCE_DATE_EPOCH` variable](https://reproducible-builds.org/docs/source-date-epoch/) - if set to a Unix timestamp it will override the value of build time.
+
 ## Clap Example
 
 You also can use shadow-rs with [`clap`](https://github.com/baoyachi/shadow-rs/blob/master/example_shadow/src/main.rs).