Re: [ELPA] New package: nspawn-tramp

[Stefan Monnier <monnier@iro.umontreal.ca>]

> 	This is a package that allows TRAMP to use systemd-nspawn based
> 	containers (typically used with machinectl).
>
> 	I've been dogfooding this myself for about a year now, and I hope
> 	that others in the community will find it useful.
>
> 	The package source can be found at: https://github.com/bjc/nspawn-tramp
>
> 	If it gets accepted to ELPA, I'll adjust the README.org to include
> 	instructions for how to install it from there.

I'd be happy to add it to GNU ELPA, but I have a few questions/comments
some of which may affect this decision, so I haven't done it yet:

- It's usually spelled "Tramp" rather than "TRAMP", AFAIK.

- I suggest you clarify that this is not about Tramp using (internally)
  nspawnd to increase its security.  So instead of "allows TRAMP to work
  with containers", I'd say something like "teaches Tramp to access
  nspawnd containers"?

- `nspawnd-tramp` suggests this adds Tramp support to nspawnd rather than
  the reverse.

- Any reason why you want to have it as a separate package rather than
  add it to Tramp?

- `nspawn-tramp-machinectl-path` does not hold a "path" (like $PATH and
  `load-path`) but a "file name", please follow the GNU convention.


        Stefan


diff --git a/nspawn-tramp.el b/nspawn-tramp.el
index e5233406fe..9b1cb0c795 100644
--- a/nspawn-tramp.el
+++ b/nspawn-tramp.el
@@ -1,6 +1,6 @@
 ;;; nspawn-tramp.el -- TRAMP integration for systemd-nspawn containers  -*- lexical-binding: t; -*-
 
-;; Copyright © 2021 Free Software Foundation, Inc.
+;; Copyright © 2021-2022 Free Software Foundation, Inc.
 
 ;; Author: Brian Cully <bjc@kublai.com>
 ;; Maintainer: Brian Cully <bjc@kublai.com>
@@ -39,11 +39,11 @@
 ;;
 ;; Open a file on a running systemd-nspawn container:
 ;;
-;;     C-x C-f /nspawn:user@container:/path/to/file
+;;     C-x C-f /nspawn:USER@CONTAINER:/path/to/file
 ;;
 ;; Where:
-;;     ‘user’          is the user on the container to connect as (optional)
-;;     ‘container’     is the container to connect to
+;;     USER          is the user on the container to connect as (optional)
+;;     CONTAINER     is the container to connect to
 ;;
 ;; ## Privileges
 ;;
@@ -70,7 +70,7 @@
   :link '(emacs-commentary-link :tag "Commentary" "nspawn-tramp"))
 
 (defcustom nspawn-tramp-machinectl-path "machinectl"
-  "Path to machinectl executable."
+  "File name of machinectl executable."
   :type 'string
   :group 'nspawn-tramp)
 
@@ -93,7 +93,7 @@ see its function help for a description of the format."
 
 
 (defun nspawn-tramp--add-method ()
-  "Add TRAMP method handler for nspawn conainers."
+  "Add TRAMP method handler for nspawn containers."
   (push `(,nspawn-tramp-method
           (tramp-login-program ,nspawn-tramp-machinectl-path)
           (tramp-login-args (("shell")