From d4b365b55c98ab1cccc2c08677ced04cd5438327 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= <daniel@ekloef.se>
Date: Sat, 16 Oct 2021 16:58:59 +0200
Subject: [PATCH] pgo: full-inner: add --override tweak.grapheme-shaping=no

Grapheme shaping is now enabled by default in foot. However, when
generating the profiling data in PGO builds, this results in skewed
optimizations.

The end result is worse benchmark results regardless of whether
grapheme-shaping is enabled or not (when running the benchmarks).
---
 CHANGELOG.md      | 2 ++
 INSTALL.md        | 6 +++++-
 pgo/full-inner.sh | 1 +
 3 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 3c5f0135..c445a445 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -47,6 +47,8 @@
   itself, and fcft has been compiled with support for it.
 * Default value of `[tweak].grapheme-width-method` changed from
   `double-width` to `wcswidth`.
+* INSTALL.md: `--override tweak.grapheme-shaping=no` added to PGO
+  command line.
 
 
 ### Deprecated
diff --git a/INSTALL.md b/INSTALL.md
index d1801b1b..53619f9e 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -398,7 +398,11 @@ We will use the script `scripts/generate-alt-random-writes.py`:
 ```sh
 ./footclient --version
 foot_tmp_file=$(mktemp)
-./foot --config=/dev/null --term=xterm sh -c "<path-to-generate-alt-random-writes.py> --scroll --scroll-region --colors-regular --colors-bright --colors-256 --colors-rgb --attr-bold --attr-italic --attr-underline --sixel ${foot_tmp_file} && cat ${foot_tmp_file}"
+./foot \
+    --config=/dev/null \
+    --override tweak.grapheme-shaping=no \
+    --term=xterm \
+    sh -c "<path-to-generate-alt-random-writes.py> --scroll --scroll-region --colors-regular --colors-bright --colors-256 --colors-rgb --attr-bold --attr-italic --attr-underline --sixel ${foot_tmp_file} && cat ${foot_tmp_file}"
 rm ${foot_tmp_file}
 ```
 
diff --git a/pgo/full-inner.sh b/pgo/full-inner.sh
index e6168081..599d6aad 100755
--- a/pgo/full-inner.sh
+++ b/pgo/full-inner.sh
@@ -18,6 +18,7 @@ cd "${blddir}"
 "${blddir}"/footclient --version
 "${blddir}"/foot \
            --config=/dev/null \
+           --override tweak.grapheme-shaping=no \
            --term=xterm \
         sh -c "
           set -eux