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: Not using DOC for ELisp files Date: Wed, 29 Dec 2021 14:52:41 +0200 Message-ID: <838rw3lgiu.fsf@gnu.org> References: <834k6snbko.fsf@gnu.org> <83fsqclhlh.fsf@gnu.org> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="40791"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org, akrl@sdf.org To: Stefan Monnier Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Wed Dec 29 13:53:51 2021 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 1n2YSk-000AQT-Ty for ged-emacs-devel@m.gmane-mx.org; Wed, 29 Dec 2021 13:53:51 +0100 Original-Received: from localhost ([::1]:39762 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1n2YSj-0001q6-3o for ged-emacs-devel@m.gmane-mx.org; Wed, 29 Dec 2021 07:53:49 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:43932) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n2YRb-00019c-Mt for emacs-devel@gnu.org; Wed, 29 Dec 2021 07:52:39 -0500 Original-Received: from [2001:470:142:3::e] (port=37254 helo=fencepost.gnu.org) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n2YRb-0007Oe-4u; Wed, 29 Dec 2021 07:52:39 -0500 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=sT5OvpzS90yxhay2W+0nNV4TkD3YGE+vvewviD8xtJE=; b=QAybXP5y80Na rHBhNyfnvYngbpW8oXUsr4G6VaUsJdMdazPstylZNMtMCCxJApfKr5IwsHRRk5OfmkbQWpeOJnZ2Z A73EZjavqTcKSShW7Ls7+Kyv/w8s+qdmTV4mr2kdM9VvGoTPcl/W+vee2xIgoj81BN1mqEcWle+0a CGiRi2ZJi98ZP8O8wjuCFW0NS692Kh9dczPeBVwlASu/kSjfBY/QNqh1h6AgmHk16T+fG1FPcbHHm mhWDl+etXYzZwgV6uC46EYUiefp56KiVBtK9CE/LN0/kczt3ElYsTTHM5ezjs3VuOfd7Xr61m80YY 9e2L5LeU3FaMn+FcBRnOfA==; Original-Received: from [87.69.77.57] (port=2280 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 1n2YRb-0000mf-2f; Wed, 29 Dec 2021 07:52:39 -0500 In-Reply-To: (message from Stefan Monnier on Tue, 28 Dec 2021 19:15:11 -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" Xref: news.gmane.io gmane.emacs.devel:283552 Archived-At: > From: Stefan Monnier > Cc: Andrea Corallo , emacs-devel@gnu.org > Date: Tue, 28 Dec 2021 19:15:11 -0500 > > Seeing how I haven't heard any opposition to the idea, I fixed a few > loose ends, and I think it's now ready. See below. > Any objection? This seems to do much more than just what you said, even if I include the obvious cleanups, like unnecessary variables and support code no longer required. Are all the changes really necessary/derived, or did you take the chance to make some additional changes, which should perhaps be discussed separately? > When Emacs starts up, it sets up the value of @code{load-path} > -in several steps. First, it initializes @code{load-path} using > -default locations set when Emacs was compiled. Normally, this > -is a directory something like > +in several steps. First, it initializes @code{lisp-directory} using > +default locations set when Emacs was compiled. You used for lisp-directory the same words as we used for load-path, but is that the correct description? Looking at the code that computes the value of lisp-directory, I don't think so, I think you can say something much more accurate and explicit about lisp-directory. Moreover, the text about load-path is now completely gone, and that is a net loss, I think. > +@defvar lisp-directory > +Name of the directory holding Emacs's bundled Lisp files. This is not accurate enough, given that it could mean both the place where Emacs was built (the "bundled" part can be interpreted that way), the place where *.el and *.elc files are installed when the built Emacs is being installed, and the place where the *.eln files are installed. > +Normally, this is a directory something like > @example > "/usr/local/share/emacs/@var{version}/lisp" > @end example This should tell what does @var{version} stand for. > ++++ > +** New variable 'lisp-directory' holds the directory of Emacs's own Lisp files. This suffers from the same accuracy problems. > +(defvar lisp-directory nil > + "Directory containing the Lisp files that come with GNU Emacs.") Likewise. Actually, "files that come with GNU Emacs" is even worse in its ambiguity than "bundled". And why isn't the main part of the change called out in NEWS? I think this is something we should announce. Thanks.