diff --git a/.github/.envrc b/.github/.envrc new file mode 100644 index 0000000..3550a30 --- /dev/null +++ b/.github/.envrc @@ -0,0 +1 @@ +use flake diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..65d1fe9 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +# This is the bootstrap solution. It will live for approximately a year. +github: positron-solutions diff --git a/.github/flake.lock b/.github/flake.lock new file mode 100644 index 0000000..844e1a6 --- /dev/null +++ b/.github/flake.lock @@ -0,0 +1,84 @@ +{ + "nodes": { + "emacs-overlay": { + "inputs": { + "flake-utils": [ + "flake-utils" + ], + "nixpkgs": [ + "nixpkgs" + ], + "nixpkgs-stable": "nixpkgs-stable" + }, + "locked": { + "lastModified": 1697769700, + "narHash": "sha256-ox9E90lRTKim6rb92kOfvqed+0jOmqgKpsAItsVdGdk=", + "owner": "nix-community", + "repo": "emacs-overlay", + "rev": "7e236c963a46bc712971f9f6ff78f4ea50b64c0f", + "type": "github" + }, + "original": { + "owner": "nix-community", + "repo": "emacs-overlay", + "type": "github" + } + }, + "flake-utils": { + "locked": { + "lastModified": 1653893745, + "narHash": "sha256-0jntwV3Z8//YwuOjzhV2sgJJPt+HY6KhU7VZUL0fKZQ=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "1ed9fb1935d260de5fe1c2f7ee0ebaae17ed2fa1", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1688392541, + "narHash": "sha256-lHrKvEkCPTUO+7tPfjIcb7Trk6k31rz18vkyqmkeJfY=", + "owner": "nixos", + "repo": "nixpkgs", + "rev": "ea4c80b39be4c09702b0cb3b42eab59e2ba4f24b", + "type": "github" + }, + "original": { + "owner": "nixos", + "ref": "release-22.11", + "repo": "nixpkgs", + "type": "github" + } + }, + "nixpkgs-stable": { + "locked": { + "lastModified": 1697655685, + "narHash": "sha256-79Kuv+QdgsVc+rkibuAgWHnh8IXrLBTOKg5nM0Qvux0=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "80c1aab725151632ddc2a20caeb914e76dd0673c", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "nixos-23.05", + "repo": "nixpkgs", + "type": "github" + } + }, + "root": { + "inputs": { + "emacs-overlay": "emacs-overlay", + "flake-utils": "flake-utils", + "nixpkgs": "nixpkgs" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/.github/flake.nix b/.github/flake.nix new file mode 100644 index 0000000..4199589 --- /dev/null +++ b/.github/flake.nix @@ -0,0 +1,114 @@ +# Copyright (C) 2022 Positron Solutions + +# Permission is hereby granted, free of charge, to any person obtaining a copy of +# this software and associated documentation files (the "Software"), to deal in +# the Software without restriction, including without limitation the rights to +# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +# the Software, and to permit persons to whom the Software is furnished to do so, +# subject to the following conditions: + +# The above copyright notice and this permission notice shall be included in all +# copies or substantial portions of the Software. + +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +{ + description = "This flake provides CI & local development dependencies"; + + # inputs are pinned via flake.lock. The normal way to update an individual + # version is: + # nix flake lock --update-input emacs-overlay + # Tracking can be accomplished via CI and machine commits + inputs = { + # stable branches are recommended for CI, regression spotting. Testing with + # multiple versions can be done via input overrides, such as: + # nix build .#ci --override-input nixpkgs github:nixpkgs/nixpkgs/unstable + nixpkgs.url = "github:nixos/nixpkgs?ref=release-22.11"; + flake-utils.url = "github:numtide/flake-utils"; + emacs-overlay.url = "github:nix-community/emacs-overlay"; + # slave Emacs overlay to our nixpkgs. This doesn't do a lot except reduce + # the closure size and allow us to control both nixpkgs versions with one + # declaration. + emacs-overlay.inputs.nixpkgs.follows = "nixpkgs"; + emacs-overlay.inputs.flake-utils.follows = "flake-utils"; + }; + + outputs = inputs: + with inputs; + flake-utils.lib.eachDefaultSystem (system: + let + + # instantaite nixpkgs with the emacs overlay applied. + pkgs = import nixpkgs { + inherit system; + overlays = [ emacs-overlay.overlay ]; + }; + + # List of Emacsen to generate development shells for. + emacsPackages = [ + "emacs-unstable" + "emacs-git" + "emacs28" + "emacs29" + "emacs" + ]; + # To explore available attributes, you can instantiate nixpkgs with the emacs overlay in a nix repl: + # pkgs = import (builtins.getFlake "nixpkgs") { system = builtins.currentSystem; overlays = [ (builtins.getFlake ("emacs-overlay")).overlay ];} + # pkgs.emacs will tab complete. pkgs.emacs.version etc describe what's inside. + + # let's have a development shell per Emacs! + devShells = pkgs.lib.genAttrs emacsPackages (emacsPkg: + pkgs.mkShell { + packages = [ + # pkgs, contains many dependencies you can provide to your elisp + # programs. Search for packages here: + # https://search.nixos.org/packages + + # pkgs.git + + # https://github.com/nix-community/emacs-overlay + # The emacs overlay provides up-to-date snapshots of Melpa packages. + # These will be pure & pinned, so you need to update the flake lock + # or use appropriate options. + # + # This expression builds an Emacs that loads the packages passed + # to emacsWithPackages on startup. + ((pkgs.emacsPackagesFor pkgs.${emacsPkg}).emacsWithPackages + (epkgs: [ + # List your project's dependencies here: + # epkgs.melpaPackages.dash + # epkgs.melpaStablePackages.dash + # epkgs.elpaPackages.dash + # epkgs.dash + + # Development dependencies + epkgs.elpaPackages.relint + epkgs.melpaPackages.elisp-lint + # epkgs.melpaPackages.buttercup # XXX finish after #218 on buttercup + # epkgs.melpaPackages.elsa # XXX did not work out of the box + + + # Optionally override derivations. + # epkgs.melpaPackages.weechat.overrideAttrs(old: { + # # probably you want to override the src attribute + # patches = [ ./weechat-el.patch ]; + # }) + ])) + ]; + }); + in { + # The output set, where all useful things go. If your nix flake exposes + # packages, overlays, shells, or nix utils, they can be exposed here for + # downstream consumption. + + # Augment the devShells with a default so that `nix develop` knows what + # to do. Run `nix flake show` to see the results. Per-system, + # per-Emacs, we have a development environment avaialble. + devShells = devShells // { default = devShells.emacs-git; }; + }); +} diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..1c6de88 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,32 @@ +## Pull Requests + +**Generated** changes to the documentation and flake.lock should be kept in a +separate commit for the reviewer. Title your commit as "generated". + +Keeping these changes isolated in specific commits makes it much easier to pull +in your changes in parallel with other features. + +Maintainers may harvest your changes. We only guarantee to preserve authorship, +signature, and sign-off in the git log. + +### Creating pull requests + +1. Fork this repository into the personal GitHub account +1. Make changes on the personal fork +1. Remember to sign off and sign all commits in your PR branch (instructions in readme) +1. Make a Pull Request against this repository +1. **Allow maintainers to make changes to your pull request** (there's a + checkbox) +1. Once the pull request has been approved, you will be thanked and observe your + changes applied with authorship, signature, and sign-off in the git log + +### Reminder about PR access to upstream CI + +Pull-requests run with the `pull_request_target` Github Actions configuration. +Your PR can access secrets, but it run's the **upstream's** CI, not the CI +changes you are submitting. + +If you need to make changes to CI itself in order to pass checks, you will need +to work with the repository's owner. The owner will pull the branch into a +non-master branch. There, they can trigger the CI manually with the branch's +own configuration using `workflow_dispatch` in the Actions tab. diff --git a/.github/run-shim.el b/.github/run-shim.el new file mode 100644 index 0000000..6f91ea6 --- /dev/null +++ b/.github/run-shim.el @@ -0,0 +1,203 @@ +;;; run-shim.el --- -*-no-byte-compile: t; lexical-binding: t -*- + +;; Copyright (C) 2022 Psionic K + +;; Author: Psionic K + +;; Permission is hereby granted, free of charge, to any person obtaining a copy of +;; this software and associated documentation files (the "Software"), to deal in +;; the Software without restriction, including without limitation the rights to +;; use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +;; the Software, and to permit persons to whom the Software is furnished to do so, +;; subject to the following conditions: + +;; The above copyright notice and this permission notice shall be included in all +;; copies or substantial portions of the Software. + +;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +;; IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +;; FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +;; COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +;; IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +;; CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +;;; Commentary: + +;; This package sets up load paths and then loads the test files and runs +;; commands depending on the command line arguments. +;; +;; Usage: +;; +;; Always get a fresh Emacs for your test runs. It will reload features and +;; byte compile where necessary. The Emacs provided by the nix develop shell +;; contains the dependencies declared in the flake.nix. +;; +;; nix develop .github# +;; "emacs" --quick --script .github/run-shim.el -- test +;; "emacs" --quick --script .github/run-shim.el -- lint +;; "emacs" --quick --script .github/run-shim.el -- lint-tests +;; +;; Note that this elisp script assumes that some packages are located in +;; specific locations. + +;;; Code: + +(defun run-shim () + "Execute a CI process based on CLI arguments." + (run-shim-setup) + + ;; Consume the command argument and run one of the routines Additional + ;; arguments can be read as needed in sub-commands. + + ;; Modify this hunk to change your CI steps. + (pcase (pop argv) + ("test" + (require 'scratch-pkgs-test) + (ert-run-tests-batch-and-exit)) + ("lint" + (run-shim-lint-package)) + ("lint-tests" + (run-shim-lint-tests)) + (_ + (message "Command %s not recognized. Use test, lint, lint-tests etc." + run-shim-command)))) + +(defun run-shim-lint-package () + "Lint the files in the package directory." + (require 'elisp-lint) + ;; 100-character column limit for lints. If it's good enough for Linux, it's + ;; good enough for us. https://lkml.org/lkml/2020/5/29/1038 + (setq-default fill-column 100) + ;; Spaces + (setq-default indent-tabs-mode nil) + + ;; `command-line-args-left has the same effect as passing command line arguments. + (let ((command-line-args-left + (append + '(;; "--no- + ;; "--no-byte-compile" + ;; "--no-checkdoc" + ;; "--no-package-lint" + ;; "--no-indent" + ;; "--no-indent-character" + ;; "--no-fill-column" + ;; "--no-trailing-whitespace" + ;; "--no-check-declare" + ) + (seq-filter + (lambda (s) (not (or (string-match-p "*-test.el$" s) + (string-match-p ".*autoloads.*.el$" s)))) + (file-expand-wildcards + (if (file-exists-p "lisp/") "lisp/*.el" + "*.el")))))) + + (message "ARGS: %s" command-line-args-left) + + ;; (setq elisp-lint-ignored-validators nil + ;; elisp-lint-file-validators nil + ;; elisp-lint-buffer-validators nil + ;; elisp-lint-batch-files nil) + + (elisp-lint-files-batch))) + +(defun run-shim-lint-tests () + "Lint the files in the test directory." + + (require 'elisp-lint) + + ;; Use this file's directory as default directory so that lisp file locations + ;; are fixed with respect to this file. + + ;; 100-character column limit for lints. If it's good enough for Linux, it's + ;; good enough for us. https://lkml.org/lkml/2020/5/29/1038 + (setq-default fill-column 100) + ;; Spaces + (setq-default indent-tabs-mode nil) + + ;; `command-line-args-left has the same effect as passing command line arguments. + (let ((command-line-args-left + (append + '(;; "--no- + ;; "--no-byte-compile" + "--no-checkdoc" + "--no-package-lint" + ;; "--no-indent" + ;; "--no-indent-character" + ;; "--no-fill-column" + ;; "--no-trailing-whitespace" + ;; "--no-check-declare" + ) + (seq-filter + (lambda (s) (string-match-p "*-test.el$" s)) + (file-expand-wildcards + (if (file-exists-p "test/") "test/*.el" + "*-test.el")))))) + + (message "ARGS: %s" command-line-args-left) + + ;; (setq elisp-lint-ignored-validators nil + ;; elisp-lint-file-validators nil + ;; elisp-lint-buffer-validators nil + ;; elisp-lint-batch-files nil) + + (elisp-lint-files-batch))) + +(defun run-shim-compile-dir-recursively (dir) + "Compile .el files in DIR. +This is usually before loading for tests etc. The behavior of +byte compiled and native compiled code is more interesting than +uncompiled elisp because usually installed packages will be +compiled when run by the user." + (mapc (if (native-comp-available-p) #'native-compile + #'byte-compile-file) + (directory-files-recursively dir (rx ".el" eol)))) + +(defun run-shim-setup () + "Normalize load paths, compilation, and behavior of shell arguments. +The `default-directory' will be set to the root of the +repository. Arguments will be stripped of Nix wrapper load +paths. The load path will be configured to included /test, +/load, and the repository root. Elisp files on the load path +will be compiled, natively if available." + + ;; This expression normalizes the behavior of --quick --load and --script + ;; behavior. If you don't do this, --script will see every argument + ;; passed and the arguments from the Nix wrapper to set load paths. You can use + ;; this to pass extra options to your scripts in the github actions. + (when (member (car argv) '("-l" "--")) + (print "Normalizing arguments") + (while (not (member (car argv) '("--" nil))) + (print (format "Normalizing arguments, stripped: %s" (pop argv)))) + (pop argv)) ; pop the sentinel "--" + + (message "original default directory: %s" default-directory) + (let* ((root-directory (if load-file-name + (file-name-directory + (directory-file-name + (file-name-directory load-file-name))) + (file-name-directory + (directory-file-name + default-directory)))) + (test-dir (concat root-directory "test")) + (lisp-dir (concat root-directory "lisp")) + (package-dir (if (file-exists-p lisp-dir) lisp-dir + root-directory))) + (message "load-file-name for run-shim.el: %s" load-file-name) + (message "root load path: %s" root-directory) + (when (file-exists-p test-dir) + (message (format "test load path: %s" test-dir)) + (push test-dir load-path)) + (message (format "package load path: %s" root-directory)) + (push package-dir load-path) + (setq default-directory root-directory)) + + ;; running manually may encounter stale .elc + (setq load-prefer-newer t)) + +;; Only attempt to run when Emacs is loading with or --batch --no-x-resources, +;; which is implied by -Q. +(when (or noninteractive inhibit-x-resources) + (run-shim)) + +(provide 'run-shim) +;;; run-shim.el ends here diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..2977866 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,116 @@ +# Copyright (C) 2022 Positron Solutions + +# Permission is hereby granted, free of charge, to any person obtaining a copy of +# this software and associated documentation files (the "Software"), to deal in +# the Software without restriction, including without limitation the rights to +# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +# the Software, and to permit persons to whom the Software is furnished to do so, +# subject to the following conditions: + +# The above copyright notice and this permission notice shall be included in all +# copies or substantial portions of the Software. + +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +name: CI + +on: # trigger this workflow on + push: + branches: [ $default-branch ] # pushes to the default branch + paths-ignore: + - 'README.org' + - 'CONTRIBUTING.org' + pull_request_target: # or every pull request, from any branch to any branch + paths-ignore: + - 'README.org' + - 'CONTRIBUTING.org' + + workflow_dispatch: + # Allows you to run this workflow manually from the Actions tab + +jobs: + continuous-integration: # just a job name + + # Run on every OS and Emacsen + # Some steps switch logic on os or emacsPkg! + strategy: + matrix: + os: [ubuntu-latest, macos-latest] + emacsPkg: [ emacs, emacs-git, ] + runs-on: ${{ matrix.os }} + # If you update steps, be sure to update the approved actions list in the + # manual and in your repositories! + steps: + - uses: actions/checkout@v3.2.0 + with: + ref: ${{ github.event.pull_request.head.sha }} + - uses: cachix/install-nix-action@v22 + with: + extra_nix_config: | + access-tokens = github.com=${{ secrets.GITHUB_TOKEN }} + - uses: cachix/cachix-action@v12 + with: + # This CACHIX_AUTH_TOKEN & CACHIX_CACHE_NAME are secrets you must set + # in your repository settings + name: ${{ secrets.CACHIX_CACHE_NAME }} + authToken: ${{ secrets.CACHIX_AUTH_TOKEN }} + extraPullNames: nix-community # look for pre-built binaries from upstream + # Some paths may confuse cachix. Add them with a pipe to the pushFilter + pushFilter: "(.drv.chroot$)" + + # Loading the development shell with frozen versions is important to + # verify that any flake commands will successfully run straight off of the + # github repository. + - name: load the shell with frozen versions + run: nix develop .github#${{ matrix.emacsPkg }} --ignore-environment --command "emacs" "--version" + + # Linting the package is less useful on multiple version. Modify the + # logic if you wish to expand lint coverage. + - name: lint package + if: matrix.emacsPkg == 'emacs' && matrix.os == 'ubuntu-latest' + run: | + eval "$(nix print-dev-env \ + --override-input nixpkgs github:nixos/nixpkgs/release-22.11 \ + --update-input emacs-overlay \ + .github#${{ matrix.emacsPkg }})" + + # Lint the package + emacs --script .github/run-shim.el -- lint + + # Lint the tests + emacs --script .github/run-shim.el -- lint-tests + + - name: run tests + run: | + # First load the shell. Updating inputs will update the view of ELPA + # Emacs git, and nixpkgs. + + # Possible RUNNER_OS values: Windows Linux MacOS + # https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables + + # These eval "$(nix print-dev-env)" calls alter the shell. In a + # non-interactive shell like CI, calling nix develop doesn't have the + # same behavior. + if [[ $RUNNER_OS == Linux ]]; then + eval "$(nix print-dev-env \ + --override-input nixpkgs github:nixos/nixpkgs/release-22.11 \ + --update-input emacs-overlay \ + .github#${{ matrix.emacsPkg }})" + + else + eval "$(nix print-dev-env \ + --override-input nixpkgs github:nixos/nixpkgs/nixpkgs-22.11-darwin \ + --update-input emacs-overlay \ + .github#${{ matrix.emacsPkg }})" + fi + + # Runs the tests in a graphical window (can freeze) + # emacs --quick --load .github/run-shim.el -- test $GITHUB_SHA + + # Run tests with terminal output and no graphical window + emacs --script .github/run-shim.el -- test $GITHUB_SHA diff --git a/.github/workflows/dco.yml b/.github/workflows/dco.yml new file mode 100644 index 0000000..f717b92 --- /dev/null +++ b/.github/workflows/dco.yml @@ -0,0 +1,51 @@ +# Copyright (C) 2022 Positron Solutions + +# Permission is hereby granted, free of charge, to any person obtaining a copy of +# this software and associated documentation files (the "Software"), to deal in +# the Software without restriction, including without limitation the rights to +# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +# the Software, and to permit persons to whom the Software is furnished to do so, +# subject to the following conditions: + +# The above copyright notice and this permission notice shall be included in all +# copies or substantial portions of the Software. + +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +# This Developer Certificate of Origin check verifies that all commits in a PR +# are signed off on by the author. It only needs to run once on each PR +# update. +# +# The check is added as a shield to the project's README.org so that all can see +# the license check for the entire commit history. + +name: DCO Check + +on: + pull_request: + # any pull-request + workflow_dispatch: + # Allows you to run this workflow manually from the Actions tab + push: + branches: + - master +jobs: + check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3.2.0 + - name: Set up Python 3.10 + uses: actions/setup-python@v4 + with: + python-version: '3.10' + - name: Check DCO + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + pip3 install -U dco-check==0.3.1 + dco-check diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e05ebcd --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +**.direnv/ +**.elc +***autoloads.el +**trash +**~ +**.~undo-tree +/doc/*.info \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b7312ab --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,261 @@ + + +Development process & infrastructure guide. + + +# Table of Contents + +- [Development](#org83d1291) + - [Running tests](#org6fc1d97) + - [Lint and byte-compile code](#orgc34e59f) + - [Loading and re-loading your package](#orgf424ad0) + - [Re-generating Documentation](#org08f62a4) +- [License](#org341535c) +- [Developer Certificate of Origin (DCO)](#org12add76) + - [Sign-off](#org7f1f6d1) + - [GPG signature](#orge1ebcad) + - [User setup for submitting changes](#orga724bae) + - [Maintaining versions](#org273f042) + + + + +# Development + +This repository was created with [elisp-repo-kit](https://github.com/positron-solutions/elisp-repo-kit/). You can use it to streamline +development workflows. + + + + +## Running tests + +Run `erk-ert-project` within this project. The tests will be +discovered, rebuilt & reloaded if necessary, and run. There are a +few other commands to augment the [ert](https://www.gnu.org/software/emacs/manual/html_node/ert/) package. + + +### Running tests CI style + +If you cannot reproduce a failure (or success) on CI, then you may +want to switch to using [nix](https://nixos.org/download.html) to get a reprodicible toolchain so you +can further develop with frozen versions from the nix [flake's](https://nixos.wiki/wiki/Flakes) +flake.lock. + + + nix develop .github# # loads the devShells.default from flake.nix + cd .github && direnv allow # same as above with file watching + + emacs --quick --load .github/run-shim.el -- test # graphical + emacs --script .github/run-test.el -- test # terminal, batch style + +You can *totally* run the tests locally on whatever version of Emacs you +have. **You do not need Nix to run tests pretty close to what CI does.** CI +will use Nix to obtain Emacs & dependencies. + + + + +## Lint and byte-compile code + +This package uses [elisp-lint](https://github.com/gonewest818/elisp-lint) to detect issues with byte compiling, package +format, code structure and others. + +The configuration is found inside [.github/run-shim.el](../.github/run-shim.el). The CI run is invoked +inside of [ci.yml](../.github/workflows/ci.yml) using Emacs in script mode. Most of the configuration is in +the run shim. + +The tests are also linted, to a less restrictive standard, also found in +[run-shim.el](../.github/run-shim.el) + +You can run the lints manually almost the same as running tests. + + + nix develop .github# + # nix develop .#emacs28 + # nix develop .#emacsGit + emacs --script .github/run-shim.el -- lint + emacs --script .github/run-shim.el -- lint-tests + + + + +## Loading and re-loading your package + +Run `erk-reload-package` in one of your project files. All features +in the /lisp directory will be re-compiled and loaded appropriately. + +**Note**, during reloading, unloading the current module is forced. If other +packages you use depend on the project feature, results may be unpredicatable. +This is one reason batch style testing can be preferred. + + +### Manual Loading & Reloading + +To manually unload, run built-in command `unload-feature` and select your +package name. If you do not unload, reloading has no effect and you will see +stale behavior. + +Next, add the package to your load-path and then require it or, more +directly, call `emacs-lisp-byte-compile-and-load` or +`emacs-lisp-native-compile-and-load`. + + + + +## Re-generating Documentation + +If you are using `elisp-repo-kit`, `erk-export-docs` will take care of +everything. See the related commands for exporting individually and +viewing the outputs. If you enable local variables, declared at the end of +each document, saving will automatically export. + +To manually export, use the appropriate org mode command: + +- `org-md-export-as-markdown` +- `org-texinfo-export-to-info` + +You can view the manual with prefix argument, `info-display-manual`, and +manually type the path to the `manual.info`. Honestly, just use +`elisp-repo-kit`. This stuff is tedious. + +**NOTE** changes to the `manual.org` requires re-generation of other documents + because they use `#+include:` directives. + + + + +# License + +This package is distributed under the terms of the [included license](./COPYING). The CI +configuration and scripts are MIT licensed. + + + + +# Developer Certificate of Origin (DCO) + +This project is distributed with a Developer Certificate of Origin. By adding +a sign-off notice and GPG signature to each commit, you will provide means to +authenticate your sign-off later strengthening your attestations stated in the +DCO, upholding the overall integrity of the license coverage over the project. + +A [copy of the DCO](./DCO) is distributed with this project. Read its text to +understand the significance of configuring for sign-off. + + + + +## Sign-off + +A sign-off means adding a "trailer" to your commit that looks like the +following: + + + Signed-off-by: Random J Developer + + + + +## GPG signature + +A GPG signed commit shows that the owner of the private key submitted the +changes. Wherever signatures are recorded in chains, they can demonstrate +participation in changes elsewhere and awareness of what the submitter is +participating in. Corroborating user's signature accross a history of works +strengthens that user's attestation provided by DCO sign-off. + + + + +## User setup for submitting changes + +Follow these instructions before you get ready to submit a pull-request. + +Refer to the [GitHub signing commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) instructions to set up your git client +to add GPG signatures. File issues if you run into Emacs-specific problems. +Be sure to use a Github verified email. + +Because signing is intended to be a conscious process, please remember to +read and understand the [Developer Certificate of Origin](../DCO) before confinguring +your client to automatically sign-off on commits. + + +### Automatically add sign-off + +In magit, set the `-s` switch. Use `C-x C-s` (`transient-save`) to +preserve this switch on future uses. (Note, this is not per-project).You +can also set the signature flag this way. + + +### Automatic GPG signing with per-project keys + +In order to specify which projects you intend to sign with which keys, you +will want to configure your git client using path-specific configurations. + +Configuing git for this can be done with the following directory structure: + + + /home/rjdeveloper/ + ├── .gitconfig + └── .gitconfig.d + ├── sco-linux-projects.conf + ├── other-projects.conf + └── gpg-signing-projects.conf + +In your root config, `.gitconfig`, add an `includeIf` directive that will +load the configuration you use for projects you intend to GPG sign commits +for. + + + [includeIf "gitdir:/home/rjdeveloper/**/gpg-signing/**/.git"] + path = "~/.gitconfig.d/gpg-signing-projects.conf" + +In the `gpg-signing-projects.conf` add your GPG signing configuration from +earlier. `sign` adds the GPG signature automatically. File an issue if you +need help with multiple GPG homes or other configurations. + + + [user] + name = "Random J Developer" + email = "random@developer.example.org" + signingkey = "5FF0EBDC623B3AD4" + + [commit] + sign = true + gpgSign = true + + +### Manually signing & adding sign-off + +If you don't like these configurations and want to individually indicate you +have read and intend to apply the DCO to your changes, these commands are +equivalent: + + git commit -s -S --message "I don't like using .gitconfig" + + # To clean up a commit + git commit --amend -s -S --no-message + + # Combine with rebase to sign / sign-off multiple existing commits + git rebase -i + + + + +## Maintaining versions + +The Nix [flake.nix](../github/flake.nix) is where versions are declared. The [flake.lock](../.github/flake.lock) stores a +fixed value for these declarations. These fixed versions need periodic +update. Nixpkgs has a new release about every six months. You can check +their [branches](https://github.com/NixOS/nixpkgs/branches) and [tags](https://github.com/NixOS/nixpkgs/tags) to see what's current. The effect is similar to +updating linux versions. The `nix` command has a lot of support for +specifying versions besides just updating. + + nix flake lock --update-input nixpkgs + +The `emacs-overlay`, which contains fixed versions of Emacs and snapshots of +Elisp repository package sets can be updated by running: + + nix flake lock --update-input emacs-overlay + diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/DCO b/DCO new file mode 100644 index 0000000..d950df0 --- /dev/null +++ b/DCO @@ -0,0 +1,34 @@ +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..435c59d --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ + + + +CI workflow status +DCO Check + + +# Scratch Packages + +The repository hosting this package was created with [elisp-repo-kit](https://github.com/positron-solutions/elisp-repo-kit). You can +clone and rename it using `erk-new` to quickly get a package set up. + + +# Install Scratch Packages + + ;; update this after you publish your new package! + ;; (use-package scratch-pkgs) ; vanilla, assuming you have MELPA configured + + ;; package-vc + (package-vc-install + '(scratch-pkgs :url "https://github.com/positron-solutions/scratch-pkgs.git" + :lisp-dir "lisp" + :doc "doc/scratch-pkgs.texi")) + + ;; using elpaca's with explicit recipe + (use-package scratch-pkgs + :elpaca (scratch-pkgs :host github :repo "positron-solutions/scratch-pkgs")) + + ;; straight with explicit recipe + (use-package scratch-pkgs + :straight (scratch-pkgs :type git :host github :repo "positron-solutions/scratch-pkgs")) + + ;; or use manual load-path & require, you brave yak shaver + + +# Table of Contents + +- [Contributing](#org2e31983) + + +# Contributing + +Because this repository is created from [elisp-repo-kit](https://github.com/positron-solutions/elisp-repo-kit), please file any issues +or make relevant pull requests there unless the changes are specific to this +repo. + +See the [CONTRIBUTING](./CONTRIBUTING.md) guide for help making changes to this project. + +For turn-key contribution to the software ecosystem that keeps you moving, see +the [funding links](https://github.com/sponsors/positron-solutions). + diff --git a/doc/CONTRIBUTING.org b/doc/CONTRIBUTING.org new file mode 100644 index 0000000..e36b4ec --- /dev/null +++ b/doc/CONTRIBUTING.org @@ -0,0 +1,244 @@ +#+TITLE: Contributing +#+EXPORT_FILE_NAME: ../CONTRIBUTING.md +#+OPTIONS: toc:nil broken-links:mark num:nil + +#+begin_export html + +#+end_export + +Development process & infrastructure guide. + +#+TOC: headlines 2 + +* Development + + This repository was created with [[https://github.com/positron-solutions/elisp-repo-kit/][elisp-repo-kit]]. You can use it to streamline + development workflows. + +** Running tests + + Run =erk-ert-project= within this project. The tests will be + discovered, rebuilt & reloaded if necessary, and run. There are a + few other commands to augment the [[https://www.gnu.org/software/emacs/manual/html_node/ert/][ert]] package. + +*** Running tests CI style + + If you cannot reproduce a failure (or success) on CI, then you may + want to switch to using [[https://nixos.org/download.html][nix]] to get a reprodicible toolchain so you + can further develop with frozen versions from the nix [[https://nixos.wiki/wiki/Flakes][flake's]] + flake.lock. + + #+begin_src bash + + nix develop .github# # loads the devShells.default from flake.nix + cd .github && direnv allow # same as above with file watching + + emacs --quick --load .github/run-shim.el -- test # graphical + emacs --script .github/run-test.el -- test # terminal, batch style + + #+end_src + + You can /totally/ run the tests locally on whatever version of Emacs you + have. *You do not need Nix to run tests pretty close to what CI does.* CI + will use Nix to obtain Emacs & dependencies. + +** Lint and byte-compile code + + This package uses [[https://github.com/gonewest818/elisp-lint][elisp-lint]] to detect issues with byte compiling, package + format, code structure and others. + + The configuration is found inside [[../.github/run-shim.el][.github/run-shim.el]]. The CI run is invoked + inside of [[../.github/workflows/ci.yml][ci.yml]] using Emacs in script mode. Most of the configuration is in + the run shim. + + The tests are also linted, to a less restrictive standard, also found in + [[../.github/run-shim.el][run-shim.el]] + + You can run the lints manually almost the same as running tests. + #+begin_src bash + + nix develop .github# + # nix develop .#emacs28 + # nix develop .#emacsGit + emacs --script .github/run-shim.el -- lint + emacs --script .github/run-shim.el -- lint-tests + + #+end_src + +** Loading and re-loading your package + + Run =erk-reload-package= in one of your project files. All features + in the /lisp directory will be re-compiled and loaded appropriately. + + *Note*, during reloading, unloading the current module is forced. If other + packages you use depend on the project feature, results may be unpredicatable. + This is one reason batch style testing can be preferred. + +*** Manual Loading & Reloading + + To manually unload, run built-in command ~unload-feature~ and select your + package name. If you do not unload, reloading has no effect and you will see + stale behavior. + + Next, add the package to your load-path and then require it or, more + directly, call =emacs-lisp-byte-compile-and-load= or + =emacs-lisp-native-compile-and-load=. +** Re-generating Documentation + If you are using ~elisp-repo-kit~, ~erk-export-docs~ will take care of + everything. See the related commands for exporting individually and + viewing the outputs. If you enable local variables, declared at the end of + each document, saving will automatically export. + + To manually export, use the appropriate org mode command: + + - ~org-md-export-as-markdown~ + - ~org-texinfo-export-to-info~ + + You can view the manual with prefix argument, ~info-display-manual~, and + manually type the path to the ~manual.info~. Honestly, just use + ~elisp-repo-kit~. This stuff is tedious. + + *NOTE* changes to the ~manual.org~ requires re-generation of other documents + because they use =#+include:= directives. +* License + + This package is distributed under the terms of the [[./COPYING][included license]]. The CI + configuration and scripts are MIT licensed. + +* Developer Certificate of Origin (DCO) + + This project is distributed with a Developer Certificate of Origin. By adding + a sign-off notice and GPG signature to each commit, you will provide means to + authenticate your sign-off later strengthening your attestations stated in the + DCO, upholding the overall integrity of the license coverage over the project. + + A [[./DCO][copy of the DCO]] is distributed with this project. Read its text to + understand the significance of configuring for sign-off. + +** Sign-off + + A sign-off means adding a "trailer" to your commit that looks like the + following: + + #+begin_src + + Signed-off-by: Random J Developer + + #+end_src + +** GPG signature + + A GPG signed commit shows that the owner of the private key submitted the + changes. Wherever signatures are recorded in chains, they can demonstrate + participation in changes elsewhere and awareness of what the submitter is + participating in. Corroborating user's signature accross a history of works + strengthens that user's attestation provided by DCO sign-off. + +** User setup for submitting changes + + Follow these instructions before you get ready to submit a pull-request. + + Refer to the [[https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits][GitHub signing commits]] instructions to set up your git client + to add GPG signatures. File issues if you run into Emacs-specific problems. + Be sure to use a Github verified email. + + Because signing is intended to be a conscious process, please remember to + read and understand the [[../DCO][Developer Certificate of Origin]] before confinguring + your client to automatically sign-off on commits. + +*** Automatically add sign-off + + In magit, set the =-s= switch. Use =C-x C-s= (=transient-save=) to + preserve this switch on future uses. (Note, this is not per-project).You + can also set the signature flag this way. + +*** Automatic GPG signing with per-project keys + + In order to specify which projects you intend to sign with which keys, you + will want to configure your git client using path-specific configurations. + + Configuing git for this can be done with the following directory structure: + + #+begin_src + + /home/rjdeveloper/ + ├── .gitconfig + └── .gitconfig.d + ├── sco-linux-projects.conf + ├── other-projects.conf + └── gpg-signing-projects.conf + + #+end_src + + In your root config, ~.gitconfig~, add an =includeIf= directive that will + load the configuration you use for projects you intend to GPG sign commits + for. + + #+begin_src + + [includeIf "gitdir:/home/rjdeveloper/**/gpg-signing/**/.git"] + path = "~/.gitconfig.d/gpg-signing-projects.conf" + + #+end_src + + In the ~gpg-signing-projects.conf~ add your GPG signing configuration from + earlier. =sign= adds the GPG signature automatically. File an issue if you + need help with multiple GPG homes or other configurations. + + #+begin_src + + [user] + name = "Random J Developer" + email = "random@developer.example.org" + signingkey = "5FF0EBDC623B3AD4" + + [commit] + sign = true + gpgSign = true + + #+end_src + +*** Manually signing & adding sign-off + + If you don't like these configurations and want to individually indicate you + have read and intend to apply the DCO to your changes, these commands are + equivalent: + + #+begin_src bash + git commit -s -S --message "I don't like using .gitconfig" + + # To clean up a commit + git commit --amend -s -S --no-message + + # Combine with rebase to sign / sign-off multiple existing commits + git rebase -i + #+end_src + +** Maintaining versions +#+begin_comment +This heading is duplicated in the manual.org. The Contributing guide is +frequently copied around whole because it's not that unique between +repositories using ERK tooling. +#+end_comment + + The Nix [[../github/flake.nix][flake.nix]] is where versions are declared. The [[../.github/flake.lock][flake.lock]] stores a + fixed value for these declarations. These fixed versions need periodic + update. Nixpkgs has a new release about every six months. You can check + their [[https://github.com/NixOS/nixpkgs/branches][branches]] and [[https://github.com/NixOS/nixpkgs/tags][tags]] to see what's current. The effect is similar to + updating linux versions. The ~nix~ command has a lot of support for + specifying versions besides just updating. + + #+begin_src shell + nix flake lock --update-input nixpkgs + #+end_src + + The ~emacs-overlay~, which contains fixed versions of Emacs and snapshots of + Elisp repository package sets can be updated by running: + + #+begin_src shell + nix flake lock --update-input emacs-overlay + #+end_src + +# Local Variables: +# after-save-hook: (lambda () (when (require 'erk nil t) (erk-export-contributing))) +# End: diff --git a/doc/README.org b/doc/README.org new file mode 100644 index 0000000..6148c79 --- /dev/null +++ b/doc/README.org @@ -0,0 +1,50 @@ +#+title: Scratch Packages +#+export_file_name: ../README.md +#+options: toc:nil broken-links:mark num:nil + +#+begin_export html + +#+end_export + +#+begin_export html + +CI workflow status +DCO Check +#+end_export + +* Scratch Packages + :PROPERTIES: + :UNNUMBERED: notoc + :END: +#+include: "manual.org::*Scratch Packages" :only-contents t +* Install + :PROPERTIES: + :UNNUMBERED: notoc + :END: + #+begin_src elisp + ;; package-vc + (package-vc-install + '(scratch-pkgs :url "https://github.com/positron-solutions/scratch-pkgs.git" + :lisp-dir "lisp" + :doc "doc/scratch-pkgs.texi")) + + ;; using elpaca's with explicit recipe + (use-package scratch-pkgs + :elpaca (scratch-pkgs :host github :repo "positron-solutions/scratch-pkgs")) + + ;; straight with explicit recipe + (use-package scratch-pkgs + :straight (scratch-pkgs :type git :host github :repo "positron-solutions/scratch-pkgs")) + + ;; or use manual load-path & require, you brave yak shaver + #+end_src + #+toc: headlines 2 + #+include: "manual.org::*Usage" :minlevel 1 +* Contributing + See the [[./CONTRIBUTING.md][CONTRIBUTING]] guide for help making changes to this project. For + turn-key contribution to the software ecosystem that keeps you moving, see the + [[https://github.com/sponsors/positron-solutions][funding links]]. + +# Local Variables: +# after-save-hook: (lambda () (when (require 'erk nil t) (erk-export-readme))) +# End: diff --git a/doc/manual.org b/doc/manual.org new file mode 100644 index 0000000..997e5a6 --- /dev/null +++ b/doc/manual.org @@ -0,0 +1,82 @@ +#+title: Scratch Packages +#+subtitle: for version {{{package-version}}} +#+author: {{{package-author}}} +#+email: {{{package-email}}} +#+date: 2023-{{{year}}} +#+property: header-args :eval no` +#+options: broken-links:warn \n:nil ::t |:t ^:nil -:t f:t *:t <:t e:t ':t +#+options: d:nil todo:nil pri:nil tags:not-in-toc stat:nil +#+language: en +#+export_file_name: scratch-pkgs.texi +#+texinfo_dir_category: Emacs +#+texinfo_dir_title: Scratch Packages: (scratch-pkgs) +#+texinfo_dir_desc: Create, distribute, and maintain Emacs Lisp packages +#+macro: package-version (eval (if (require 'erk nil t) (erk-package-version) "0.1.0")) +#+macro: package-author (eval (if (require 'erk nil t) (erk-package-author) "Psionic K")) +#+macro: package-email (eval (if (require 'erk nil t) (erk-package-email "contact@positron.solutions"))) +#+macro: year (eval (format-time-string "%Y")) +#+texinfo_header: @comment !!!THIS FILE HAS BEEN GENERATED!!! Edit manual.org instead! + +* Scratch Packages +Create quick packages for personal use in your configuration. A more +light-weight solution than [[https://github.com/positron-solutions/elisp-repo-kit][Elisp Repo Kit]] for quickly developing an idea within +a properly formed package. +** Why You Want This +Compared to using ~ielm~ and ~lisp-interaction-mode~ in regular scratch buffers, +packages support: +- ~byte-compile-and-load~ to quickly reload (and let the compiler detect problems) +- flycheck will work better +- ~edebug~ and ~debug~ +- proper loading, unloading, reloading +- dependency declaration so that ~use-package~ etc can arrange the loading order +- autoloads +I don't recommend ~lisp-interaction~ mode for scratch since packages have a lot of +advantages, org mode is better for persistent literate exploration, and ielm +(especially with history enabled) is better for truly ephemeral expression +building. +* Usage +- Create a new package skeleton with ~scratch-pkgs-new~ +- See existing scratch packages with ~scratch-pkgs~ +** Using Your Package in Your Config +Scratch packages works by: +- Creates and stores packages inside =~/.emacs.d/var/scratch-pkgs/= +- Adds that path to the loading path (see options below ⚠️) +You can then declare with use-package normally: +#+begin_src elisp + (use-package my-scratch-package) +#+end_src +** Load Path +You want at least *one of these* solutions in place to make sure your scratch +packages can be used in your configuration normally. +1. Require scratch packages very early in your configuration, something like this: + #+begin_src elisp + (use-package scratch-pkgs) + (require 'scratch-pkgs) ; this blocks, ensuring your scratch pkg will be in the load path + #+end_src +2. Add an implicit dependency in your ~use-package~ expressions: + #+begin_src elisp + (use-package my-scratch-package + :after scratch-pkgs) + #+end_src +3. Configure the load path manually instead: + #+begin_src elisp + (push load-path "~/.emacs.d/var/scratch-pkgs/") + #+end_src +4. For each package, use the explicit load path option of ~use-package~ + (less convenient, so not recommended): + #+begin_src elisp + (use-package my-scratch-package + :load-path "~/.emacs.d/var/scratch-pkgs/") + #+end_src +See the [[info:emacs#Lisp Libraries][Lisp Libraries]] section of the Emacs manual and [[info:elisp#Loading][Loading]] in the Elisp +manual for more detailed treatment. +* Licensing +:PROPERTIES: +:COPYING: t +:END: + +#+include: "../COPYING" + +# Local Variables: +# after-save-hook: (lambda () (when (require 'erk nil t) (erk-export-docs))) +# End: diff --git a/doc/scratch-pkgs.texi b/doc/scratch-pkgs.texi new file mode 100644 index 0000000..d8a8619 --- /dev/null +++ b/doc/scratch-pkgs.texi @@ -0,0 +1,791 @@ +\input texinfo @c -*- texinfo -*- +@c %**start of header +@setfilename scratch-pkgs.info +@settitle Scratch Packages +@documentencoding UTF-8 +@documentlanguage en +@comment !!!THIS FILE HAS BEEN GENERATED!!! Edit manual.org instead! +@c %**end of header + +@copying +GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. @uref{https://fsf.org/} +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. + +Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + +TERMS AND CONDITIONS + +@enumerate +@item +Definitions. +@end enumerate + +``This License'' refers to version 3 of the GNU General Public License. + + ``Copyright'' also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + ``The Program'' refers to any copyrightable work licensed under this +License. Each licensee is addressed as ``you''. ``Licensees'' and +``recipients'' may be individuals or organizations. + + To ``modify'' a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a ``modified version'' of the +earlier work or a work ``based on'' the earlier work. + + A ``covered work'' means either the unmodified Program or a work based +on the Program. + + To ``propagate'' a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To ``convey'' a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays ``Appropriate Legal Notices'' +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +@enumerate +@item +Source Code. +@end enumerate + + The ``source code'' for a work means the preferred form of the work +for making modifications to it. ``Object code'' means any non-source +form of a work. + + A ``Standard Interface'' means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The ``System Libraries'' of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +``Major Component'', in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The ``Corresponding Source'' for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + +@enumerate +@item +Basic Permissions. +@end enumerate + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + +@enumerate +@item +Protecting Users' Legal Rights From Anti-Circumvention Law. +@end enumerate + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + +@enumerate +@item +Conveying Verbatim Copies. +@end enumerate + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +@enumerate +@item +Conveying Modified Source Versions. +@end enumerate + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + +a) The work must carry prominent notices stating that you modified +it, and giving a relevant date. + +b) The work must carry prominent notices stating that it is +released under this License and any conditions added under section +@enumerate +@item +This requirement modifies the requirement in section 4 to +@end enumerate +``keep intact all notices''. + +c) You must license the entire work, as a whole, under this +License to anyone who comes into possession of a copy. This +License will therefore apply, along with any applicable section 7 +additional terms, to the whole of the work, and all its parts, +regardless of how they are packaged. This License gives no +permission to license the work in any other way, but it does not +invalidate such permission if you have separately received it. + +d) If the work has interactive user interfaces, each must display +Appropriate Legal Notices; however, if the Program has interactive +interfaces that do not display Appropriate Legal Notices, your +work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +``aggregate'' if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +@enumerate +@item +Conveying Non-Source Forms. +@end enumerate + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + +a) Convey the object code in, or embodied in, a physical product +(including a physical distribution medium), accompanied by the +Corresponding Source fixed on a durable physical medium +customarily used for software interchange. + +b) Convey the object code in, or embodied in, a physical product +(including a physical distribution medium), accompanied by a +written offer, valid for at least three years and valid for as +long as you offer spare parts or customer support for that product +model, to give anyone who possesses the object code either (1) a +copy of the Corresponding Source for all the software in the +product that is covered by this License, on a durable physical +medium customarily used for software interchange, for a price no +more than your reasonable cost of physically performing this +conveying of source, or (2) access to copy the +Corresponding Source from a network server at no charge. + +c) Convey individual copies of the object code with a copy of the +written offer to provide the Corresponding Source. This +alternative is allowed only occasionally and noncommercially, and +only if you received the object code with such an offer, in accord +with subsection 6b. + +d) Convey the object code by offering access from a designated +place (gratis or for a charge), and offer equivalent access to the +Corresponding Source in the same way through the same place at no +further charge. You need not require recipients to copy the +Corresponding Source along with the object code. If the place to +copy the object code is a network server, the Corresponding Source +may be on a different server (operated by you or a third party) +that supports equivalent copying facilities, provided you maintain +clear directions next to the object code saying where to find the +Corresponding Source. Regardless of what server hosts the +Corresponding Source, you remain obligated to ensure that it is +available for as long as needed to satisfy these requirements. + +e) Convey the object code using peer-to-peer transmission, provided +you inform other peers where the object code and Corresponding +Source of the work are being offered to the general public at no +charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A ``User Product'' is either (1) a ``consumer product'', which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, ``normally used'' refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + ``Installation Information'' for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +@enumerate +@item +Additional Terms. +@end enumerate + + ``Additional permissions'' are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + +a) Disclaiming warranty or limiting liability differently from the +terms of sections 15 and 16 of this License; or + +b) Requiring preservation of specified reasonable legal notices or +author attributions in that material or in the Appropriate Legal +Notices displayed by works containing it; or + +c) Prohibiting misrepresentation of the origin of that material, or +requiring that modified versions of such material be marked in +reasonable ways as different from the original version; or + +d) Limiting the use for publicity purposes of names of licensors or +authors of the material; or + +e) Declining to grant rights under trademark law for use of some +trade names, trademarks, or service marks; or + +f) Requiring indemnification of licensors and authors of that +material by anyone who conveys the material (or modified versions of +it) with contractual assumptions of liability to the recipient, for +any liability that these contractual assumptions directly impose on +those licensors and authors. + + All other non-permissive additional terms are considered ``further +restrictions'' within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + +@enumerate +@item +Termination. +@end enumerate + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +@enumerate +@item +Acceptance Not Required for Having Copies. +@end enumerate + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +@enumerate +@item +Automatic Licensing of Downstream Recipients. +@end enumerate + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An ``entity transaction'' is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +@enumerate +@item +Patents. +@end enumerate + + A ``contributor'' is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's ``contributor version''. + + A contributor's ``essential patent claims'' are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, ``control'' includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a ``patent license'' is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To ``grant'' such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. ``Knowingly relying'' means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is ``discriminatory'' if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +@enumerate +@item +No Surrender of Others' Freedom. +@end enumerate + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + +@enumerate +@item +Use with the GNU Affero General Public License. +@end enumerate + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +@enumerate +@item +Revised Versions of this License. +@end enumerate + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License ``or any later version'' applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +@enumerate +@item +Disclaimer of Warranty. +@end enumerate + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW@. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE@. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU@. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION@. + +@enumerate +@item +Limitation of Liability. +@end enumerate + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES@. + +@enumerate +@item +Interpretation of Sections 15 and 16. +@end enumerate + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the ``copyright'' line and a pointer to where the full notice is found. + + +Copyright (C) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see @uref{https://www.gnu.org/licenses/}. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) +This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. +This is free software, and you are welcome to redistribute it +under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an ``about box''. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a ``copyright disclaimer'' for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +@uref{https://www.gnu.org/licenses/}. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +@uref{https://www.gnu.org/licenses/why-not-lgpl.html}. +@end copying + +@dircategory Emacs +@direntry +* Scratch Packages: (scratch-pkgs). Create, distribute, and maintain Emacs Lisp packages. +@end direntry + +@finalout +@titlepage +@title Scratch Packages +@subtitle for version 0.1.0 +@author Psionic K +@page +@vskip 0pt plus 1filll +@insertcopying +@end titlepage + +@contents + +@ifnottex +@node Top +@top Scratch Packages +@end ifnottex + +@menu +* Welcome:: +* Use with Elisp Repo Kit:: +* About this Manual:: +@end menu + +@node Welcome +@chapter Welcome + +This is a simple org document used to generate an info manual and content for +the README@. + +@node Use with Elisp Repo Kit +@chapter Use with Elisp Repo Kit + +The repository hosting this package was created with @uref{https://github.com/positron-solutions/elisp-repo-kit, elisp-repo-kit}. You can +clone and rename it using @code{erk-new} to quickly get a package set up. + +@node About this Manual +@chapter About this Manual + +To see more examples of writing an org document that exports to texinfo or +markdown, see the longer examples in Elisp Repo Kit, which is available in its +info manual as well. + +@bye \ No newline at end of file diff --git a/lisp/scratch-pkgs.el b/lisp/scratch-pkgs.el new file mode 100644 index 0000000..a5cf53b --- /dev/null +++ b/lisp/scratch-pkgs.el @@ -0,0 +1,141 @@ +;;; scratch-pkgs.el --- Scratch Packages -*- lexical-binding: t; -*- + +;; Copyright (C) 2023 Positron Solutions +;; Author: Psionic K +;; Keywords: convenience +;; Version: 0.1.0 +;; Package-Requires: ((emacs "28.1")) +;; Homepage: http://github.com/positron-solutions/scratch-pkgs + +;;; License: + +;; This program is free software; you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. + +;; This program is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with this program. If not, see . + +;;; Commentary: + +;; Write small packages. They are easier to debug, reload, and maintain than +;; use-package expressions. You will have better control over dependencies, and +;; your dependencies will be properly declared. +;; +;; Add your scratch-pkgs to your Git repos so people can see what kinds of +;; nearly-packaged code you came up with. + +;;; Code: + +(defgroup scratch-pkgs nil "Scratch Packages." :prefix 'scratch-pkgs :group 'convenience) + +;; TODO smarter package header maintenance, depend on ERK +(defcustom scratch-pkgs-template "\ +;;; %1$s.el --- %2$s -*- lexical-binding: t; -*- +;; +;;; Commentary: +;; good luck! +;;; Code: + +(message \"Only the future is certain.\") + +(provide '%1$s) +;;; %1$s.el ends here.\n" + "Template for file backed scratch." + :group 'scratch-pkgs + :type 'string) + +(declare-function no-littering-expand-var-file-name "no-littering") +(defcustom scratch-pkgs-dir + (file-name-directory (if (featurep 'no-littering) + (no-littering-expand-var-file-name "scratch") + (expand-file-name "var/scratch" user-emacs-directory))) + "Where scratches are saved." + :group 'scratch-pkgs + :type 'directory) + +(defun scratch-pkgs--configure-load-path (symbol value) + "Add scratch packages to the `load-path'. +SYMBOL and VALUE is from the setter in +`scratch-pkgs-add-to-load-path'." + (set-default-toplevel-value symbol value) + (unless (file-directory-p scratch-pkgs-dir) + (make-directory scratch-pkgs-dir)) + (when scratch-pkgs-dir (push scratch-pkgs-dir load-path))) + +(defcustom scratch-pkgs-add-to-load-path t + "When non-nil, adds your temporary packages to the load path." + :set #'scratch-pkgs--configure-load-path + :group 'scratch-pkgs + :type 'boolean) + +(defun scratch-pkgs-default-init (buffer) + "Create a package skeleton in BUFFER." + (switch-to-buffer buffer) + (let* ((feature-name (file-name-base (buffer-file-name buffer))) + (feature-title (string-join (mapcar + #'capitalize + (string-split feature-name "-")) + " "))) + (insert (format scratch-pkgs-template + feature-name + feature-title)))) + +(defcustom scratch-pkgs-init #'scratch-pkgs-default-init + "Function to run on each new scratch buffer." + :group 'scratch-pkgs + :type 'function) + +(defun scratch-pkgs--only-elisp-files (dir) + "Return just normal elisp files in DIR." + (let ((match-elisp (rx line-start + (+ not-newline) + (literal ".el") + line-end)) + (match-flycheck (rx line-start + (literal "flycheck_") + (+ not-newline) + (literal ".el")))) + (save-match-data + (seq-filter + (lambda (f) (not (string-match-p match-flycheck f))) + (directory-files dir nil match-elisp))))) + +(defun scratch-pkgs--read () + "Read a file in the scratch dir if there are files." + (when (file-directory-p scratch-pkgs-dir) + (let* ((files (scratch-pkgs--only-elisp-files scratch-pkgs-dir))) + (completing-read "Choose existing scratch package: " files nil t)))) + +(defun scratch-pkgs (&optional file-name) + "Open an old scratch FILE-NAME." + (interactive (list (scratch-pkgs--read))) + (if file-name + (let* ((file-path (expand-file-name file-name scratch-pkgs-dir)) + (buffer (find-file-noselect file-path))) + (switch-to-buffer buffer)) + (scratch-pkgs-new "scratch"))) + +(defun scratch-pkgs-new (name) + "Create new scratch package for feature NAME." + (interactive "sFeature symbol: ") + (let* ((file-name (format "%s.el" name)) + (file-path (expand-file-name file-name scratch-pkgs-dir)) + (buffer (find-file-noselect file-path))) + (funcall scratch-pkgs-init buffer) + (switch-to-buffer buffer) + (emacs-lisp-mode))) + +(provide 'scratch-pkgs) +;;; scratch-pkgs.el ends here. +;; TODO make these local words generic across spelling pkgs +;; Local Variables: +;; ispell-buffer-session-localwords: ("pkgs") +;; jinx-local-words: "pkgs" +;; End: diff --git a/test/scratch-pkgs-test.el b/test/scratch-pkgs-test.el new file mode 100644 index 0000000..d7e6be1 --- /dev/null +++ b/test/scratch-pkgs-test.el @@ -0,0 +1,45 @@ +;;; scratch-pkgs-test.el --- test your freaking package! -*- lexical-binding: t; -*- + +;; Copyright (C) 2022 Psionic K + +;; Author: Psionic K + +;; Permission is hereby granted, free of charge, to any person obtaining a copy of +;; this software and associated documentation files (the "Software"), to deal in +;; the Software without restriction, including without limitation the rights to +;; use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +;; the Software, and to permit persons to whom the Software is furnished to do so, +;; subject to the following conditions: + +;; The above copyright notice and this permission notice shall be included in all +;; copies or substantial portions of the Software. + +;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +;; IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +;; FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +;; COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +;; IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +;; CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +;;; Commentary: + +;; Run the batch tests from root directory: +;; nix shell .github#emacsGit --quick --script .github/run-shim.el -- test +;; Test dependencies can be provided to the Emacsen declared inside the root +;; flake.nix. + +;; For local development, dependencies should be installed by the user. Tests +;; can be run from one of the project files using the `erk-ert-project' +;; command. + +;;; Code: + +(require 'ert) +(require 'scratch-pkgs) + +;; (ert-deftest scratch-pkgs-hello-test () +;; (should (string-match-p (scratch-pkgs-hello) +;; "hello"))) + +(provide 'scratch-pkgs-test) +;;; scratch-pkgs-test.el ends here.