[bug#41327] [PATCH] gnu: Add emacs-vcsh.

[Nicolas Goaziou]

Hello,

Michael Rohleder <address@hidden> writes:

> From f18c71cbad9860ae15907c5a74367b8ac55cb122 Mon Sep 17 00:00:00 2001
> From: Michael Rohleder <address@hidden>
> Date: Sat, 16 May 2020 18:01:49 +0200
> Subject: [PATCH] gnu: Add emacs-vcsh.

Thank you for the patch. Some comments follow.

> +(define-public emacs-vcsh
> +  (package
> +    (name "emacs-vcsh")
> +    (version "0.4.4")
> +    (source
> +     (origin
> +       (method git-fetch)
> +       (uri (git-reference
> +             (url "https://gitlab.com/stepnem/vcsh-el.git";)
> +             (commit version)))
> +       (file-name (git-file-name name version))
> +       (sha256
> +        (base32
> +         "183pffdiqb7qqmjq31wxl3fpv8qswqgg99gb716rddiyk15ysri7"))))

Nitpick: could you move the string on the line above?

> +    (build-system emacs-build-system)
> +    (home-page "https://gitlab.com/stepnem/vcsh-el";)
> +    (synopsis "Emacs vcsh integration")
> +    (description
> +     "This library only provides basic \"enter\" functionality
> +(`vcsh-link', `vcsh-unlink') and a few convenience commands
> +(`vcsh-new' to init a repo and add files to it,
> +`vcsh-write-gitignore').

Without writing too many details, I suggest

  This library provides basic ``enter'' functionality and a few
  convenience commands to init a repository and add files to it.

However, it may be useful to write somewhere what is "vcsh". As a user,
do I need/want that?

> +Please note that this library works by creating a regular file
> +named \".git\" inside $VCSH_BASE directory (typically $HOME) and does
> +not remove this file automatically, so don't be surprised if your
> +shell suddenly behaves as after \"vcsh enter\" when inside that
> +directory.  You can use `vcsh-unlink' or simply remove the file to
> +get rid of it."

I don't think this part is really useful as a description, i.e., it does
belong to a manual instead. As a side note, descriptions use Texinfo
syntax, so `vcsh-unlink' is written @code{vcsh-unlink}, etc.


Could you send an updated patch?

Regards,

-- 
Nicolas Goaziou