From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: Stefan Monnier Newsgroups: gmane.emacs.devel Subject: Re: "Emacs Lisp Packages" chapter in the Emacs manual Date: Mon, 11 May 2020 23:21:15 -0400 Message-ID: References: <11437E00-8970-4908-A900-0438A248428D@traduction-libre.org> <75254771-9303-4982-AB60-F92AF7AC6454@traduction-libre.org> <11AC1ECE-C120-4CBE-93C7-6FD82AF12299@traduction-libre.org> <18BA1545-091A-454E-B459-DEB96071D048@traduction-libre.org> <4f5da1c3-1311-44ca-80f7-942d9a0537b4@default> <0BBC80E8-7A74-4DB4-8C13-AF2AAFF04B4B@traduction-libre.org> <920E43F8-B65B-4802-97D3-F64BEBF5E8B8@traduction-libre.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="104857"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: Drew Adams , Emacs developers To: Jean-Christophe Helary Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Tue May 12 05:22:20 2020 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 1jYLUo-000RAW-LT for ged-emacs-devel@m.gmane-mx.org; Tue, 12 May 2020 05:22:18 +0200 Original-Received: from localhost ([::1]:54448 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jYLUn-0006LQ-NB for ged-emacs-devel@m.gmane-mx.org; Mon, 11 May 2020 23:22:17 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:56222) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jYLU2-00059p-6H for emacs-devel@gnu.org; Mon, 11 May 2020 23:21:30 -0400 Original-Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:27378) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jYLU0-0005Wj-W0 for emacs-devel@gnu.org; Mon, 11 May 2020 23:21:29 -0400 Original-Received: from pmg3.iro.umontreal.ca (localhost [127.0.0.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id CEF05450C19; Mon, 11 May 2020 23:21:24 -0400 (EDT) Original-Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id 1F29A450C17; Mon, 11 May 2020 23:21:23 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1589253683; bh=7Kwji8RdZgMyCklzcDP25e5wrMesUfP4Mw4/1E8vvyQ=; h=From:To:Cc:Subject:References:Date:In-Reply-To:From; b=C1jSz+aQkwBJVophLTCrBiJPLlufF1s1iyr2g8mGEN737mSRQ6ZmI40D88deySOID M27kMSOaG9LAgN8blObrI1/Vr2fn1BFqBkiLjVWsAQ7uPL952m+HrkYJYBmKyEQN1G xi+KWecvs1qGpEvB46srtX+pT7BvtI+iwXpfLi/UC98t0YYU+TMukBB9FV/VtDHbqF DOya9c7CxY5Yf6dMmc+cN4WcfS/bbzYTSOHME4uMxS+Ligb4EfdH61wszPn8AE8mua ibZ9HIJdeq8c9DwWZIdI/uXao85VuDpUBJ9iMwEZp64hmmfvFEk6ZTsFBRN5rHXTVg vTKcAlC6+hFwQ== Original-Received: from alfajor (unknown [216.154.3.202]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 6AC6A1202A5; Mon, 11 May 2020 23:21:22 -0400 (EDT) In-Reply-To: <920E43F8-B65B-4802-97D3-F64BEBF5E8B8@traduction-libre.org> (Jean-Christophe Helary's message of "Tue, 12 May 2020 09:59:23 +0900") Received-SPF: pass client-ip=132.204.25.50; envelope-from=monnier@iro.umontreal.ca; helo=mailscanner.iro.umontreal.ca X-detected-operating-system: by eggs.gnu.org: First seen = 2020/05/11 23:10:21 X-ACL-Warn: Detected OS = Linux 2.2.x-3.x [generic] X-Spam_score_int: -42 X-Spam_score: -4.3 X-Spam_bar: ---- X-Spam_report: (-4.3 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_MED=-2.3, SPF_PASS=-0.001, URIBL_BLOCKED=0.001 autolearn=_AUTOLEARN X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 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:249930 Archived-At: >> [ The first step is of course to make sure the file is found from >> `load-path`. ] > > Like ask the user to manually do M-x load-library and see the result ? Traditionally it was done either by telling the user to put this file somewhere in your `load-path` or to (add-to-list 'load-path "/where/ever/you/put/that/file/") > Well, actually all this started because I wanted to install Drew's > help-fns+.el and it happens that Drew uses "require". Then follow Drew's suggestion, since that's how he designed his library. > So, in case I want to add a similar feature set, would 'require be too much ? I know nothing about help-fns+ so I can't answer that. But nowadays libraries should be designed for the case where they're installed by a tool like package.el and in such a case, the user should almost never need to `require` the package. > Would (autoload 'help-fns+) be sufficient ? `autoload` takes 2 args, the first being a function name and the second the file in which that function is to be found. > Keep in mind that this addition is for users who know a minimal subset of > Emacs lisp (enough to play with their init file), not for authors. Those users should *never* need to do that: either they install via something like package.el or they follow steps in the package's installation instructions. Stefan