From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Suhail Singh Newsgroups: gmane.emacs.devel Subject: Re: [ELPA] New package c-intro-and-ref -- was Re: Proposal: Include C Manual from RMS in Emacs git, and/or release Date: Wed, 04 Dec 2024 18:52:36 -0500 Message-ID: <87o71rf1kr.fsf@gmail.com> References: <87ser8c230.fsf@jeremybryant.net> <86ser87rut.fsf@gnu.org> <86cyia4503.fsf@gnu.org> <87bjxsbc8h.fsf@jeremybryant.net> <87ikrz6wtl.fsf@gmail.com> <87wmgf9h70.fsf@jeremybryant.net> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="36368"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: Suhail Singh , Emacs-devel mailing list To: Jeremy Bryant Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Thu Dec 05 06:34:12 2024 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 1tJ4V9-0009GM-NO for ged-emacs-devel@m.gmane-mx.org; Thu, 05 Dec 2024 06:34:11 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tJ4UJ-0001q2-Cb; Thu, 05 Dec 2024 00:33:19 -0500 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 1tIzAh-0006Va-33 for emacs-devel@gnu.org; Wed, 04 Dec 2024 18:52:43 -0500 Original-Received: from mail-qt1-x842.google.com ([2607:f8b0:4864:20::842]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1tIzAf-0000eI-CB for emacs-devel@gnu.org; Wed, 04 Dec 2024 18:52:42 -0500 Original-Received: by mail-qt1-x842.google.com with SMTP id d75a77b69052e-4668e48963eso3210741cf.1 for ; Wed, 04 Dec 2024 15:52:40 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1733356359; x=1733961159; darn=gnu.org; h=mime-version:user-agent:message-id:date:references:in-reply-to :subject:cc:to:from:from:to:cc:subject:date:message-id:reply-to; bh=JIWCDXW7kUXRAzpgWEhyMsMjAMqbQ1LqIYBa4yar2Ps=; b=b7Gxdueqb7OTu4EJkvYduUbnDkLQ+2VGN7MfFm+O50BsVHucPFtdtMgbTGY64IW2mf 8WuKjevE+e2OkHRlki2bqQOiVvGrSKB25nxJQnNOtb0LfR/4iwVwS9vJM11Qad7zKRBO rDSs4RJn3YTuKodG1e1sIcokmRrdDDwWaHn8SmMNRmbhpR30G1rG4d7qq6INk8KkcVNG d1u7nGvyXm8AlVSZxyWy7BWiM7eYpt66NIhv14oR4qR0Xho5aYKhd5cdbZx/Ms+xkRv9 IcVMVzUWIW3QzRRQ2OLVovh/WvKPlqhXVk6rAsvVT8D0F8Yd/OZzIZePL0C/gZJxA+8t OU/w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1733356359; x=1733961159; h=mime-version:user-agent:message-id:date:references:in-reply-to :subject:cc:to:from:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=JIWCDXW7kUXRAzpgWEhyMsMjAMqbQ1LqIYBa4yar2Ps=; b=uKHeEyim1QqK1BLs4VDrZfHbBZyncMxgxBb4tBTGrHkJyOQrH9Qb5EGWvSSBlv0nH8 ODq2QEqhb5NKptl5luRR30nxgFxHhMMqhK4iPgUSgigi8obbYuIN5Ee7uLsLMJDYa/Bu NbnJh8J2LqeuNHVExfb+3N574m9yzhJU9LUa2IY0gjyhHZXSPJkovQ/XuQt5dHPrLB9e DawqjSoVqp91QtAnqD0Ff0qD2MD5Lqw5pqCQczBssT0EUA3Fy9UHq62mky/9kEs/He6P AhtwbIq21nKeD7wIkrJ2vmur0Bu96x2CykFOH7pxSLPvY59K0oVcApaNXvcrC/WBwnNX Tvvg== X-Forwarded-Encrypted: i=1; AJvYcCUC9HZDZZH2XVQKR743WjozF8oJyyOzKLo1hhxevpc+YJiZhkpOzOAxUTE3xJG8iw3B7xXZZ22qvdC6fA==@gnu.org X-Gm-Message-State: AOJu0YzjDAG/x1WeWq7X9BDJ1Sbc3Tge3HO0KRI9pRkUKmk20Rc6fX5D 19k6SvHNd0IOuLqFHw+OXnxgT45fIqHTSML5cpWxviDnAyeQ2O3FnoSbQfON X-Gm-Gg: ASbGncuAw6R+1diUp6JrKr9HtPxU6PJ2x71pdIsFURPNN/CXNGzhvbD16u91C1PKhVT gvq0HZCKGEeGWK8QthG3NDsvgJpoQdgm/q/jK8BfPKHFiJikKEoDqs8whn3yCnKseK318ydqEhA B/cnKYc2zNi6kCgKCRMJRLaZhrwGitwA3K8WVb2IJFS+nqUjSMRJMgul06RtAg5ziSqwyAGk/DM F/VuQhcK/Wq7eDugcwVcr7Fj/f0v9no1V4OQz21os+00Yqv3QglN7TAk0qX5Ti12bO4z+wgGNTF WMu1ADRdHYI= X-Google-Smtp-Source: AGHT+IEQIZOniAXpRXxJroI7ihK69b+T5k0mUsTW6jM/R7o21o3EGYJvJijhOx2+q7f0uC9WbSZxVQ== X-Received: by 2002:a05:622a:48:b0:461:1475:6135 with SMTP id d75a77b69052e-4670c072b87mr107637861cf.1.1733356358981; Wed, 04 Dec 2024 15:52:38 -0800 (PST) Original-Received: from gnus (mtrlpq0776w-70-26-179-129.dsl.bell.ca. [70.26.179.129]) by smtp.gmail.com with ESMTPSA id d75a77b69052e-4672978f241sm1496241cf.58.2024.12.04.15.52.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 04 Dec 2024 15:52:38 -0800 (PST) In-Reply-To: <87wmgf9h70.fsf@jeremybryant.net> (Jeremy Bryant's message of "Wed, 04 Dec 2024 23:11:47 +0000") Received-SPF: pass client-ip=2607:f8b0:4864:20::842; envelope-from=suhailsingh247@gmail.com; helo=mail-qt1-x842.google.com X-Spam_score_int: -17 X-Spam_score: -1.8 X-Spam_bar: - X-Spam_report: (-1.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_ENVFROM_END_DIGIT=0.25, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-Mailman-Approved-At: Thu, 05 Dec 2024 00:33:18 -0500 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:326063 Archived-At: Jeremy Bryant 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