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.bugs Subject: bug#50825: 28.0.50; improve documentation for `define-package' Date: Sun, 26 Sep 2021 19:36:21 +0200 Message-ID: <87r1db44tm.fsf@gmail.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="25979"; mail-complaints-to="usenet@ciao.gmane.io" To: 50825@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Sep 26 19:37:28 2021 Return-path: Envelope-to: geb-bug-gnu-emacs@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 1mUY5f-0006XQ-Hl for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 26 Sep 2021 19:37:27 +0200 Original-Received: from localhost ([::1]:43394 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mUY5c-0002lT-4H for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 26 Sep 2021 13:37:24 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:50374) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mUY5H-0002lL-2G for bug-gnu-emacs@gnu.org; Sun, 26 Sep 2021 13:37:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:55356) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mUY5G-0007KJ-RX for bug-gnu-emacs@gnu.org; Sun, 26 Sep 2021 13:37:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mUY5G-0008VG-DI for bug-gnu-emacs@gnu.org; Sun, 26 Sep 2021 13:37:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Michelangelo Rodriguez Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 26 Sep 2021 17:37:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 50825 X-GNU-PR-Package: emacs X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.163267779032550 (code B ref -1); Sun, 26 Sep 2021 17:37:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 26 Sep 2021 17:36:30 +0000 Original-Received: from localhost ([127.0.0.1]:38669 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mUY4j-0008Sw-PK for submit@debbugs.gnu.org; Sun, 26 Sep 2021 13:36:30 -0400 Original-Received: from lists.gnu.org ([209.51.188.17]:46766) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mUY4i-0008Sn-0c for submit@debbugs.gnu.org; Sun, 26 Sep 2021 13:36:28 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:50342) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mUY4h-0002dC-Pv for bug-gnu-emacs@gnu.org; Sun, 26 Sep 2021 13:36:27 -0400 Original-Received: from mail-ed1-x52e.google.com ([2a00:1450:4864:20::52e]:33309) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mUY4f-0006qu-Pb for bug-gnu-emacs@gnu.org; Sun, 26 Sep 2021 13:36:27 -0400 Original-Received: by mail-ed1-x52e.google.com with SMTP id b26so10622909edt.0 for ; Sun, 26 Sep 2021 10:36:25 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:subject:date:message-id:mime-version :content-transfer-encoding; bh=dDB9COgApTGOwcBEqU+L5coIPKDLFbwdbs4VQBSoXiI=; b=WUuJozsdLOWcOPOp0vd9oExsfCm8qsHS1RcHv9JJT8mWi/9ly01HyN/Ifmi+j2WVXi P7D+aR/yUvNBgjjsAKhvwWtHzIrFHhYzvG3zjKz4b6whYRDWZ/8qhE+Sz9w1r3rzNw4Z ivhWApzLGXs+nwowdS/rHeh5wLCulLf7tyici2qccxcYuWXjTawgetvBrtZxPBw2rWx7 qCIZCvFjMU/AzNx6+m+uN8duWStJAabi9+TFPvpXRnR2K2QvQWUhnrr2wEUtjZRMKLr+ F8GDbTqpeKTUtJHUHtj7LTvYDerYJxbnK8N0IWDsjNwKx5Svh4kGRdm8JIdKcvZvGIAv FWEg== 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:date:message-id:mime-version :content-transfer-encoding; bh=dDB9COgApTGOwcBEqU+L5coIPKDLFbwdbs4VQBSoXiI=; b=wbmtUnOlZo7ZnmwroHfykk2BQzi05GXUyFkewJAvZXmhalOvLtCpzPQm359Nbz0eTh OrDWso0KeYq06gXwptpqBUXOzrdfLdFTINQA8wEDYYvnFshIMdmjwI6fNtma42w/a/gL HLC/1BbskUT1bpn/cCtnI32bTAAJHlPVAmp2PgvPvBEChQSF/kMBtoTRzk5P0K5CqTRR 86pmpSM3Icohd6uarLVNn8iwxxK0CecCkUbSeEnkFEDU+xeqtAg3xstCEia6qdCVdE3V hwG8cii9eyeg1q/mIDcB85Aw1ReM7DOW9ZgCjvjfpJy+Fku9iyFQT0+8ene9EI28s8fb IzSg== X-Gm-Message-State: AOAM5304qi0nV767F75d60W7oYby6lCYPLd0AaGLRi4KSZlkD7mSq7n8 QFah/S02cgayGf3MDwvkSIz49XY1vJA= X-Google-Smtp-Source: ABdhPJzZtXYCrVPswa5r93wumNdtNSRz/XZ+bPn6eGcum/D18FcfW34ts8tvSeMpYOy7f28lfTqbTA== X-Received: by 2002:a05:6402:3487:: with SMTP id v7mr118523edc.191.1632677783133; Sun, 26 Sep 2021 10:36:23 -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 qw28sm184227ejb.56.2021.09.26.10.36.22 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 26 Sep 2021 10:36:22 -0700 (PDT) Received-SPF: pass client-ip=2a00:1450:4864:20::52e; envelope-from=michelangelo.rodriguez@gmail.com; helo=mail-ed1-x52e.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: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:215610 Archived-At: In the elisp manual, and precisely in "(elisp) multi-file packages" we read: " Prior to installation, a multi-file package is stored in a package archive as a tar file. The tar file must be named =E2=80=98NAME-VERSION.ta= r=E2=80=99, where NAME is the package name and VERSION is the version number. Its contents, once extracted, must all appear in a directory named =E2=80=98NAME-VERSION=E2=80=99, the =E2=80=9Ccontent directory=E2=80=9D (*n= ote Packaging Basics::). Files may also extract into subdirectories of the content directory. One of the files in the content directory must be named =E2=80=98NAME-pkg.el=E2=80=99.". It should be clarified that, actually, the -pkg.el is generated by the archive, and is not "responsibility" of the programmer that is actually writing the code. The responsibility of a programmer is just to write library headers correctly. Infact, if as a coder i write manually package-pkg.el using just the parameters specified for the `define-package' function, and afterwards i generate `package.tar", and install it using `package-install-file' when i use `describe-package' to see it's documentation, the headers i had specified in the package are not reported. In GNU Emacs 28.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.24, c= airo version 1.16.0) of 2021-09-25 built on mugno Repository revision: 2767c89db729a6106146d0aeff76678c64d4fc53 Repository branch: master System Description: Debian GNU/Linux 11 (bullseye) Configured using: 'configure --with-native-compilation' Configured features: ACL CAIRO DBUS FREETYPE GIF GLIB GMP GNUTLS GPM GSETTINGS HARFBUZZ JPEG JSON LIBOTF LIBSELINUX LIBSYSTEMD LIBXML2 M17N_FLT MODULES NATIVE_COMP NOTIFY INOTIFY PDUMPER PNG RSVG SECCOMP SOUND THREADS TIFF TOOLKIT_SCROLL_BARS X11 XDBE XIM XPM GTK3 ZLIB Important settings: value of $LANG: it_IT.UTF-8 locale-coding-system: utf-8-unix Major mode: Info Minor modes in effect: semantic-minor-modes-format: ((:eval (if (or semantic-highlight-edits-mod= e semantic-show-unmatched-syntax-mode) S))) shell-dirtrack-mode: t greader-mode: t gpm-mouse-mode: t global-voice-lock-mode: t voice-lock-mode: t global-company-mode: t company-mode: t midnight-mode: t tooltip-mode: t electric-indent-mode: t mouse-wheel-mode: t tool-bar-mode: t menu-bar-mode: t file-name-shadow-mode: t global-font-lock-mode: t font-lock-mode: t blink-cursor-mode: t auto-composition-mode: linux auto-encryption-mode: t auto-compression-mode: t buffer-read-only: t indent-tabs-mode: t Load-path shadows: /home/michelangelo/.emacs.d/elpa/transient-20210919.1006/transient hides /u= sr/local/share/emacs/28.0.50/lisp/transient /home/michelangelo/emacspeak/lisp/tetris hides /usr/local/share/emacs/28.0.= 50/lisp/play/tetris Features: (shadow emacsbug emacspeak-wizards url-cache format-spec emacspeak-outline noutline outline emacspeak-eww emacspeak-google gweb emacspeak-we emacspeak-xslt dom-addons eww xdg url-queue mm-url emacspeak-eterm two-column term ehelp ucs-normalize url-http url-auth url-gw emacspeak-twittering twittering-mode apropos finder-inf package-x mule-util greader-speechd ereader xml+ emacspeak-view view s picture dash emacspeak-bookmark bookmark mm-archive gnutls network-stream nsm mailalias smtpmail sendmail bbdb-com crm emacspeak-bbdb bbdb bbdb-site timezone emacspeak-custom cus-edit sort gnus-cite mail-extr gnus-async gnus-bcklg gnus-ml disp-table cursor-sensor qp nndraft nnmh nnfolder nnml gnus-agent gnus-srvr gnus-score score-mode nnvirtual gnus-msg nntp gnus-cache greader greader-espeak easy-mmode emacspeak-compile compile autoload lisp-mnt emacspeak-tar tar-mode emacspeak-arc arc-mode archive-mode emacspeak-comint shell pcomplete comint ansi-color dired-aux misearch multi-isearch help-fns radix-tree cl-print debug backtrace cus-start thingatpt emacspeak-xref emacspeak-widget emacspeak-tab-bar emacspeak-rmail emacspeak-project emacspeak-package emacspeak-calendar appt diary-lib diary-loaddefs g-utils solar cal-dst cal-menu calendar cal-loaddefs emacspeak-message emacspeak-kmacro emacspeak-info emacspeak-gnus gm-nnir nnir gnus-art mm-uu mml2015 mm-view mml-smime smime dig gnus-sum shr kinsoku svg dom gnus-group gnus-undo gnus-start gnus-dbus dbus emacspeak-advice emacspeak-cedet xml gnus-cloud nnimap nnmail mail-source utf7 netrc nnoo parse-time iso8601 gnus-spec gnus-int gnus-range message rmc puny emacspeak-dired locate dired dired-loaddefs rfc822 mml mml-sec emacspeak-epa epa derived epg rfc6068 epg-config mm-decode mm-bodies mm-encode mail-parse rfc2231 mailabbrev gmm-utils mailheader gnus-win emacspeak-hide emacspeak-company emacspeak-buff-menu t-mouse term/linux jka-compr emacspeak-setup emacspeak emacspeak-preamble emacspeak-sounds emacspeak-speak sox-gen emacspeak-keymap emacspeak-pronounce voice-defs voice-setup espeak-voices dtk-speak advice comp comp-cstr warnings rx cl-extra help-mode company-oddmuse company-keywords company-etags etags fileloop generator xref project ring company-gtags company-dabbrev-code company-dabbrev company-files company-clang company-capf company-cmake company-semantic company-template company-bbdb company pcase server semantic/util-modes semantic/util semantic pp semantic/tag semantic/lex semantic/fw mode-local find-func cedet midnight gnus nnheader gnus-util rmail rmail-loaddefs rfc2047 rfc2045 ietf-drums text-property-search time-date mail-utils mm-util mail-prsvr wid-edit cus-load debian-el edmacro kmacro info package browse-url url url-proxy url-privacy url-expand url-methods url-history url-cookie url-domsuf url-util mailcap url-handlers url-parse auth-source cl-seq eieio eieio-core cl-macs eieio-loaddefs password-cache json subr-x map url-vars seq byte-opt gv bytecomp byte-compile cconv cl-loaddefs cl-lib iso-transl tooltip eldoc electric uniquify ediff-hook vc-hooks lisp-float-type elisp-mode mwheel term/x-win x-win term/common-win x-dnd tool-bar dnd fontset image regexp-opt fringe tabulated-list replace newcomment text-mode lisp-mode prog-mode register page tab-bar menu-bar rfn-eshadow isearch easymenu timer select scroll-bar mouse jit-lock font-lock syntax font-core term/tty-colors frame minibuffer cl-generic cham georgian utf-8-lang misc-lang vietnamese tibetan thai tai-viet lao korean japanese eucjp-ms cp51932 hebrew greek romanian slovak czech european ethiopic indian cyrillic chinese composite emoji-zwj charscript charprop case-table epa-hook jka-cmpr-hook help simple abbrev obarray cl-preloaded nadvice button loaddefs faces cus-face macroexp files window text-properties overlay sha1 md5 base64 format env code-pages mule custom widget hashtable-print-readable backquote threads dbusbind inotify dynamic-setting system-font-setting font-render-setting cairo move-toolbar gtk x-toolkit x multi-tty make-network-process native-compile emacs) Memory information: ((conses 16 2884205 280184) (symbols 48 48845 21) (strings 32 370227 19381) (string-bytes 1 13462965) (vectors 16 110573) (vector-slots 8 2388979 36361) (floats 8 667 509) (intervals 56 277979 15032) (buffers 992 38))