From 00113a38f4ded49e228cb7eee423645894c61795 Mon Sep 17 00:00:00 2001
From: NunoSempere <nuno.sempere@protonmail.com>
Date: Sun, 22 Jan 2023 13:39:25 +0100
Subject: [PATCH] tweak: add documentation for segfault, debug in build.sh

---
 README.md                      | 3 ++-
 build.sh                       | 5 ++++-
 user-scripts/valgrind-notes.md | 9 +++++++++
 3 files changed, 15 insertions(+), 2 deletions(-)
 create mode 100644 user-scripts/valgrind-notes.md

diff --git a/README.md b/README.md
index ae943d4..92ac02d 100644
--- a/README.md
+++ b/README.md
@@ -17,11 +17,12 @@ This is my personal version. Contribute upstream to [github.com/mini-rose/rose](
 
 ### To do
 
-
 - [ ] Add "open in new window" functionality. <https://stackoverflow.com/questions/40180757/webkit2gtk-get-new-window-link>
   - Useful for opening links in new tab when clicking on them and selecting that option
   - And for actually opening links with the href newtab option.
+  - Links: <https://docs.gtk.org/gobject/func.signal_connect.html>, <https://webkitgtk.org/reference/webkit2gtk/2.37.90/signal.AutomationSession.create-web-view.html>, <https://webkitgtk.org/reference/webkit2gtk/2.26.0/WebKitWebView.html#WebKitWebView-create>
 - [ ] Find out what each of the css elements refers to.
+- [ ] Use something other than Whatsapp as an example syslink.
 
 Done: 
 - [x] String substitution on uri in order to redirect to better frontends.
diff --git a/build.sh b/build.sh
index 22db899..a5a8339 100755
--- a/build.sh
+++ b/build.sh
@@ -1,7 +1,10 @@
+#!/bin/bash
+
 CC=clang
 SRC=rose.c
 REQS=./plugins/*/*.c
 DEPS=('webkit2gtk-4.0')
+DEBUG="" # set to "-g" for debug mode.
 
 INCS=`pkg-config --cflags ${DEPS[@]}`
 LIBS=`pkg-config --libs ${DEPS[@]}`
@@ -10,4 +13,4 @@ LIBS=`pkg-config --libs ${DEPS[@]}`
 WYEBAB='-L/usr/lib/wyebrowser/adblock.so'
 
 # echo $CC $INCS $LIBS $SRC $REQS $WYEBAB -o rose
-$CC $INCS $LIBS $SRC $REQS $WYEBAB -o rose
+$CC $DEBUG $INCS $LIBS $SRC $REQS $WYEBAB -o rose
diff --git a/user-scripts/valgrind-notes.md b/user-scripts/valgrind-notes.md
new file mode 100644
index 0000000..1fa2e1d
--- /dev/null
+++ b/user-scripts/valgrind-notes.md
@@ -0,0 +1,9 @@
+In case you arrive at a segmentation fault when working on rose, you can use valgrind.
+
+To do this, you can compile rose with the `DEBUG` value in `build.sh` set to `-g`
+
+and then:
+
+```
+valgrind --track-origins=yes ./rose
+```