about summary refs log tree commit diff
path: root/emacs
diff options
context:
space:
mode:
authorWilliam Carroll <wpcarro@gmail.com>2020-01-31T15·27+0000
committerWilliam Carroll <wpcarro@gmail.com>2020-01-31T15·27+0000
commit837cfe07c76df5e464e3cfc7e9a1f0e64a91c4b5 (patch)
tree09e023d8f7eac7fcf2e3cf39c537f08052385353 /emacs
parenta65b895c8ed7959cd43a2555f6a0f2f99b40741e (diff)
Rename dotfiles -> briefcase
Renaming my mono-repo briefcase.

I first introduced this commit in master, but it introduced a bug where one of
two things would happen:

1. Emacs wouldn't start and would crash X.
2. Emacs would start but my keyboard wouldn't work.

I learned some valuable debugging skills in the process. Here are some of them:

When my keyboard was broken, I wanted to control my computer using my
laptop. Thankfully this is possible by using `x2x`, which forward X events from
the SSH client to the SSH host.

```shell
> # I'm unsure if this is the *exact* command
> ssh -X desktop x2x -west :0.0
```

Git commit-local bisecting. I didn't need to do a `git bisect` because I knew
which commit introduced the bug; it was HEAD, master. But -- as you can see from
the size of this commit -- there are many changes involved. I wanted to binary
search through the changes, so I did the following workflow using `magit`:

- git reset --soft HEAD^
- git stash 1/2 of the files changed
- re-run `nix-env -f ~/briefcase/emacs -i`
- restart X session
- If the problem persists, the bug exists in the non-stashed files. Repeat the
  process until you find the bug.

In my case, the bug was pretty benign. Calling `(exwm/switch "Dotfiles")` at the
bottom of `window-manager.el` was failing because "Dotfiles" is the name of a
non-existent workspace; it should've been `(exwm/switch "Briefcase")`.

There may have been more problems. I changed a few other things along the way,
including exposing the env vars BRIEFCASE to `wpcarros-emacs` inside of
`emacs/default.nix`.

The important part is that this was a valuable learning opportunity, and I'm
glad that I'm walking away from the two days of "lost productivity" feeling
actually productive.
Diffstat (limited to 'emacs')
-rw-r--r--emacs/.emacs.d/wpc/bookmark.el9
-rw-r--r--emacs/.emacs.d/wpc/constants.el2
-rw-r--r--emacs/.emacs.d/wpc/dotfiles.el9
-rw-r--r--emacs/.emacs.d/wpc/window-manager.el10
-rw-r--r--emacs/.emacs.d/wpc/wpc-nix.el20
5 files changed, 25 insertions, 25 deletions
diff --git a/emacs/.emacs.d/wpc/bookmark.el b/emacs/.emacs.d/wpc/bookmark.el
index 734ddaa13a27..01c28ff00474 100644
--- a/emacs/.emacs.d/wpc/bookmark.el
+++ b/emacs/.emacs.d/wpc/bookmark.el
@@ -62,11 +62,8 @@ Otherwise, open with `counsel-find-file'."
    (make-bookmark :label "org"
                   :path "~/Dropbox/org"
                   :kbd "o")
-   (make-bookmark :label "universe"
-                  :path "~/universe"
-                  :kbd "m")
-   (make-bookmark :label "dotfiles"
-                  :path "~/dotfiles"
+   (make-bookmark :label "briefcase"
+                  :path (getenv "BRIEFCASE")
                   :kbd "d")
    (make-bookmark :label "current project"
                   :path constants/current-project
@@ -81,7 +78,7 @@ Otherwise, open with `counsel-find-file'."
 (defun bookmark/magit-status ()
   "Use ivy to select a bookmark and jump to its `magit-status' buffer."
   (interactive)
-  (let ((labels (set/new "dotfiles" "universe" "depot"))
+  (let ((labels (set/new "briefcase" "depot"))
         (all-labels (->> bookmark/whitelist
                          (list/map (>> bookmark-label))
                          set/from-list)))
diff --git a/emacs/.emacs.d/wpc/constants.el b/emacs/.emacs.d/wpc/constants.el
index 5bfedf5553c6..9f12e249fbba 100644
--- a/emacs/.emacs.d/wpc/constants.el
+++ b/emacs/.emacs.d/wpc/constants.el
@@ -21,7 +21,7 @@
 ;; current consumers of these constants, and I'm unsure if the indirection that
 ;; globally defined constants introduces is worth it.
 
-(defconst constants/current-project "~/universe"
+(defconst constants/current-project "~/briefcase/blog"
   "Variable holding the directory for my currently active project.")
 
 (prelude/assert (f-directory? constants/current-project))
diff --git a/emacs/.emacs.d/wpc/dotfiles.el b/emacs/.emacs.d/wpc/dotfiles.el
index 2e78cf213733..d27815c9e3e4 100644
--- a/emacs/.emacs.d/wpc/dotfiles.el
+++ b/emacs/.emacs.d/wpc/dotfiles.el
@@ -20,9 +20,12 @@
 (defconst dotfiles/install-kbds? t
   "When t, install the keybindings.")
 
+(defconst dotfiles/directory (getenv "BRIEFCASE")
+  "The root directory of my configuration files.")
+
 (defconst dotfiles/whitelist
-  '(("compton" . "~/.config/compton.conf")
-    ("dotfiles" . "~/dotfiles/")
+  `(("compton" . "~/.config/compton.conf")
+    ("dotfiles" . ,dotfiles/directory)
     ("functions" . "~/functions.zsh")
     ("aliases" . "~/aliases.zsh")
     ("variables" . "~/variables.zsh")
@@ -47,7 +50,7 @@
 (defun dotfiles/find-emacs-file (name)
   "Call `find-file' on NAME located in dotfiles's emacs.d directory."
   (find-file
-   (f-join "~/dotfiles/configs/shared/.emacs.d" name)))
+   (f-join dotfiles/directory "emacs/.emacs.d" name)))
 
 (provide 'dotfiles)
 ;;; dotfiles.el ends here
diff --git a/emacs/.emacs.d/wpc/window-manager.el b/emacs/.emacs.d/wpc/window-manager.el
index cf7f1efeb799..b6caa8adfd8f 100644
--- a/emacs/.emacs.d/wpc/window-manager.el
+++ b/emacs/.emacs.d/wpc/window-manager.el
@@ -78,7 +78,7 @@
          :index 1
          :kbd "p")
         (make-exwm/named-workspace
-         :label "Dotfiles"
+         :label "Briefcase"
          :index 2
          :kbd "d")
         (make-exwm/named-workspace
@@ -611,10 +611,8 @@ Currently using super- as the prefix for switching workspaces."
      ;; Dotfiles
      ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
      (progn
-       (exwm/switch "Dotfiles")
-       (dotfiles/find-emacs-file "init.el")
-       (wpc/evil-window-vsplit-right)
-       (dotfiles/find-emacs-file "wpc/window-manager.el"))
+       (exwm/switch "Briefcase")
+       (dotfiles/find-emacs-file "init.el"))
      ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
      ;; Chatter
      ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
@@ -641,7 +639,7 @@ Currently using super- as the prefix for switching workspaces."
      ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
      ;; Reset to default
      ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-     (exwm/switch "Dotfiles"))))
+     (exwm/switch "Briefcase"))))
 
 (provide 'window-manager)
 ;;; window-manager.el ends here
diff --git a/emacs/.emacs.d/wpc/wpc-nix.el b/emacs/.emacs.d/wpc/wpc-nix.el
index 68d542e01176..7407e02bfd41 100644
--- a/emacs/.emacs.d/wpc/wpc-nix.el
+++ b/emacs/.emacs.d/wpc/wpc-nix.el
@@ -8,8 +8,10 @@
 ;; Dependencies
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 
-(prelude/assert (f-exists? "~/universe"))
-(prelude/assert (f-exists? "~/depot"))
+;; TODO: These may fail at startup. How can I make sure that the .envrc is
+;; consulted when Emacs starts?
+(prelude/assert (f-exists? (getenv "BRIEFCASE")))
+(prelude/assert (f-exists? (getenv "DEPOT")))
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;; Library
@@ -19,7 +21,7 @@
 (use-package nix-mode
   :mode "\\.nix\\'")
 
-(defun nix/sly-from-universe (attribute)
+(defun nix/sly-from-briefcase (attribute)
   "Start a Sly REPL configured with a Lisp matching a derivation
   from my monorepo.
 
@@ -29,12 +31,12 @@ This function was taken from @tazjin's depot and adapted for my monorepo.
   asynchronously. The build output is included in the error
   thrown on build failures."
   (interactive "sAttribute: ")
-  (lexical-let* ((outbuf (get-buffer-create (format "*universe-out/%s*" attribute)))
-         (errbuf (get-buffer-create (format "*universe-errors/%s*" attribute)))
-         (expression (format "let depot = import <depot> {}; universe = import <universe> {}; in depot.nix.buildLisp.sbclWith [ universe.%s ]" attribute))
+  (lexical-let* ((outbuf (get-buffer-create (format "*briefcase-out/%s*" attribute)))
+         (errbuf (get-buffer-create (format "*briefcase-errors/%s*" attribute)))
+         (expression (format "let depot = import <depot> {}; briefcase = import <briefcase> {}; in depot.nix.buildLisp.sbclWith [ briefcase.%s ]" attribute))
          (command (list "nix-build" "-E" expression)))
-    (message "Acquiring Lisp for <depot>.%s" attribute)
-    (make-process :name (format "depot-nix-build/%s" attribute)
+    (message "Acquiring Lisp for <briefcase>.%s" attribute)
+    (make-process :name (format "nix-build/%s" attribute)
                   :buffer outbuf
                   :stderr errbuf
                   :command command
@@ -45,7 +47,7 @@ This function was taken from @tazjin's depot and adapted for my monorepo.
                           ("finished\n"
                            (let* ((outpath (s-trim (with-current-buffer outbuf (buffer-string))))
                                   (lisp-path (s-concat outpath "/bin/sbcl")))
-                             (message "Acquired Lisp for <depot>.%s at %s" attribute lisp-path)
+                             (message "Acquired Lisp for <briefcase>.%s at %s" attribute lisp-path)
                              (sly lisp-path)))
                           (_ (with-current-buffer errbuf
                                (error "Failed to build '%s':\n%s" attribute (buffer-string)))))