diff options
Diffstat (limited to '_log/_site/suckless-software.html')
| -rw-r--r-- | _log/_site/suckless-software.html | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/_log/_site/suckless-software.html b/_log/_site/suckless-software.html new file mode 100644 index 0000000..d91ed16 --- /dev/null +++ b/_log/_site/suckless-software.html @@ -0,0 +1,78 @@ +<p>Since <a href="https://suckless.org/" class="external" target="_blank" rel="noopener noreferrer">suckless</a> software requires users to modify the +source code and recompile to customize, I need a way to maintain patches over +the long term while retaining the ability to upgrade the software as new +versions are released.</p> + +<h2 id="initial-setup">Initial setup</h2> + +<p>When using a suckless program, I usually begin by cloning the project and +setting the remote push URL to my own git repository:</p> + +<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>git clone git://git.suckless.org/dwm +git reset --hard <tag> +git remote set-url --push origin git@git.asciimx.com:/repos/dwm +</code></pre></div></div> + +<p>This way, I can pull updates from the upstream project whenever I want, while +committing my changes to my git repository. The git reset command aligns my +branch head with a stable release before applying patches or installing the +software.</p> + +<p>If all I want to do is reconfigure the software (e.g., change key bindings), +which is what I need most of the time, the recommended approach is to modify +the config.h file. If the config.h isn’t yet in the project, the +<code class="language-plaintext highlighter-rouge">make clean <target></code> command will generate it from the defaults and compile +the software. The <code class="language-plaintext highlighter-rouge"><target></code> is the name of the application (e.g., dwm) found +in the Makefile. I modify the resulting config.h file and run <code class="language-plaintext highlighter-rouge">make clean +install</code> to install the software before committing and pushing my changes to +the git repo.</p> + +<h2 id="dwm-and-slstatus">dwm and slstatus</h2> + +<p>Since dwm and slstatus are always running, <code class="language-plaintext highlighter-rouge">make install</code> will likely fail for +them. The operating system may prevent the installer from replacing running +executables with new ones. Hence, we must first stop the running instances of +these programs (in my case, using Mod + Shift + q). Then, switch to a tty +(Ctrl + Alt + F1), log in, and change the directory to where dwm/slstatus is. +We can run <code class="language-plaintext highlighter-rouge">make install</code> to install the software and switch back to the +graphical session (Ctrl + Alt + F5).</p> + +<p>The key combinations for switching to the tty and back may differ across +systems. The ones listed above are for OpenBSD.</p> + +<h2 id="subsequent-upgrades">Subsequent upgrades</h2> + +<p>When suckless releases a new version, I run <code class="language-plaintext highlighter-rouge">git pull --rebase</code> to fetch the +upstream changes and rebase my patches on top of them. Because I tend to use +stable versions, I perform another interactive rebase to drop the commits +between the latest stable version tag and my patch before installing the +software.</p> + +<p>Commit log before upgrading:</p> + +<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>dt236 My patch. +3fkdf Version 6.5. +</code></pre></div></div> + +<p>Commit log after pulling:</p> + +<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>w467d My patch. +gh25g A commit. +g525g Another commit. +3fkdf Version 6.6. +vd425 Old commit. +q12vu Another old commit. +3fkdf Version 6.5. +</code></pre></div></div> + +<p>Commit log after the interactive rebase:</p> + +<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>h57jh My patch. +3fkdf Version 6.6. +vd425 Old commit. +q12vu Another old commit. +3fkdf Version 6.5. +</code></pre></div></div> + +<p>And finally, I commit and push all the changes to my git repository.</p> + |