From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Michelangelo Rodriguez Newsgroups: gmane.emacs.devel Subject: Re: documentation incorrect for function `define-package'? Date: Sat, 25 Sep 2021 20:13:38 +0200 Message-ID: <87pmswr0a5.fsf@gmail.com> References: <87bl4iukia.fsf@gmail.com> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="1398"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sat Sep 25 20:14:48 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 1mUCCE-00008o-Id for ged-emacs-devel@m.gmane-mx.org; Sat, 25 Sep 2021 20:14:46 +0200 Original-Received: from localhost ([::1]:42260 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mUCCC-0004xs-HU for ged-emacs-devel@m.gmane-mx.org; Sat, 25 Sep 2021 14:14:44 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:42098) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mUCBE-0004HO-Dq for emacs-devel@gnu.org; Sat, 25 Sep 2021 14:13:44 -0400 Original-Received: from mail-wr1-x42b.google.com ([2a00:1450:4864:20::42b]:33700) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mUCBC-0007I2-ND for emacs-devel@gnu.org; Sat, 25 Sep 2021 14:13:44 -0400 Original-Received: by mail-wr1-x42b.google.com with SMTP id t18so37668405wrb.0 for ; Sat, 25 Sep 2021 11:13:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:subject:references:date:in-reply-to:message-id:user-agent :mime-version; bh=M0ut5kJro6al344XOsQ9Sxh86arM5b0S9jGWhJUkeO4=; b=IiNxWVwby8BNopT+vJBrUHD4iXXfxWZjNk9AOdeCCM2CXFeSPKHnHVUUO1WwjzFcLv gq8Z/rg8fK4javw/xVv5Lc/ztp86kbtHNx00pH7O1dw5pxsaCp02qSQIuPMlnNIih+sa i5bPo6FmhvS97FbW9ArAxGeKkf4QKK3PCNLuUD0jTdAeCdPG6yDh/0tNjv76+VM3B39q /bsvyykxRLrWlkXUlOImMKtruvQ/fwxk9WeU3EuKwD8KEwBZl9rsaJpTD5j6irpuFrbF A7yvNj09atqlI0UGBtrAF1iyOJU5xzvsidFtq0WwywPvtH7eK2TeJ+WfVvoGYT6wzb6t OOKw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:subject:references:date:in-reply-to :message-id:user-agent:mime-version; bh=M0ut5kJro6al344XOsQ9Sxh86arM5b0S9jGWhJUkeO4=; b=bTgC4GIYGqmaYJEtC4qlnfqRtnN4xX2FGwrCGdyGAVPylPHX7aIYvYzbrmOBAH9ZTQ ZOWAaSVszxrBikKjdRPwm6ZaerB0C7+BZ2rfSWG0fAgewoKw2l9yC5b1FHiiIQFbUo4M nLt7OKqH45bFokmV6FSifWBSG34lHFxV/KRqw3NB1iSQwG0F85HxO1pgHEtjfQebjB2F ugXRJnCcgfRnAz5qgJR1qa7TIZ+CDk1RQOMP20VyIO/c4ahzyamz6vYWiQgrkzDxRefP rIe4c/XxdtYOySkyHpYPYTGRHrbdUzDCk8jutCFo/dQLbJfy3W1uUdpqN5JHN+3cgRQB pR2Q== X-Gm-Message-State: AOAM5325TM5NgM+5XDbFlgWDm4VDcMoSQKDEG+bshS1+K7YeAGLZhw9a L72jXDx/3Yl1OVXTJNYInC7IP9CcfzY= X-Google-Smtp-Source: ABdhPJy2fuEZ2k5Kd9sniF1CDVkZyfTfxDMVi6A7c/+0g1gJSB+0aFcGuMuu38HaPDAxOl/1T5wnHA== X-Received: by 2002:a1c:3b09:: with SMTP id i9mr7772358wma.175.1632593620290; Sat, 25 Sep 2021 11:13:40 -0700 (PDT) Original-Received: from mugno (net-2-42-133-113.cust.vodafonedsl.it. [2.42.133.113]) by smtp.gmail.com with ESMTPSA id k19sm11656015wmr.21.2021.09.25.11.13.39 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 25 Sep 2021 11:13:39 -0700 (PDT) In-Reply-To: (Stefan Kangas's message of "Fri, 24 Sep 2021 08:01:14 -0700") Received-SPF: pass client-ip=2a00:1450:4864:20::42b; envelope-from=michelangelo.rodriguez@gmail.com; helo=mail-wr1-x42b.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 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_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-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:275473 Archived-At: Stefan Kangas writes: > This is its current definition: > > (defun define-package ( _name-string _version-string > &optional _docstring _requirements > &rest _extra-properties) > "Define a new package. > NAME-STRING is the name of the package, as a string. > VERSION-STRING is the version of the package, as a string. > DOCSTRING is a short description of the package, a string. > REQUIREMENTS is a list of dependencies on other packages. > Each requirement is of the form (OTHER-PACKAGE OTHER-VERSION), > where OTHER-VERSION is a string. > > EXTRA-PROPERTIES is currently unused." > ;; FIXME: Placeholder! Should we keep it? > (error "Don't call me!")) > > On the one hand, this function is clearly not intended for use. > > On the other hand, where else do we document the `define-package' list > that goes in "foo-pkg.el"? > > Those definitions look like this, but again this is just data (the > "package.el" Commentary section incorrectly says "'PACKAGE-pkg.el' which > consists of a *call* to define-package", my emphasis): > > (define-package "which-key" "20210824.11" "Display available > keybindings in popup" '((emacs "24.4")) :commit > "4790a14683a2f3e4f72ade197c78e4c0af1cdd4b" :authors '(("Justin > Burkett" . "justin@burkett.cc")) :maintainer '("Justin Burkett" . > "justin@burkett.cc") :url > "https://github.com/justbur/emacs-which-key") So, in my actual understanding of how the package system works, actually -pkg.el is generated by an authomation when that package is installed from elpa or another archive? I think that because i try to install a local package in which i'm working and if i try to install it by using `package-install-file' and i don't specify various keywords to `define-package' then `describe-package' does'nt report correctly some information. so, which is the "correct way " to test the package?