From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: How to install documentation in sub-directory with Package VC? Date: Tue, 28 Mar 2023 14:48:26 +0300 Message-ID: <83fs9p85bp.fsf@gnu.org> References: <87bkkvconh.fsf@posteo.net> <87o7oujqqp.fsf@posteo.net> <98f76116-4f5a-c225-3123-78c612ec64cb@protonmail.com> <875yb1gk55.fsf@posteo.net> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="39936"; mail-complaints-to="usenet@ciao.gmane.io" Cc: philipk@posteo.net, emacs-devel@gnu.org To: Okamsn Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Tue Mar 28 13:49:35 2023 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1ph7pW-000A5v-Um for ged-emacs-devel@m.gmane-mx.org; Tue, 28 Mar 2023 13:49:34 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ph7oP-0000TO-Gy; Tue, 28 Mar 2023 07:48:25 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ph7oL-0000T8-Vn for emacs-devel@gnu.org; Tue, 28 Mar 2023 07:48:22 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ph7oL-00065j-NB; Tue, 28 Mar 2023 07:48:21 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=Vb8UkeNjRIBh1sZs4hVQcZ2hai6iVp/byfAEhxooXac=; b=NO3f8n7rlugs QaTjxuN26V8cLXCim8J8HwXNN1wVtTz4f4KtieHaTSpgJNY2l1QxTL1OPwuWTamO0tkwF+nGT0WNe xkzZl35rpU+fVp+VHwxsgsF8vAQOi8TZZNryD1F26kydhuBIbZEd75blDYeqC2mNaGrAd1nqbKmFh UOMjyedKqEh663jf4wv28rJ1MFFagEX8lIHKy+mctuVtC8kBgqs4ccPhkxEVB9GVkR+Qsj+3XQVZP e6VWpYbC67FKQnA9dBrg6eXfZPXUAZNWX29htff29H+pRj8yu7oH+K/Mj5P81lgH/UjJ9cYW6UWyq 7IWO8+dgo3ECGSIAm0HYCA==; Original-Received: from [87.69.77.57] (helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ph7oK-0007VS-QT; Tue, 28 Mar 2023 07:48:21 -0400 In-Reply-To: (message from Okamsn on Tue, 28 Mar 2023 01:50:04 +0000) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:304797 Archived-At: > Date: Tue, 28 Mar 2023 01:50:04 +0000 > From: Okamsn > Cc: emacs-devel@gnu.org > > I have tried to write a patch doing this (attached). Thanks. > +There are two ways for Emacs to learn how and whence to install a > +package from source. The first way, when supported, is to > +automatically download the needed information from a package archive > +(@pxref{Package Archives,,,elisp, The Emacs Lisp Reference Manual}). > +This is what is done when only specifying the symbol of a package. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Passive voice alert! Could you perhaps rephrase this avoiding the passive voice? > +The second way is to specify this information manually in the first > +argument of @code{package-vc-install}, in the form of > +@samp{(@var{name} . @var{spec})}. @var{spec} should be a property This should be @code, not @samp. > +list using any of the following keys: > + > +@itemize @bullet This should be "@table @code", not @itemize. The result is more readable. @itemize is for free text, not for systematic description of several optional features and attributes. > +@item @code{:branch} > +The name of the branch to checkout after cloning the directory. ^^^^^^^^^^^^^^^^^^ ^^^^^^^^ ^^^^^^^ Can we make this less Git-specific? > +@item @code{:lisp-dir} > +The repository-relative name of the directory to use for loading the > +Lisp sources, if not the root directory of the repository. The "if not" part is confusing. I suggest ", which defaults to the root directory of the repository" instead. > +@item @code{:main-file} > +The main file of the project, from which to gather package metadata. > +If not given, the assumed default is the package name with ".el" > +appended to it. I'd drop the "assumed" part. It adds nothing to the description. > +@item @code{:doc} > +The repository-relative name of the documentation file from which to > +build an Info file. This can be a TexInfo file or an Org file. ^^ Two spaces there, please. Also, the spelling is "Texinfo", not "TexInfo". > +@item @code{:vc-backend} > +The VC backend to use for cloning the package. If omitted, A cross-reference here to the place where VC backends are described would be good. > +the process will fall back onto the archive default or onto > +the value of @code{package-vc-default-backend}. What does it mean to "fall back onto the archive default"? > + `:doc' (string) > + The documentation file from which to build an Info file. > + This can be a TexInfo file or an Org file. ^^^^^^^ Spelling again.