File ripgrep-11.0.2-reproducible-manpage.patch of Package ripgrep

Overview Repositories Revisions Requests Users Attributes Meta

File ripgrep-11.0.2-reproducible-manpage.patch of Package ripgrep (Revision fdc3cf1d04a32f9b2451381eda0b5590)

Currently displaying revision fdc3cf1d04a32f9b2451381eda0b5590 , Show latest

From 12e41809850a4ac14ed200101ef8b033d2a20c38 Mon Sep 17 00:00:00 2001
From: Andrew Gallant <jamslam@gmail.com>
Date: Sun, 15 Mar 2020 10:06:23 -0400
Subject: [PATCH] doc: remove CPU features from man pages

It doesn't really belong in the man page since it's an artifact of a
build/runtime configuration. Moreover, it inhibits reproducible builds.

Fixes #1441
---
 CHANGELOG.md       |  2 ++
 build.rs           |  2 +-
 crates/core/app.rs | 42 ++++++++++++++++++++++++------------------
 3 files changed, 27 insertions(+), 19 deletions(-)

Index: ripgrep-11.0.2/build.rs
===================================================================
--- ripgrep-11.0.2.orig/build.rs
+++ ripgrep-11.0.2/build.rs
@@ -85,7 +85,7 @@ fn generate_man_page<P: AsRef<Path>>(out
 
     let githash = git_revision_hash();
     let githash = githash.as_ref().map(|x| &**x);
-    tpl = tpl.replace("{VERSION}", &app::long_version(githash));
+    tpl = tpl.replace("{VERSION}", &app::long_version(githash, false));
 
     File::create(&txt_path)?.write_all(tpl.as_bytes())?;
     let result = process::Command::new("a2x")
Index: ripgrep-11.0.2/src/app.rs
===================================================================
--- ripgrep-11.0.2.orig/src/app.rs
+++ ripgrep-11.0.2/src/app.rs
@@ -61,7 +61,7 @@ pub fn app() -> App<'static, 'static> {
     // 'static, but we need to build the version string dynamically. We can
     // fake the 'static lifetime with lazy_static.
     lazy_static! {
-        static ref LONG_VERSION: String = long_version(None);
+        static ref LONG_VERSION: String = long_version(None, true);
     }
 
     let mut app = App::new("ripgrep")
@@ -86,30 +86,36 @@ pub fn app() -> App<'static, 'static> {
 /// If a revision hash is given, then it is used. If one isn't given, then
 /// the RIPGREP_BUILD_GIT_HASH env var is inspected for it. If that isn't set,
 /// then a revision hash is not included in the version string returned.
-pub fn long_version(revision_hash: Option<&str>) -> String {
+///
+/// If `cpu` is true, then the version string will include the compiled and
+/// runtime CPU features.
+pub fn long_version(revision_hash: Option<&str>, cpu: bool) -> String {
     // Do we have a git hash?
     // (Yes, if ripgrep was built on a machine with `git` installed.)
     let hash = match revision_hash.or(option_env!("RIPGREP_BUILD_GIT_HASH")) {
         None => String::new(),
         Some(githash) => format!(" (rev {})", githash),
     };
-    // Put everything together.
-    let runtime = runtime_cpu_features();
-    if runtime.is_empty() {
-        format!(
-            "{}{}\n{} (compiled)",
-            crate_version!(),
-            hash,
-            compile_cpu_features().join(" ")
-        )
+    if !cpu {
+        format!("{}{}", crate_version!(), hash,)
     } else {
-        format!(
-            "{}{}\n{} (compiled)\n{} (runtime)",
-            crate_version!(),
-            hash,
-            compile_cpu_features().join(" "),
-            runtime.join(" ")
-        )
+        let runtime = runtime_cpu_features();
+        if runtime.is_empty() {
+            format!(
+                "{}{}\n{} (compiled)",
+                crate_version!(),
+                hash,
+                compile_cpu_features().join(" ")
+            )
+        } else {
+            format!(
+                "{}{}\n{} (compiled)\n{} (runtime)",
+                crate_version!(),
+                hash,
+                compile_cpu_features().join(" "),
+                runtime.join(" ")
+            )
+        }
     }
 }
 
Index: ripgrep-11.0.2/CHANGELOG.md
===================================================================
--- ripgrep-11.0.2.orig/CHANGELOG.md
+++ ripgrep-11.0.2/CHANGELOG.md
@@ -11,6 +11,8 @@ Feature enhancements:
 
 Bug fixes:
 
+* [BUG #1441](https://github.com/BurntSushi/ripgrep/issues/1441):
+  Remove CPU features from man page.
 * [BUG #1246](https://github.com/BurntSushi/ripgrep/issues/1246):
   Add translations to README, starting with an unofficial Chinese translation.
 * [BUG #1259](https://github.com/BurntSushi/ripgrep/issues/1259):

Places

File ripgrep-11.0.2-reproducible-manpage.patch of Package ripgrep (Revision fdc3cf1d04a32f9b2451381eda0b5590)

Places