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.
This commit is contained in:
William Carroll 2020-01-31 15:27:48 +00:00
parent a65b895c8e
commit 837cfe07c7
20 changed files with 60 additions and 59 deletions

6
.envrc
View file

@ -1,5 +1,7 @@
export DOTFILES=~/dotfiles
export BRIEFCASE=~/briefcase
export DEPOT=~/depot
export NIXPKGS=$HOME/nixpkgs
export DESKTOP=zeno.lon.corp.google.com
export LAPTOP=seneca
export CLOUDTOP=wpcarro.c.googlers.com
NIX_PATH=nixpkgs=$HOME/nixpkgs:depot=$HOME/depot:universe=$HOME/universe
NIX_PATH=nixpkgs=$NIXPKGS:depot=$DEPOT:briefcase=$BRIEFCASE

View file

@ -1,8 +1,8 @@
install:
source "${DOTFILES}/configs/install"
source "${BRIEFCASE}/configs/install"
uninstall:
source "${DOTFILES}/configs/uninstall"
source "${BRIEFCASE}/configs/uninstall"
list-broken-links:
find "${HOME}" -maxdepth 1 -xtype l && \

View file

@ -1,17 +1,16 @@
# dotfiles
# briefcase
This is my mono-repo. Having a personal mono-repo is a new idea for me, so at
the time of this writing, the state of this repository is fledgling.
Welcome to my briefcase: my monorepo.
I'm attempting to amass a collection of functions across a variety of languages
while minimizing the costs of sharing the code across a projects. Stay tuned for
more updates as my definition of the mono-repo becomes more clear, my opinions
evolve, and my preferences change.
I'm attempting to amass a collection of packages that span a variety of
languages while minimizing the costs of sharing the code. This also includes
configuration for things like emacs, tmux, ssh, and other tools.
My configuration also lives inside of my mono-repo. Things like Emacs, Tmux,
SSH, and other tools are configured herein.
# Installation (Deprecated)
# Installation
The installation instructions here are deprecated. I'd like to manage packaging
and installing with Nix, but that is only partially supported at the
moment.
## wpgtk and gvcci

View file

@ -1,7 +1,7 @@
{
nixpkgs ? import <nixpkgs> {},
depot ? import <depot> {},
universe ? import <universe> {},
briefcase ? import <briefcase> {},
...
}:
@ -16,7 +16,7 @@ let
'';
in depot.nix.buildLisp.program {
name = "server";
deps = with depot.third_party.lisp; with universe.third_party.lisp; [
deps = with depot.third_party.lisp; with briefcase.third_party.lisp; [
hunchentoot
cl-arrows
];

View file

@ -1,8 +1,8 @@
{ universe ? import <universe> {}, ... }:
{ briefcase ? import <briefcase> {}, ... }:
universe.nix.buildClojure.program {
briefcase.nix.buildClojure.program {
name = "test";
deps = with universe.third_party.clojure; [
deps = with briefcase.third_party.clojure; [
];
srcs = [

View file

@ -1,6 +1,6 @@
#!/usr/bin/env bash
configs="$DOTFILES/configs"
configs="$BRIEFCASE/configs"
case $(hostname) in
$DESKTOP)

View file

@ -286,7 +286,7 @@ abbr --add ef e ~/functions.zsh
abbr --add el e ~/variables.zsh
abbr --add ex e ~/.Xresources
abbr --add em e ~/.tmux.conf
abbr --add er e ~/Dropbox/dotfiles/README.md
abbr --add er e $BRIEFCASE/README.md
# Couple the s* aliases to the <leader>s* kbds in vim.
abbr --add sz source ~/.zshrc

View file

@ -1,6 +1,6 @@
D:~/Dropbox
G:/usr/local/google/home/wpcarro/Downloads
M:/usr/local/google/home/wpcarro/Downloads
c:~/dotfiles/configs
d:~/dotfiles
c:~/briefcase/configs
d:~/briefcase
s:~/Pictures/screenshots

View file

@ -52,7 +52,7 @@ LOCALE_ARCHIVE=$(readlink ~/.nix-profile/lib/locale)/locale-archive
export LOCALE_ARCHIVE
# Set environment variables for Nix. Don't run this for systems running NixOS.
# TODO: Learn why I can't use the variables from ~/dotfiles/.envrc.
# TODO: Learn why I can't use the variables from ~/briefcase/.envrc.
case $(hostname) in
zeno.lon.corp.google.com) . ~/.nix-profile/etc/profile.d/nix.sh;;
seneca) . ~/.nix-profile/etc/profile.d/nix.sh;;

View file

@ -1,6 +1,6 @@
#!/usr/bin/env bash
configs="$DOTFILES/configs"
configs="$BRIEFCASE/configs"
case $(hostname) in
$DESKTOP)

View file

@ -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)))

View file

@ -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))

View file

@ -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

View file

@ -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

View file

@ -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)))))

View file

@ -292,7 +292,7 @@ abbr --add ef e ~/functions.zsh
abbr --add el e ~/variables.zsh
abbr --add ex e ~/.Xresources
abbr --add em e ~/.tmux.conf
abbr --add er e ~/Dropbox/dotfiles/README.md
abbr --add er e $BRIEFCASE/README.md
# TODO: consider DRYing this up with `e`. Unfortunately, `sudo` won't support
# aliases.
abbr --add en sudo ALTERNATE_EDITOR=nvim emacsclient --no-wait --create-frame /etc/nixos/configuration.nix

View file

@ -1,12 +1,12 @@
{
depot ? import <depot> {},
universe ? import <universe> {},
briefcase ? import <briefcase> {},
...
}:
depot.nix.buildLisp.library {
name = "f";
deps = with universe.lisp; [
deps = with briefcase.lisp; [
prelude
];
srcs = [

View file

@ -1,6 +1,6 @@
{
depot ? import <depot> {},
universe ? import <universe> {},
briefcase ? import <briefcase> {},
...
}:
@ -13,7 +13,7 @@ in depot.nix.buildLisp.library {
name = "cl-colors";
deps = [
depot.third_party.lisp.alexandria
universe.third_party.lisp.let-plus
briefcase.third_party.lisp.let-plus
];
srcs = [
"${src}/package.lisp"

View file

@ -1,6 +1,6 @@
{
depot ? import <depot> {},
universe ? import <universe> {},
briefcase ? import <briefcase> {},
...
}:
@ -13,7 +13,7 @@ in depot.nix.buildLisp.library {
name = "let-plus";
deps = [
depot.third_party.lisp.alexandria
universe.third_party.lisp.anaphora
briefcase.third_party.lisp.anaphora
];
srcs = [
"${src}/package.lisp"

View file

@ -1,6 +1,6 @@
{
depot ? import <depot> {},
universe? import <universe> {},
briefcase ? import <briefcase> {},
...
}:
@ -16,7 +16,7 @@ in depot.nix.buildLisp.library {
depot.third_party.lisp.cl-ansi-text
depot.third_party.lisp.alexandria
depot.third_party.lisp.uiop
universe.third_party.lisp.cl-colors
briefcase.third_party.lisp.cl-colors
];
srcs = [
"${src}/src/asdf.lisp"