From 1ff0aa550be30c4337e58b566331ed9f18567a31 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89rico=20Rolim?= <erico.erc@gmail.com>
Date: Sun, 16 Feb 2020 02:18:41 -0300
Subject: [PATCH] Clean up fish directory.

Reorganize stuff into files, add a few headers. Remove unused stuff, and
move some functionality to scripts.
---
 fish/.config/fish/conf.d/arduino.fish         |  2 -
 fish/.config/fish/conf.d/arm.fish             | 17 ---------
 fish/.config/fish/conf.d/can.fish             |  6 ---
 fish/.config/fish/conf.d/developer.fish       |  9 ++++-
 fish/.config/fish/conf.d/embedded.fish        | 38 +++++++++++++++++++
 fish/.config/fish/conf.d/go.fish              |  3 ++
 fish/.config/fish/conf.d/text_editor.fish     |  6 ++-
 fish/.config/fish/conf.d/utilities.fish       | 10 +++--
 .../fish/conf.d/{display.fish => xrandr.fish} |  3 ++
 fish/.config/fish/config.fish                 |  5 ++-
 fish/.config/fish/functions/fish_prompt.fish  |  2 +-
 script/.local/bin/cp                          |  6 +++
 12 files changed, 72 insertions(+), 35 deletions(-)
 delete mode 100644 fish/.config/fish/conf.d/arduino.fish
 delete mode 100644 fish/.config/fish/conf.d/arm.fish
 delete mode 100644 fish/.config/fish/conf.d/can.fish
 create mode 100644 fish/.config/fish/conf.d/embedded.fish
 rename fish/.config/fish/conf.d/{display.fish => xrandr.fish} (93%)
 create mode 100755 script/.local/bin/cp

diff --git a/fish/.config/fish/conf.d/arduino.fish b/fish/.config/fish/conf.d/arduino.fish
deleted file mode 100644
index 62fb0a6..0000000
--- a/fish/.config/fish/conf.d/arduino.fish
+++ /dev/null
@@ -1,2 +0,0 @@
-alias arduino-uno='arduino-cli compile --fqbn arduino:avr:uno'
-alias arduino-leonardo='arduino-cli compile --fqbn arduino:avr:leonardo'
diff --git a/fish/.config/fish/conf.d/arm.fish b/fish/.config/fish/conf.d/arm.fish
deleted file mode 100644
index 22a425a..0000000
--- a/fish/.config/fish/conf.d/arm.fish
+++ /dev/null
@@ -1,17 +0,0 @@
-function openocdfast -a interface target
-    openocd -f interface/$interface.cfg -f target/$target.cfg
-end
-
-function openocdstlink -a target
-    openocdfast stlink $target
-end
-
-function openocdcmsis -a target
-    openocdfast cmsis-dap $target
-end
-
-alias arm-ugdb='ugdb --gdb arm-none-eabi-gdb'
-
-function arm-ugdb-tmux
-    tmux new-window -n ugdb-arm ugdb --gdb arm-none-eabi-gdb $argv
-end
diff --git a/fish/.config/fish/conf.d/can.fish b/fish/.config/fish/conf.d/can.fish
deleted file mode 100644
index 262fc55..0000000
--- a/fish/.config/fish/conf.d/can.fish
+++ /dev/null
@@ -1,6 +0,0 @@
-alias set-can='sudo ip link set up can0 type can bitrate 500000'
-alias can0dump='candump can0'
-
-function can0filt
-    candump can0,$0:7ff
-end
diff --git a/fish/.config/fish/conf.d/developer.fish b/fish/.config/fish/conf.d/developer.fish
index 5e7fd73..1f3318e 100644
--- a/fish/.config/fish/conf.d/developer.fish
+++ b/fish/.config/fish/conf.d/developer.fish
@@ -1,12 +1,16 @@
+# ericonr's fish config related to development in general
+
 alias jpnb='jupyter-notebook'
 
 alias cformat='clang-format -i -style=webkit'
 
+# Aliases for getting make and cargo to use temporary directories for building.
+# Helps in keepign the SSD fresh.
 alias maketmp='make BUILD_DIR=/tmp/(basename (pwd))'
-
 alias cargotmp='env CARGO_TARGET_DIR=/tmp/cargo/(basename (pwd)) cargo'
 
-function statusgit --argument show
+function statusgit --argument show \
+--description "Show git status for all directories in the current directory. Requires omf."
     if test -z $show
         set show_status false
     else
@@ -60,3 +64,4 @@ function statusgit --argument show
         cd -
     end
 end
+
diff --git a/fish/.config/fish/conf.d/embedded.fish b/fish/.config/fish/conf.d/embedded.fish
new file mode 100644
index 0000000..0522644
--- /dev/null
+++ b/fish/.config/fish/conf.d/embedded.fish
@@ -0,0 +1,38 @@
+# ericonr's fish config related to embedded development
+
+## Functions for programming with openocd
+
+function openocdfast -a interface target
+    openocd -f interface/$interface.cfg -f target/$target.cfg
+end
+
+function openocdstlink -a target
+    openocdfast stlink $target
+end
+
+function openocdcmsis -a target
+    openocdfast cmsis-dap $target
+end
+
+## Alias and function for debugging arm-none-eabi stuff with ugdb
+
+alias arm-ugdb='ugdb --gdb arm-none-eabi-gdb'
+
+function arm-ugdb-tmux
+    tmux new-window -n ugdb-arm ugdb --gdb arm-none-eabi-gdb $argv
+end
+
+## Settings and alias for using the esp-idf tools from Espressif (ESP32)
+
+set -x ESPIDF /opt/esp-idf
+alias esp-idf='$ESPIDF/tools/idf.py -B /tmp/esp/(basename (pwd))'
+
+## Aliases and function for can-utils related stuff
+
+alias set-can='sudo ip link set up can0 type can bitrate 500000'
+alias can0dump='candump can0'
+
+function can0filt
+    candump can0,$0:7ff
+end
+
diff --git a/fish/.config/fish/conf.d/go.fish b/fish/.config/fish/conf.d/go.fish
index 68172dc..b429e81 100644
--- a/fish/.config/fish/conf.d/go.fish
+++ b/fish/.config/fish/conf.d/go.fish
@@ -1,4 +1,7 @@
+# ericonr's fish config for Golang environment variables
+
 set -x GOPATH $HOME/.cache/go
 set -x GOBIN $HOME/.local/bin
 set -x GOTMPDIR /tmp/go-tmp
 set -x GOCACHE /tmp/go-build
+
diff --git a/fish/.config/fish/conf.d/text_editor.fish b/fish/.config/fish/conf.d/text_editor.fish
index f3d65ab..db8c44f 100644
--- a/fish/.config/fish/conf.d/text_editor.fish
+++ b/fish/.config/fish/conf.d/text_editor.fish
@@ -1,8 +1,10 @@
+# ericonr's fish config related to text editing
+
+set -x VISUAL nvim
+
 alias clem='emacsclient -n'
-alias sudoclem='sudo emacsclient -n'
 
 alias temacs="emacs -nw"
-alias stemacs="sudo emacs -nw"
 
 function mdbat --argument-names file
 	mdcat $file | bat -p
diff --git a/fish/.config/fish/conf.d/utilities.fish b/fish/.config/fish/conf.d/utilities.fish
index 48227a4..1ca1c0a 100644
--- a/fish/.config/fish/conf.d/utilities.fish
+++ b/fish/.config/fish/conf.d/utilities.fish
@@ -1,19 +1,23 @@
+# ericonr's fish config for everyday utilities
+
+## Aliases for single column ls
 alias lk='ls -1'
 alias kl='ls -1'
 
-alias cp='cp --reflink=auto --sparse=always'
 alias pre='cd ../'
 
 alias weather='curl wttr.in/'
 
+## Aliases for quick grepping
 alias rgmod='lsmod | rg -i'
 alias rgps='ps aux | rg -i'
 
-function randpw -a digits
+function randpw -a digits \
+--description "Generates a random password with the specified number of digits, and copies it into the Wayland buffer."
 	openssl rand -base64 $digits | wl-copy
 end
 
-function pdfunlock
+function pdfunlock --description "Unlocks all PDF files in a directory."
     # command taken from https://mandrivausers.org/index.php?/topic/79354-saving-pdf-file-without-password-solved/
     echo "Password: $argv[1]"
     
diff --git a/fish/.config/fish/conf.d/display.fish b/fish/.config/fish/conf.d/xrandr.fish
similarity index 93%
rename from fish/.config/fish/conf.d/display.fish
rename to fish/.config/fish/conf.d/xrandr.fish
index 796e423..5fc7d71 100644
--- a/fish/.config/fish/conf.d/display.fish
+++ b/fish/.config/fish/conf.d/xrandr.fish
@@ -1,3 +1,5 @@
+# ericonr's fish config related to xrandr
+
 function list-display --description 'List available display interfaces from xrandr.'
     xrandr | sed -n '/connected/p'
 end
@@ -17,3 +19,4 @@ function conf-display --argument-names width height interface
     end
 
 end
+
diff --git a/fish/.config/fish/config.fish b/fish/.config/fish/config.fish
index af66688..3839bcc 100644
--- a/fish/.config/fish/config.fish
+++ b/fish/.config/fish/config.fish
@@ -1,8 +1,9 @@
+# ericonr's initial fish config
+
 # taken from https://fishshell.com/docs/current/commands.html#contains
-for i in ~/.local/bin ~/.cargo/bin /opt/hipSYCL/CUDA/bin
+for i in ~/.local/bin ~/.cargo/bin
     if not contains $i $PATH
         set PATH $PATH $i
     end
 end
 
-set -x VISUAL nvim
diff --git a/fish/.config/fish/functions/fish_prompt.fish b/fish/.config/fish/functions/fish_prompt.fish
index b775e84..a2e5205 100644
--- a/fish/.config/fish/functions/fish_prompt.fish
+++ b/fish/.config/fish/functions/fish_prompt.fish
@@ -1 +1 @@
-source ("/usr/bin/starship" init fish --print-full-init | psub)
+source ("starship" init fish --print-full-init | psub)
diff --git a/script/.local/bin/cp b/script/.local/bin/cp
new file mode 100755
index 0000000..b2a2457
--- /dev/null
+++ b/script/.local/bin/cp
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+# Uses copy setttings beneficial to Btrfs
+
+/usr/bin/env cp --reflink=auto --sparse=always "$@"
+