From 3634a960545fae1c6366b5f371082596e106f58e Mon Sep 17 00:00:00 2001 From: Lucien Cartier-Tilet Date: Sat, 12 Feb 2022 12:50:07 +0100 Subject: [PATCH] [Org files] Fix org-lint issues Replace deprecated `HEADERS' keyword with `HEADER' Fix broken links Better headers in some files Fix some typos --- org/config/bootstrap.org | 5 ++-- org/config/emacs.org | 24 ++++++++--------- org/config/index.org | 57 ++++++++++++++++++++-------------------- org/config/neofetch.org | 3 ++- org/config/picom.org | 1 + org/config/stumpwm.org | 16 +++++------ 6 files changed, 55 insertions(+), 51 deletions(-) diff --git a/org/config/bootstrap.org b/org/config/bootstrap.org index 8d0f9dd..cea091c 100644 --- a/org/config/bootstrap.org +++ b/org/config/bootstrap.org @@ -639,8 +639,9 @@ mkdir -p ~/fromGIT :PROPERTIES: :CUSTOM_ID: Execute_bootstrap-Install_packages_from_git-Reveal.JS-bb4da0bf :END: -I sometimes use Reveal.JS to make presentations, and I set its location in my -[[file:.spacemacs][dotspacemacs]] file to be in =~/fromGIT=, so let’s clone it there. +I sometimes use Reveal.JS to make presentations, and I set its +location in my [[file:emacs.org][Emacs config]] to be in =~/fromGIT=, so let’s clone it +there. #+BEGIN_SRC fish printf "\n# Install Reveal.JS ###########################################################\n\n" cd ~/fromGIT diff --git a/org/config/emacs.org b/org/config/emacs.org index 61ab099..77afaf0 100644 --- a/org/config/emacs.org +++ b/org/config/emacs.org @@ -200,7 +200,7 @@ fit mine, so on top of ~prog-mode~, let’s add a few other modes. | latex-mode | #+name: prog-modes-gen -#+headers: :cache yes :exports none :tangle no +#+header: :cache yes :exports none :tangle no #+begin_src emacs-lisp :var modes=line-number-modes-table (mapconcat (lambda (mode) (format "%s-hook" (car mode))) modes @@ -872,7 +872,7 @@ can still feel some influence from my Spacemacs years here. #+end_src #+name: general-keybindings-gen -#+headers: :tangle no :exports none :results value :cache yes +#+header: :tangle no :exports none :results value :cache yes #+begin_src emacs-lisp :var table=keybinds-windows prefix="" (mapconcat (lambda (line) (let* ((key (car line)) @@ -1698,7 +1698,7 @@ Paris 8 (my university). #+end_src #+name: mu4e-bookmarks-mailing-lists -#+headers: :tangle no :exports none +#+header: :tangle no :exports none #+begin_src emacs-lisp :var lists=mu4e-emacs-mailing-lists (mapconcat (lambda (list) (let ((address (string-replace (regexp-quote "~") "" (car list)))) @@ -1711,7 +1711,7 @@ Paris 8 (my university). #+end_src #+name: mu4e-bookmarks-filter-uni -#+headers: :tangle no :cache yes +#+header: :tangle no :cache yes #+begin_src emacs-lisp (let ((regex "/.*up8\\.edu|.*univ-paris8.*/")) <>) @@ -1722,7 +1722,7 @@ Paris 8 (my university). Next I need an inbox dedicated to the association I’m part of. #+name: mu4e-bookmarks-filter-asso -#+headers: :tangle no :cache yes +#+header: :tangle no :cache yes #+begin_src emacs-lisp (let ((regex "/.*supran\\.fr/")) <>) @@ -1743,7 +1743,7 @@ match: - ~/.*eshell-info-banner.*/~ #+name: mu4e-bookmarks-filter-emacs-list -#+headers: :tangle no :cache yes +#+header: :tangle no :cache yes #+begin_src emacs-lisp "<>" #+end_src @@ -1757,7 +1757,7 @@ issues and PRs from Github. - ~/.*\\.github\\.com/~ #+name: mu4e-bookmarks-filter-github-list -#+headers: :tangle no :cache yes +#+header: :tangle no :cache yes #+begin_src emacs-lisp "<>" #+end_src @@ -1772,7 +1772,7 @@ subscribed anymore, but it’ll keep my inbox clean. - ~/.*LANG@LISTSERV.BROWN.EDU/~ #+name: mu4e-bookmarks-filter-conlang-list -#+headers: :tangle no :cache yes +#+header: :tangle no :cache yes #+begin_src emacs-lisp "<>" #+end_src @@ -1784,7 +1784,7 @@ As I said earlier, something that will often come back in my bookmarks is the emails must not be trashed to appear. I want also to display junk emails, so I end up with the following rule: #+name: mu4e-bookmarks-default-filter -#+headers: :tangle no :cache yes +#+header: :tangle no :cache yes #+begin_src emacs-lisp (mapconcat #'identity `("NOT flag:trashed" @@ -1799,7 +1799,7 @@ junk emails, so I end up with the following rule: And for the last string-generating code, let’s describe my main inbox: #+name: mu4e-bookmarks-inbox-filters -#+headers: :tangle no :cache yes +#+header: :tangle no :cache yes #+begin_src emacs-lisp (mapconcat #'identity (cons "<>" @@ -3451,7 +3451,7 @@ these will be renamed this way: - Qutebrowser #+name: exwm-gen-buffers-rename -#+headers: :exports none :tangle no +#+header: :exports none :tangle no #+begin_src emacs-lisp :var buffers=exwm-renamed-buffers-list :cache yes (format "%s\n%S" (mapconcat (lambda (buffer) @@ -3604,7 +3604,7 @@ A couple of commands are also automatically executed: file #+name: exwm-generate-autostarts -#+headers: :exports results :tangle no +#+header: :exports results :tangle no #+begin_src emacs-lisp :var autostarts=exwm-autostart-list :cache yes (mapconcat (lambda (command) (let* ((whitespace (rx (+ space))) diff --git a/org/config/index.org b/org/config/index.org index 9ad7295..900d8a2 100644 --- a/org/config/index.org +++ b/org/config/index.org @@ -25,7 +25,7 @@ When it comes to my graphical UI, I do not have any desktop environment. Instead, I have a tiling window managers, [[https://stumpwm.github.io/][StumpWM]]. I used to use [[https://github.com/Airblader/i3][i3-gaps]], an [[https://i3wm.org/][i3]] fork by [[https://github.com/Airblader/i3][Airblader]], with which I used [[https://polybar.github.io/][Polybar]] as well as [[https://github.com/dylanaraps/pywal][pywal]] to define my system’s color scheme, and then I used -[[file:awesome.org][Awesome]]. But now, as said above, I prefer to use StumpWM. It has a +[[file:Deprecated/awesome.org][Awesome]]. But now, as said above, I prefer to use StumpWM. It has a built-in status bar (called a mode-line, like in Emacs) which I use, and I settled on the dark [[https://www.nordtheme.com/][Nord theme]] for pretty much everything I use. @@ -46,9 +46,10 @@ some games that do not offer to remap keys (I’m looking at you, Among Us). Most of the org files you will find in this repos are the actual source code of much of my config files. For instance, the bootstrap found in [[file:bootstrap.org][bootstrap.org]] exports almost all of its code snippets to -[[file:.config/yadm/bootstrap][.config/yadm/bootstrap]] thanks to =M-x org-babel-tangle= from within -Emacs. Below I will also present and comment some of my short config -files which do not deserve to have a full org file dedicated to them. +~$HOME/.config/yadm/bootstrap~ thanks to =M-x org-babel-tangle= from +within Emacs. Below I will also present and comment some of my short +config files which do not deserve to have a full org file dedicated to +them. ** Tiling Window Managers :PROPERTIES: @@ -73,14 +74,14 @@ AwesomeWM is the TWM I used for quite some time after switching from i3. This is an automatic tiling window manager written and configured mostly in Lua, with its core written in C (this is originally a dwm fork). My configuration for it is documented in detail in its -corresponding document, which you can find [[file:awesome.org][here]]. +corresponding document, which you can find [[file:Deprecated/awesome.org][here]]. *** i3 configuration (Deprecated) :PROPERTIES: :CUSTOM_ID: Features-Tiling_Window_Managers-i3_configuration-9c92e43c :END: The i3 configuration is detailed in its corresponding README which you -can find [[file:i3.org][here]]. Be aware I do not use i3 anymore, and I will not update +can find [[file:Deprecated/i3.org][here]]. Be aware I do not use i3 anymore, and I will not update it until I may someday use it again. This was deprecated on August 22nd, 2020. @@ -88,9 +89,9 @@ it until I may someday use it again. This was deprecated on August :PROPERTIES: :CUSTOM_ID: Features-Polybar_config_(Deprecated)-c8f95774 :END: -My annotated polybar config can be found [[file:polybar.org][here]], if you wish to use it. Be aware I -do not use polybar anymore, and I will not update it until I may someday use it -again. This was deprecated on August 22nd, 2020. +My annotated polybar config can be found [[file:Deprecated/polybar.org][here]], if you wish to use it. +Be aware I do not use polybar anymore, and I will not update it until +I may someday use it again. This was deprecated on August 22nd, 2020. ** Text and source code editing :PROPERTIES: @@ -118,9 +119,9 @@ on October 20th 2021. You can find it [[file:Deprecated/spacemacs.org][here]]. :CUSTOM_ID: Features-Text_and_source_code_editing-Nano-a9d4839f :END: Although it is a very simple piece of software, nano does offer some -customization. Mine can be found in my [[file:~/org/config-website/nano.org][nano.org]] file. Be aware I do not use nano -anymore, and I will not update it until I may someday use it again. This was -deprecated on August 28th, 2020. +customization. Mine can be found in my [[file:Deprecated/nano.org][nano.org]] file. Be aware I do +not use nano anymore, and I will not update it until I may someday use +it again. This was deprecated on August 28th, 2020. *** Rustfmt :PROPERTIES: @@ -147,8 +148,8 @@ their source code once the org-mode file gets tangled. :PROPERTIES: :CUSTOM_ID: Features-Fish_configuration_with_useful_abbreviations-c71ffba0 :END: -You can also find in my Fish shell configuration in my [[file:~/org/config-website/fish.org][fish.org]] file, which -contains my usual abbreviations. +You can also find in my Fish shell configuration in my [[file:fish.org][fish.org]] file, +which contains my usual abbreviations. *** Tmux configuration :PROPERTIES: @@ -166,17 +167,17 @@ You can find my tmux configuration in [[file:tmux.org][tmux.org]]. It depends on :HEADER-ARGS: :mkdirp yes :tangle ~/.gitignore_global :CUSTOM_ID: Features-And_some_minor_configuration_files-Global_gitignore-42467108 :END: -Sometimes, there are some lines that always reappear in gitignores. So, instead -of always adding them, let git now that some elements are to be ignored by -default, hence the [[file:.gitignore_global][~/.gitignore_global]] file. First, we don’t want nano’s backup -files. -#+BEGIN_SRC text -~* +Sometimes, there are some lines that always reappear in gitignores. +So, instead of always adding them, let git now that some elements are +to be ignored by default, hence the ~$HOME/.gitignore_global~ file. +First, we don’t want nano’s backup files. +#+BEGIN_SRC fundamental +,*~ #+END_SRC And object files and output binaries generated by =gcc= and the likes aren’t welcome either. -#+BEGIN_SRC text +#+BEGIN_SRC fundamental ,*.out ,*.o #+END_SRC @@ -218,12 +219,12 @@ out my [[file:bootstrap.org][bootstrap]] file where I walk you through the first and through the bootstrap you can execute to automatically take care of a lot of elements. -* Licence +* License :PROPERTIES: -:CUSTOM_ID: Licence-48911096 +:CUSTOM_ID: License-48911096 :END: -All of my dotfiles (and my dotfiles only) are available under the GNU GPLv3 -Licence. Please consult [[file:LICENCE.md]] for more information. In short: you are -free to access, edit and redistribute all of my dotfiles under the same licence -and as allowed by the licence, and if you fuck up something, it’s your own -responsibility. +All of my dotfiles (and my dotfiles only) are available under the GNU +GPLv3 License. Please consult [[https://labs.phundrak.com/phundrak/dotfiles/src/branch/master/LICENSE.md][the license file]] for more information. +In short: you are free to access, edit and redistribute all of my +dotfiles under the same license and as allowed by the license, and if +you fuck up something, it’s your own responsibility. diff --git a/org/config/neofetch.org b/org/config/neofetch.org index cdfab1e..fe2bd17 100644 --- a/org/config/neofetch.org +++ b/org/config/neofetch.org @@ -5,7 +5,8 @@ #+HTML_HEAD_EXTRA: #+HTML_HEAD_EXTRA: #+PROPERTY: header-args :noweb yes :exports code :tangle no :exports none -#+PROPERTY: header-args:sh :tangle ~/.config/neofetch/config.conf :exports code :noweb yes :padline no :mkdir yes +#+PROPERTY: header-args:sh :tangle ~/.config/neofetch/config.conf :exports code +#+PROPERTY: header-args:sh+ :noweb yes :padline no :mkdirp yes * Introduction :PROPERTIES: diff --git a/org/config/picom.org b/org/config/picom.org index 46064ba..95ca4dd 100644 --- a/org/config/picom.org +++ b/org/config/picom.org @@ -1,5 +1,6 @@ #+title: Picom (Compton) Configuration #+setupfile: headers +#+OPTIONS: auto-id:t #+HTML_HEAD_EXTRA: #+HTML_HEAD_EXTRA: #+HTML_HEAD_EXTRA: diff --git a/org/config/stumpwm.org b/org/config/stumpwm.org index 5f97d8e..8e1f083 100644 --- a/org/config/stumpwm.org +++ b/org/config/stumpwm.org @@ -18,7 +18,7 @@ :END: [[https://stumpwm.github.io/][StumpWM]] is a tiling window manager inheriting from [[http://www.nongnu.org/ratpoison/][RatPoison]], written entirely in [[https://common-lisp.net/][Common Lisp]] and compiled with [[http://www.sbcl.org/][SBCL]]. While it is not an -dynamic tiling window manager like [[file:awesome.org][Awesome]] is, its ability of managing +dynamic tiling window manager like [[file:Deprecated/awesome.org][Awesome]] is, its ability of managing windows in frames and using keychords with keymaps like Emacs does is a huge plus for me, not to mention the fact its configuration file is written in Common Lisp, a general programming language, a bit like @@ -169,7 +169,7 @@ Now, we’ll load a couple of my custom files that will be described below: | modeline.lisp | #+name: gen-load-files -#+headers: :wrap src lisp +#+header: :wrap src lisp #+begin_src emacs-lisp :var files=first-loaded-files (mapconcat (lambda (file) (format "(load \"~/.stumpwm.d/%s\")" (car file))) @@ -219,7 +219,7 @@ including a short description of what they are for: | urgentwindows | Get urgent windows | #+name: gen-load-modules -#+headers: :wrap src lisp +#+header: :wrap src lisp #+begin_src emacs-lisp :var modules=loaded-modules (mapconcat (lambda (module) (format "(load-module \"%s\")" (car module))) @@ -332,7 +332,7 @@ I’ll prefix the variables’ name with ~phundrak-~ just in case it might conflict with another package I might use in the future, so the CLisp code looks like so: #+name: gen-colors -#+headers: :wrap src lisp +#+header: :wrap src lisp #+begin_src emacs-lisp :var colors=nord-colors (mapconcat (lambda (color) (format "(defvar phundrak-%s \"%s\")" (car color) (cadr color))) @@ -452,7 +452,7 @@ Here are some modules that we will load for the modeline: | wifi | Display information about Wifi connectivity | #+name: gen-load-modeline-modules -#+headers: :wrap src lisp +#+header: :wrap src lisp #+begin_src emacs-lisp :var modules=modeline-modules (mapconcat (lambda (module) (format "(load-module \"%s\")" (car module))) @@ -601,7 +601,7 @@ is the list of groups I will be using: | [FILES] | 3 | Nemo | | #+name: gen-groups -#+headers: :exports none +#+header: :exports none #+begin_src emacs-lisp :var groups=list-groups (let ((make-group (lambda (group &optional first-p) (let ((group-name (car group)) @@ -645,7 +645,7 @@ As you can see in the table [[list-groups]] above, I also indicated my window placement preferences. For now, they all rely on the window’s class, so it will be pretty straightforward to the corresponding code. #+name: gen-rules -#+headers: :wrap src lisp +#+header: :wrap src lisp #+begin_src emacs-lisp :var rules=list-groups (require 'seq) (let ((output "") @@ -753,7 +753,7 @@ list of fonts I want loaded: | Siji | Medium | 10 | #+name: gen-fonts -#+headers: :wrap src lisp +#+header: :wrap src lisp #+begin_src emacs-lisp :var fonts=list-fonts (format "(set-font `(%s))" (mapconcat (lambda (font)