Re: [ELPA] New package c-intro-and-ref -- was Re: Proposal: Include C Manual from RMS in Emacs git, and/or release

[Suhail Singh <suhailsingh247@gmail.com>]

Jeremy Bryant <jb@jeremybryant.net> writes:

>>> Main file: c-intro-and-ref.el
>>> This is simply a placeholder for the c.texi and other files
>>
>> Thank you for packaging this in a repository to make it easily
>> accessible via package-vc-install.
>>
>> It would help if the name of the texinfo file was the same as that of
>> the package.  Currently, when using package-vc-install, the name of the
>> checkout directory has to be specified as 'c (i.e., matching the name of
>> the texinfo file, as opposed to the repository), since that name is used
>> by package-vc when generating the info output from the texinfo source.
>
> The manual example ((emacs) Fetching Package Sources)
> seems to allow a :doc keyword?

This isn't about the :doc keyword.  It's a matter of consistency (or
inconsistency).  I shall leave it up to you and others to decide whether
the desire for consistency is foolish in this instance.

As things currently stand, one needs to do something like the below:

#+begin_src emacs-lisp
  (package-vc-install
   '(c :url "https://github.com/jeremy-bryant/c-intro-and-ref"
       :branch "master"
       :rev :newest
       :doc "./c.texi"))
#+end_src

Note, that while the name of the package is c-intro-and-ref, one needs
to provide the name "c" (i.e., that which matches the texinfo source) in
order for things to work.

The above clones the repository within ~/.emacs.d/elpa/c and compiles
the texinfo source to ~/.emacs.d/elpa/c/c.info.

If one is using use-package along with vc-use-package, the above
translates to:

#+begin_src emacs-lisp
  (use-package c-intro-and-ref :ensure nil
    :vc (c :url "https://github.com/jeremy-bryant/c-intro-and-ref"
           :branch "master"
           :rev :newest
           :doc "./c.texi"))
#+end_src

And in this form the inconsistency between the name being used by
use-package vs the name being used by package-vc-install becomes a
little more apparent.  Since the name given to package-vc-install
determines the name of the generated info file (as opposed to the name
of the texinfo source), this isn't optional.  The result is that the
phantom library "c-intro-and-ref" has to reside in ~/.emacs.d/elpa/c as
opposed to ~/.emacs.d/elpa/c-intro-and-ref.

If the file were instead named "c-intro-and-ref.texi", one could use
something like the below:

#+begin_src emacs-lisp
  (use-package c-intro-and-ref :ensure nil
    :vc (c-intro-and-ref :url "https://github.com/jeremy-bryant/c-intro-and-ref"
                         :branch "master"
                         :rev :newest
                         :doc "./c-intro-and-ref.texi"))
#+end_src

-- 
Suhail